diff options
Diffstat (limited to 'data/en_us/ons')
| -rw-r--r-- | data/en_us/ons/2015-10-20/api-docs.php | 348 | ||||
| -rw-r--r-- | data/en_us/ons/2016-04-05/api-docs.php | 269 | ||||
| -rw-r--r-- | data/en_us/ons/2018-06-28/api-docs.php | 283 | ||||
| -rw-r--r-- | data/en_us/ons/2019-02-14/api-docs.php | 6165 |
4 files changed, 7065 insertions, 0 deletions
diff --git a/data/en_us/ons/2015-10-20/api-docs.php b/data/en_us/ons/2015-10-20/api-docs.php new file mode 100644 index 0000000..a05dd0c --- /dev/null +++ b/data/en_us/ons/2015-10-20/api-docs.php @@ -0,0 +1,348 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Ons', + 'version' => '2015-10-20', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'OnsClusterList', + 'OnsClusterNames', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'OnsClusterList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'OnsRegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'OnsPlatform', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'onsFromPop', + ], + ], + [ + 'name' => 'PreventCache', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'Cluster', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HelpUrl' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ClusterInfoDataDo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterName' => [ + 'type' => 'string', + ], + 'BrokerInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BrokerInfoDataDo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BrokerAddr' => [ + 'type' => 'string', + ], + 'BrokerId' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'InTPS' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'BrokerIp' => [ + 'type' => 'string', + ], + 'OutTotalToday' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'InTotalToday' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'Version' => [ + 'type' => 'string', + ], + 'InTotalYest' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'OutTotalYest' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'ClusterName' => [ + 'type' => 'string', + ], + 'OutTPS' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'BrokerName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => null, + ], + 'OnsClusterNames' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'OnsRegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'OnsPlatform', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'onsFromPop', + ], + ], + [ + 'name' => 'PreventCache', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HelpUrl' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ClusterName' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => null, + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'ons.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'ons.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'ons.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'ons.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'ons.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'mq-internet-access', + 'endpoint' => 'ons.mq-internet-access.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'ons.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'ons.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'ons.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'ons.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'ons.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'ons.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'ons.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'ons.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'ons.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'ons.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'ons.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'ons.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'ons.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'ons.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'ons.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'ons.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'ons.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'ons.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'ons.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'ons.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'ons.me-central-1.aliyuncs.com', + ], + ], +]; diff --git a/data/en_us/ons/2016-04-05/api-docs.php b/data/en_us/ons/2016-04-05/api-docs.php new file mode 100644 index 0000000..cbe6716 --- /dev/null +++ b/data/en_us/ons/2016-04-05/api-docs.php @@ -0,0 +1,269 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Ons', + 'version' => '2016-04-05', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'OnsSubscriptionSearch', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'OnsSubscriptionSearch' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'OnsRegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'OnsPlatform', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'onsFromPop', + ], + ], + [ + 'name' => 'PreventCache', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'Search', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HelpUrl' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubscribeInfoDo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Owner' => [ + 'type' => 'string', + ], + 'UpdateTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CreateTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'StatusName' => [ + 'type' => 'string', + ], + 'OnsRegionId' => [ + 'type' => 'string', + ], + 'ChannelName' => [ + 'type' => 'string', + ], + 'RegionName' => [ + 'type' => 'string', + ], + 'Topic' => [ + 'type' => 'string', + ], + 'ChannelId' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ConsumerId' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s, please check and retry later ', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => null, + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'ons.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'ons.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'ons.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'ons.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'ons.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'mq-internet-access', + 'endpoint' => 'ons.mq-internet-access.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'ons.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'ons.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'ons.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'ons.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'ons.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'ons.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'ons.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'ons.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'ons.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'ons.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'ons.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'ons.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'ons.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'ons.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'ons.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'ons.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'ons.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'ons.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'ons.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'ons.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'ons.me-central-1.aliyuncs.com', + ], + ], +]; diff --git a/data/en_us/ons/2018-06-28/api-docs.php b/data/en_us/ons/2018-06-28/api-docs.php new file mode 100644 index 0000000..b6199ee --- /dev/null +++ b/data/en_us/ons/2018-06-28/api-docs.php @@ -0,0 +1,283 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Ons', + 'version' => '2018-06-28', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'OnsMessageGetByMsgId', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'OnsMessageGetByMsgId' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'parameters' => [ + [ + 'name' => 'OnsRegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'PreventCache', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'MsgId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HelpUrl' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'OffsetId' => [ + 'type' => 'string', + ], + 'StoreSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ReconsumeTimes' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'StoreTimestamp' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'InstanceId' => [ + 'type' => 'string', + ], + 'Body' => [ + 'type' => 'string', + ], + 'MsgId' => [ + 'type' => 'string', + ], + 'Flag' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Topic' => [ + 'type' => 'string', + ], + 'StoreHost' => [ + 'type' => 'string', + ], + 'BornTimestamp' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'BodyCRC' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'BornHost' => [ + 'type' => 'string', + ], + 'PropertyList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MessageProperty' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => null, + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'ons.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'ons.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'ons.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'ons.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'ons.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'mq-internet-access', + 'endpoint' => 'ons.mq-internet-access.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'ons.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'ons.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'ons.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'ons.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'ons.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'ons.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'ons.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'ons.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'ons.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'ons.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'ons.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'ons.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'ons.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'ons.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'ons.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'ons.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'ons.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'ons.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'ons.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'ons.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'ons.me-central-1.aliyuncs.com', + ], + ], +]; diff --git a/data/en_us/ons/2019-02-14/api-docs.php b/data/en_us/ons/2019-02-14/api-docs.php new file mode 100644 index 0000000..09b136e --- /dev/null +++ b/data/en_us/ons/2019-02-14/api-docs.php @@ -0,0 +1,6165 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Ons', + 'version' => '2019-02-14', + ], + 'directories' => [ + [ + 'id' => 121335, + 'title' => 'Service', + 'type' => 'directory', + 'children' => [ + 'OpenOnsService', + ], + ], + [ + 'id' => 121341, + 'title' => 'Message', + 'type' => 'directory', + 'children' => [ + 'OnsMessageTrace', + 'OnsMessageGetByMsgId', + 'OnsMessageGetByKey', + 'OnsMessagePageQueryByTopic', + 'OnsMessageDetail', + ], + ], + [ + 'id' => 121347, + 'title' => 'Region', + 'type' => 'directory', + 'children' => [ + 'OnsRegionList', + ], + ], + [ + 'id' => 121349, + 'title' => 'Instance', + 'type' => 'directory', + 'children' => [ + 'OnsInstanceCreate', + 'OnsInstanceBaseInfo', + 'OnsInstanceUpdate', + 'OnsInstanceInServiceList', + 'OnsInstanceDelete', + ], + ], + [ + 'id' => 121355, + 'title' => 'Topic', + 'type' => 'directory', + 'children' => [ + 'OnsTopicCreate', + 'OnsTopicStatus', + 'OnsTopicList', + 'OnsTopicSubDetail', + 'OnsTopicDelete', + ], + ], + [ + 'id' => 121362, + 'title' => 'Group', + 'type' => 'directory', + 'children' => [ + 'OnsGroupCreate', + 'OnsGroupConsumerUpdate', + 'OnsGroupList', + 'OnsGroupSubDetail', + 'OnsGroupDelete', + ], + ], + [ + 'id' => 121371, + 'title' => 'Tag', + 'type' => 'directory', + 'children' => [ + 'ListTagResources', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 121375, + 'title' => 'Consumer', + 'type' => 'directory', + 'children' => [ + 'OnsConsumerStatus', + 'OnsConsumerAccumulate', + 'OnsConsumerGetConnection', + 'OnsConsumerResetOffset', + 'OnsConsumerTimeSpan', + 'OnsMessagePush', + ], + ], + [ + 'id' => 121382, + 'title' => 'Messages tatistics', + 'type' => 'directory', + 'children' => [ + 'OnsTrendTopicInputTps', + 'OnsTrendGroupOutputTps', + ], + ], + [ + 'id' => 121389, + 'title' => 'Trace', + 'type' => 'directory', + 'children' => [ + 'OnsTraceQueryByMsgId', + 'OnsTraceQueryByMsgKey', + 'OnsTraceGetResult', + ], + ], + [ + 'id' => 121393, + 'title' => 'Dead-letter queues', + 'type' => 'directory', + 'children' => [ + 'OnsDLQMessagePageQueryByGroupId', + 'OnsDLQMessageGetById', + 'OnsDLQMessageResendById', + ], + ], + [ + 'id' => 187862, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'OnsTopicUpdate', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'OpenOnsService' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '8C5B4603-8977-4513-AB60-9C3E2F88****', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'example' => '2068689****0272', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OrderOpend', + 'errorMessage' => '您已开通，请前往控制台使用。', + ], + [ + 'errorCode' => 'PermissionDenied', + 'errorMessage' => '当前子账号无权限，请为子账号授权。', + ], + [ + 'errorCode' => 'PriceWanHuaTongSys', + 'errorMessage' => '询价调用万花筒错误。', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8C5B4603-8977-4513-AB60-9C3E2F88****\\",\\n \\"OrderId\\": \\"2068689****0272\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenOnsServiceResponse>\\n<RequestId>8C5B4603-8977-4513-AB60-9C3E2F88****</RequestId>\\n<OrderId>2068689****0272</OrderId>\\n</OpenOnsServiceResponse>","errorExample":""}]', + 'title' => 'OpenOnsService', + 'summary' => 'Activates Message Queue for Apache RocketMQ.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'You can call this operation the first time you use ApsaraMQ for RocketMQ. You can use ApsaraMQ for RocketMQ only after the service is activated.'."\n" + ."\n" + .'The ApsaraMQ for RocketMQ service can be activated only in the China (Hangzhou) region. Service activation is not billed.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Activate ApsaraMQ for RocketMQ in the console'."\n" + ."\n" + .'You can also activate ApsaraMQ for RocketMQ in the console. For more information, see [Activate ApsaraMQ for RocketMQ](~~169006~~).', + ], + 'OnsMessageTrace' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The topic to which the message belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-mq_topic', + ], + ], + [ + 'name' => 'MsgId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the message that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1E05791C117818B4AAC23B1BB0CE****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the message you want to query belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'EAE5BE23-37A1-4354-94D6-E44AE17E****', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MessageTrack' => [ + 'description' => 'The information about the message that is queried.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TrackType' => [ + 'description' => 'The status of the message. Valid values:'."\n" + ."\n" + .'* **CONSUMED**: The message is consumed.'."\n" + .'* **CONSUMED_BUT_FILTERED**: No consumer group subscribes to the message. The message is filtered out and not consumed.'."\n" + .'* **NOT_CONSUME_YET**: The message is not consumed.'."\n" + .'* **NOT_ONLINE**: The consumer group is offline.'."\n" + .'* **UNKNOWN**: The message is not consumed due to unknown reasons.'."\n", + 'type' => 'string', + 'example' => 'CONSUMED', + ], + 'ConsumerGroup' => [ + 'description' => 'The ID of the consumer group that subscribes to the topic.'."\n", + 'type' => 'string', + 'example' => 'GID_test_group_id', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance to which the message you want to query belongs.'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EAE5BE23-37A1-4354-94D6-E44AE17E****\\",\\n \\"Data\\": {\\n \\"MessageTrack\\": [\\n {\\n \\"TrackType\\": \\"CONSUMED\\",\\n \\"ConsumerGroup\\": \\"GID_test_group_id\\",\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsMessageTraceResponse>\\n<Data>\\n <MessageTrack>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <ConsumerGroup>GID_test_group_id</ConsumerGroup>\\n <TrackType>CONSUMED</TrackType>\\n </MessageTrack>\\n</Data>\\n<RequestId>EAE5BE23-37A1-4354-94D6-E44AE17****</RequestId>\\n</OnsMessageTraceResponse>","errorExample":""}]', + 'title' => 'OnsMessageTrace', + 'summary' => 'Queries the consumption status of a message by using the message ID.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'* You can call this operation to check whether a specified message is consumed. If the message is not consumed, you can troubleshoot the issue based on the returned information.'."\n" + .'* This operation queries information based on the built-in offset mechanism of ApsaraMQ for RocketMQ. In most cases, the results are correct. If you have reset the consumer offset or cleared accumulated messages, the results may not be correct.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## View the consumption status of a message in the console'."\n" + ."\n" + .'You can also view the consumption status of a message in the **ApsaraMQ for RocketMQ console**. For more information, see [Query a message trace](~~43357~~).', + ], + 'OnsMessageGetByMsgId' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'MsgId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the message that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1E0578FE110F18B4AAC235C05F2*****', + ], + ], + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The topic that contains the message you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-mq_topic', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the message you want to query belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'A07E3902-B92E-44A6-B6C5-6AA111111****', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'StoreSize' => [ + 'description' => 'The size of the message.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '407', + ], + 'ReconsumeTimes' => [ + 'description' => 'The number of retries that were performed to send the message to consumers.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StoreTimestamp' => [ + 'description' => 'The timestamp that indicates when the ApsaraMQ for RocketMQ broker stored the message.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570761026708', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + 'MsgId' => [ + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', + ], + 'StoreHost' => [ + 'description' => 'The ApsaraMQ for RocketMQ broker that stores the message.', + 'type' => 'string', + 'example' => '11.220.***.***:10911', + ], + 'Topic' => [ + 'description' => 'The topic to which the message belongs.'."\n", + 'type' => 'string', + 'example' => 'test-mq_topic', + ], + 'PropertyList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MessageProperty' => [ + 'description' => 'The attributes of the message.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of the attribute.'."\n", + 'type' => 'string', + 'example' => 'TagA', + ], + 'Name' => [ + 'description' => 'The name of the attribute. Valid values:'."\n" + ."\n" + .'* **TRACE_ON**: indicates whether a trace of the message exists.'."\n" + .'* **KEYS**: indicates the key of the message.'."\n" + .'* **TAGS**: indicates the tag that is attached to the message.'."\n" + .'* **INSTANCE_ID**: indicates the ID of the instance which contains the message.'."\n" + ."\n" + .'For information about the terms that are used in Message Queue for Apache RocketMQ, see [Terms](~~29533~~).'."\n", + 'type' => 'string', + 'example' => 'TAGS', + ], + ], + ], + ], + ], + ], + 'BornTimestamp' => [ + 'description' => 'The timestamp that indicates when the message was produced.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570761026630', + ], + 'BodyCRC' => [ + 'description' => 'The cyclic redundancy check (CRC) value of the message body.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '914112295', + ], + 'BornHost' => [ + 'description' => 'The producer instance that generated the message.'."\n", + 'type' => 'string', + 'example' => '42.120.**.**:64646', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A07E3902-B92E-44A6-B6C5-6AA111111****\\",\\n \\"Data\\": {\\n \\"StoreSize\\": 407,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C0C8460BA2\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"PropertyList\\": {\\n \\"MessageProperty\\": [\\n {\\n \\"Value\\": \\"TagA\\",\\n \\"Name\\": \\"TAGS\\"\\n }\\n ]\\n },\\n \\"BornTimestamp\\": 1570761026630,\\n \\"BodyCRC\\": 914112295,\\n \\"BornHost\\": \\"42.120.**.**:64646\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsMessageGetByMsgIdResponse>\\n<Data>\\n <MsgId>1E0578FE110F18B4AAC235C0C8460BA2</MsgId>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <ReconsumeTimes>1</ReconsumeTimes>\\n <BornHost>42.120.**.**:64646</BornHost>\\n <BodyCRC>914112295</BodyCRC>\\n <StoreHost>11.220.***.***:10911</StoreHost>\\n <StoreTimestamp>1570761026708</StoreTimestamp>\\n <BornTimestamp>1570761026630</BornTimestamp>\\n <Topic>test-mq_topic</Topic>\\n <StoreSize>407</StoreSize>\\n <PropertyList>\\n <MessageProperty>\\n <Name>TAGS</Name>\\n <Value>TagA</Value>\\n </MessageProperty>\\n </PropertyList>\\n</Data>\\n<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>\\n</OnsMessageGetByMsgIdResponse>","errorExample":""}]', + 'title' => 'OnsMessageGetByMsgId', + 'summary' => 'Queries the information about a message by specifying the message ID and determines whether the message has been consumed.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'* If a message is not consumed as expected, you can call this operation to query the information about the message for troubleshooting.'."\n" + .'* This operation uses the exact match method to query a message based on the message ID. You can obtain the message ID from the SendResult parameter that is returned after the message is sent. You must store the returned information after each message is sent. The queried information about a message includes the point in time when the message was sent, the broker on which the message is stored, and the attributes of the message such as the message key and tag.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => '## View the information about a message in the console'."\n" + ."\n" + .'You can also view the information about a message in the Message Queue for Apache RocketMQ console.**** For more information, see [Query a message](~~29540~~).'."\n", + ], + 'OnsMessageGetByKey' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The topic that contains the messages that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-mq_topic', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the messages that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'messageKey1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the messages that you want to query belong.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'A07E3902-B92E-44A6-B6C5-6AA111111****', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OnsRestMessageDo' => [ + 'description' => 'The list of returned results.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StoreSize' => [ + 'description' => 'The size of the message.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '406', + ], + 'ReconsumeTimes' => [ + 'description' => 'The number of retries that were performed to send the message to consumers.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StoreTimestamp' => [ + 'description' => 'The timestamp that indicates when the ApsaraMQ for RocketMQ broker stored the message.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570760999811', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + 'MsgId' => [ + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'example' => '1E0578FE110F18B4AAC235C05F2*****', + ], + 'StoreHost' => [ + 'description' => 'The ApsaraMQ for RocketMQ broker that stores the message.', + 'type' => 'string', + 'example' => '11.193.***.***:10911', + ], + 'Topic' => [ + 'description' => 'The topic to which the message belongs.'."\n", + 'type' => 'string', + 'example' => 'test-mq_topic', + ], + 'PropertyList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MessageProperty' => [ + 'description' => 'The attributes of the message.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of the attribute.'."\n", + 'type' => 'string', + 'example' => 'TagA', + ], + 'Name' => [ + 'description' => 'The name of the attribute. Valid values:'."\n" + ."\n" + .'- **TRACE_ON**: indicates whether the message trace exists.'."\n" + ."\n" + .'- **KEYS**: indicates the key of the message.'."\n" + ."\n" + .'- **TAGS**: indicates the tag that is attached to the message.'."\n" + ."\n" + .'- **INSTANCE_ID**: indicates the ID of the instance that contains the message.'."\n" + ."\n" + .'For information about the terms that are used in ApsaraMQ for RocketMQ, see [Terms](~~29533~~).', + 'type' => 'string', + 'example' => 'TAGS', + ], + ], + ], + ], + ], + ], + 'BornTimestamp' => [ + 'description' => 'The timestamp that indicates when the message was produced.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570760999721', + ], + 'BodyCRC' => [ + 'description' => 'The cyclic redundancy check (CRC) value of the message body.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '914112295', + ], + 'BornHost' => [ + 'description' => 'The producer client that generated the message.'."\n", + 'type' => 'string', + 'example' => '42.120.***.***:59270', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A07E3902-B92E-44A6-B6C5-6AA111111****\\",\\n \\"Data\\": {\\n \\"OnsRestMessageDo\\": [\\n {\\n \\"StoreSize\\": 406,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570760999811,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C05F2*****\\",\\n \\"StoreHost\\": \\"11.193.***.***:10911\\",\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"PropertyList\\": {\\n \\"MessageProperty\\": [\\n {\\n \\"Value\\": \\"TagA\\",\\n \\"Name\\": \\"TAGS\\"\\n }\\n ]\\n },\\n \\"BornTimestamp\\": 1570760999721,\\n \\"BodyCRC\\": 914112295,\\n \\"BornHost\\": \\"42.120.***.***:59270\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsMessageGetByKeyResponse>\\n<Data>\\n <MsgId>1E0578FE110F18B4AAC235C05F2*****</MsgId>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <ReconsumeTimes>1</ReconsumeTimes>\\n <BornHost>42.120.**.**:64646</BornHost>\\n <BodyCRC>914112295</BodyCRC>\\n <StoreHost>11.220.***.***:10911</StoreHost>\\n <StoreTimestamp>1570761026708</StoreTimestamp>\\n <BornTimestamp>1570761026630</BornTimestamp>\\n <Topic>test-mq_topic</Topic>\\n <StoreSize>407</StoreSize>\\n <PropertyList>\\n <MessageProperty>\\n <Name>TAGS</Name>\\n <Value>TagA</Value>\\n </MessageProperty>\\n </PropertyList>\\n</Data>\\n<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>\\n</OnsMessageGetByKeyResponse>","errorExample":""}]', + 'title' => 'OnsMessageGetByKey', + 'summary' => 'Queries messages by using a specified topic and message key.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'* This operation uses the fuzzy match method to query messages based on a specified message key. The same message key may be used by multiple messages. Therefore, the returned result may contain information about multiple messages.'."\n" + ."\n" + .'* This operation can be used in scenarios in which you cannot obtain the IDs of the messages that you want to query. You can perform the following steps to query the information about messages:'."\n" + ."\n" + .' 1. Call this operation to query message IDs.'."\n" + .' 2. Call the **OnsMessageGetByMsgId** operation that uses the exact match method to query the details of a specified message. For more information about the **OnsMessageGetByMsgId** operation, see [OnsMessageGetByMsgId](~~29607~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => '## View the information about a message in the console'."\n" + ."\n" + .'You can also view the information about messages in the ApsaraMQ for RocketMQ console.**** For more information, see [Query a message](~~29540~~).', + ], + 'OnsMessagePageQueryByTopic' => [ + 'summary' => 'Queries all messages that are stored in a specified topic within a specified time range by page.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the topic whose messages you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-mq_topic', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds. If you specify a valid value for the **TaskId** parameter in the request, this parameter does not take effect. The system uses the value of the BeginTime parameter that you specified in the request when you created the specified query task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1570723200000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds. If you specify a valid value for the **TaskId** parameter in the request, this parameter does not take effect. The system uses the value of the EndTime parameter that you specified in the request when you created the specified query task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1570809600000', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the query task. The first time you call this operation to query the information about messages in a specified topic within a specified time range, this parameter is not required. This parameter is required in subsequent queries for messages on a specified page. You can obtain the task ID from the returned result of the first query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0BC1310300002A9F000021E4D7A48346', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1. Valid values: 1 to 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 5 to 50. Default value: 20. If you specify a valid value for the **TaskId** parameter in the request, this parameter does not take effect. The system uses the value of the PageSize parameter that you specified in the request for creating the query task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the message you want to query belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '5DC2A47E-2B31-4722-96C8-FA59C9*****', + ], + 'MsgFoundDo' => [ + 'description' => 'The information about the message that is queried.'."\n", + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MsgFoundList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OnsRestMessageDo' => [ + 'description' => 'The information about messages on the returned page. The information that is contained in this parameter is the same as the information that is returned by the [OnsMessageGetByMsgId](~~29607~~) operation.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StoreSize' => [ + 'description' => 'The size of the message. Unit: KB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '406', + ], + 'ReconsumeTimes' => [ + 'description' => 'The number of retries that were performed to send the message to consumers.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StoreTimestamp' => [ + 'description' => 'The time when the ApsaraMQ for RocketMQ broker stored the message. The value is a UNIX timestamp that represents the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570760999811', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + 'MsgId' => [ + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'example' => '1E0578FE110F18B4AAC235C05F2*****', + ], + 'StoreHost' => [ + 'description' => 'The ApsaraMQ for RocketMQ broker that stores the message.', + 'type' => 'string', + 'example' => '11.193.***.***:10911', + ], + 'Topic' => [ + 'description' => 'The topic to which the message belongs.'."\n", + 'type' => 'string', + 'example' => 'test-mq_topic', + ], + 'PropertyList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MessageProperty' => [ + 'description' => 'The attributes of the message.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of the attribute.'."\n", + 'type' => 'string', + 'example' => 'TagA', + ], + 'Name' => [ + 'description' => 'The name of the attribute. Valid values:'."\n" + ."\n" + .'* **TRACE_ON**: indicates whether a trace of the message exists.'."\n" + .'* **KEYS**: indicates the key of the message.'."\n" + .'* **TAGS**: indicates the tag of the message.'."\n" + .'* **INSTANCE_ID**: indicates the ID of the instance that contains the message.'."\n" + ."\n" + .'For information about the terms that are used in ApsaraMQ for RocketMQ see [Terms](~~29533~~).', + 'type' => 'string', + 'example' => 'TAGS', + ], + ], + ], + ], + ], + ], + 'BornTimestamp' => [ + 'description' => 'The time when the message was generated. The value is a UNIX timestamp that represents the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570760999721', + ], + 'BodyCRC' => [ + 'description' => 'The cyclic redundancy check (CRC) value of the message body.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '914112295', + ], + 'BornHost' => [ + 'description' => 'The producer client that generated the message.'."\n", + 'type' => 'string', + 'example' => '42.120.***.***:59270', + ], + ], + ], + ], + ], + ], + 'MaxPageCount' => [ + 'description' => 'The total number of returned pages.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '400', + ], + 'TaskId' => [ + 'description' => 'The ID of the query task. The first time you call this operation to query the messages that are sent to a specified consumer group within a specified time range, this parameter is returned. You can use the task ID to query the details of messages on other returned pages.'."\n", + 'type' => 'string', + 'example' => '0BC1310300002A9F000021E4D7A48346', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5DC2A47E-2B31-4722-96C8-FA59C9*****\\",\\n \\"MsgFoundDo\\": {\\n \\"CurrentPage\\": 1,\\n \\"MsgFoundList\\": {\\n \\"OnsRestMessageDo\\": [\\n {\\n \\"StoreSize\\": 406,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570760999811,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C05F2*****\\",\\n \\"StoreHost\\": \\"11.193.***.***:10911\\",\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"PropertyList\\": {\\n \\"MessageProperty\\": [\\n {\\n \\"Value\\": \\"TagA\\",\\n \\"Name\\": \\"TAGS\\"\\n }\\n ]\\n },\\n \\"BornTimestamp\\": 1570760999721,\\n \\"BodyCRC\\": 914112295,\\n \\"BornHost\\": \\"42.120.***.***:59270\\"\\n }\\n ]\\n },\\n \\"MaxPageCount\\": 400,\\n \\"TaskId\\": \\"0BC1310300002A9F000021E4D7A48346\\"\\n }\\n}","type":"json"}]', + 'title' => 'OnsMessagePageQueryByTopic', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'* If you do not know the ID or key of a message that you want to query, you can call this operation to query all messages that are stored in the topic within a specified time range. The results are displayed by page.'."\n" + ."\n" + .'* We recommend that you specify a short time range to query messages. If you specify a long time range, a large number of messages are returned. In this case, you cannot find the message that you want to query in an efficient manner. You can perform the following steps to query messages:'."\n" + ."\n" + .' 1. Perform a paged query by specifying the topic, start time, end time, and number of entries to return on each page. If the topic contains messages, the information about the messages on the first page, total number of pages, and task ID are returned by default.'."\n" + .' 2. Specify the task ID and a page number to call this operation again to query the messages on the specified page. The BeginTime, EndTime, and PageSize parameters do not take effect. By default, the system uses the values of these parameters that you specified in the request when you created the specified query task.'."\n", + 'responseParamsDescription' => ' ', + ], + 'OnsMessageDetail' => [ + 'summary' => 'Queries the details of a message.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RocketMQ Instance.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'MQ_INST_184681981******_BXig0x6A', + ], + ], + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the topic in which the message you want to query is stored.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-mq_topic', + ], + ], + [ + 'name' => 'MsgId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the message that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1E0578FE110F18B4AAC235C0******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'EAE5BE23-37A1-4354-94D6-E44AE17E****', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'StoreSize' => [ + 'description' => 'The size of the message. Unit: KB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ReconsumeTimes' => [ + 'description' => 'The number of retries that ApsaraMQ for RocketMQ performed to send the message to consumers.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'StoreTimestamp' => [ + 'description' => 'The timestamp that indicates the point in time when the ApsaraMQ for RocketMQ broker stored the message. Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570761026708', + ], + 'Body' => [ + 'description' => 'The string that is obtained after the message body is encrypted by using the Base 64 algorithm.'."\n", + 'type' => 'string', + 'example' => 'aGVsbG8=', + ], + 'InstanceId' => [ + 'description' => 'The ID of the ApsaraMQ for RocketMQ Instance.', + 'type' => 'string', + 'example' => 'MQ_INST_184681981******_BXig0x6A', + ], + 'MsgId' => [ + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'example' => '1E0578FE110F18B4AAC235C05F2*****', + ], + 'StoreHost' => [ + 'description' => 'The ApsaraMQ for RocketMQ broker that stores the message.', + 'type' => 'string', + 'example' => '11.220.***.***:10911', + ], + 'Topic' => [ + 'description' => 'The topic to which the message belongs.'."\n", + 'type' => 'string', + 'example' => 'test-mq_topic', + ], + 'PropertyList' => [ + 'description' => 'The attributes of the message.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of the attribute.'."\n", + 'type' => 'string', + 'example' => 'MSG_REGION', + ], + 'Name' => [ + 'description' => 'The name of the attribute. Valid values:'."\n" + ."\n" + .'* **TRACE_ON**: indicates whether the trace of the message exists.'."\n" + .'* **MSG_REGION**: The region ID of the instance to which the topic belongs.'."\n" + .'* **\\__MESSAGE_DECODED_TIME**: The time when the message was decoded.'."\n" + .'* **\\__BORNHOST**: The IP address of the producer client.'."\n" + .'* **UNIQ_KEY**: The ID of the message.'."\n" + ."\n" + .'For information about the terms that are used in ApsaraMQ for RocketMQ, see [Terms](~~29533~~).', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + 'BornTimestamp' => [ + 'description' => 'The timestamp that indicates the point in time when the message was generated. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570761026630', + ], + 'BodyCRC' => [ + 'description' => 'The cyclic redundancy check (CRC) value of the message body.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '907060870', + ], + 'BornHost' => [ + 'description' => 'The producer instance that generated the message.'."\n", + 'type' => 'string', + 'example' => '42.120.**.**:64646', + ], + 'BodyStr' => [ + 'description' => 'The information about the message body.'."\n", + 'type' => 'string', + 'example' => 'hello', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EAE5BE23-37A1-4354-94D6-E44AE17E****\\",\\n \\"Data\\": {\\n \\"StoreSize\\": 2,\\n \\"ReconsumeTimes\\": 0,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"Body\\": \\"aGVsbG8=\\",\\n \\"InstanceId\\": \\"MQ_INST_184681981******_BXig0x6A\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C05F2*****\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"PropertyList\\": [\\n {\\n \\"Value\\": \\"MSG_REGION\\",\\n \\"Name\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"BornTimestamp\\": 1570761026630,\\n \\"BodyCRC\\": 907060870,\\n \\"BornHost\\": \\"42.120.**.**:64646\\",\\n \\"BodyStr\\": \\"hello\\"\\n }\\n}","type":"json"}]', + 'title' => 'OnsMessageDetail', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n", + ], + 'OnsRegionList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '72D14A84-45E5-4E01-A6DB-F63C4721****', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionDo' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => 'The time when the instance was updated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1411623866000', + ], + 'RegionName' => [ + 'description' => 'The region name.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)'."\n", + ], + 'ChannelName' => [ + 'description' => 'The channel name.'."\n", + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'CreateTime' => [ + 'description' => 'The time when the instance was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1411623866000', + ], + 'Id' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'OnsRegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"72D14A84-45E5-4E01-A6DB-F63C4721****\\",\\n \\"Data\\": {\\n \\"RegionDo\\": [\\n {\\n \\"UpdateTime\\": 1411623866000,\\n \\"RegionName\\": \\"华东1（杭州）\\",\\n \\"ChannelName\\": \\"ALIYUN\\",\\n \\"CreateTime\\": 1411623866000,\\n \\"Id\\": 1,\\n \\"OnsRegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsRegionListResponse>\\n<Data>\\n <RegionDo>\\n <RegionName>公网</RegionName>\\n <OnsRegionId>mq-internet-access</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>华北1（青岛）</RegionName>\\n <OnsRegionId>cn-qingdao</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>华南1（深圳）</RegionName>\\n <OnsRegionId>cn-shenzhen</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>华东1（杭州）</RegionName>\\n <OnsRegionId>cn-hangzhou</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>华北2（北京）</RegionName>\\n <OnsRegionId>cn-beijing</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>华东2（上海）</RegionName>\\n <OnsRegionId>cn-shanghai</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>西南1（成都）</RegionName>\\n <OnsRegionId>cn-chengdu</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>华北3（张家口）</RegionName>\\n <OnsRegionId>cn-zhangjiakou</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>华北5（呼和浩特）</RegionName>\\n <OnsRegionId>cn-huhehaote</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>中国（香港）</RegionName>\\n <OnsRegionId>cn-hongkong</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>新加坡</RegionName>\\n <OnsRegionId>ap-southeast-1</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>日本（东京）</RegionName>\\n <OnsRegionId>ap-northeast-1</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>马来西亚（吉隆坡）</RegionName>\\n <OnsRegionId>ap-southeast-3</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>印度（孟买）</RegionName>\\n <OnsRegionId>ap-south-1</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>阿联酋（迪拜）</RegionName>\\n <OnsRegionId>me-east-1</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>德国（法兰克福）</RegionName>\\n <OnsRegionId>eu-central-1</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>美国（硅谷）</RegionName>\\n <OnsRegionId>us-west-1</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>美国（弗吉尼亚）</RegionName>\\n <OnsRegionId>us-east-1</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>澳大利亚（悉尼）</RegionName>\\n <OnsRegionId>ap-southeast-2</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>英国（伦敦）</RegionName>\\n <OnsRegionId>eu-west-1</OnsRegionId>\\n </RegionDo>\\n <RegionDo>\\n <RegionName>印度尼西亚（雅加达）</RegionName>\\n <OnsRegionId>ap-southeast-5</OnsRegionId>\\n </RegionDo>\\n</Data>\\n<RequestId>72D14A84-45E5-4E01-A6DB-F63C4721****</RequestId>\\n</OnsRegionListResponse>","errorExample":""}]', + 'title' => 'OnsRegionList', + 'summary' => 'Queries regions where Message Queue for Apache RocketMQ is available.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'When you use an SDK to access and manage a ApsaraMQ for RocketMQ instance, you must sequentially specify the information about two regions. You can query the information about the second region by calling the OnsRegionList operation. You must apply for a public endpoint in the following scenarios:'."\n" + ."\n" + .'* Connect your application to ApsaraMQ for RocketMQ: Select the nearest API gateway endpoint based on the region where your application is deployed, and enter the corresponding **region ID**. The **regionId** is used to access Alibaba Cloud API Gateway because ApsaraMQ for RocketMQ instances provide API services by using the OpenAPI Explorer platform, which is also called POP.'."\n" + .'* Access a region to manage its resources: Specify a region where you want to manage ApsaraMQ for RocketMQ resources and enter the region ID. You can call the **OnsRegionList** operation to query a region ID.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OnsInstanceCreate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '14930', + 'abilityTreeNodes' => [ + 'FEATUREonsWNMPZ3', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Description'."\n", + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the instance. The name must meet the following rules:'."\n" + ."\n" + .'* The name of the instance must be unique in the region where the instance is deployed.'."\n" + .'* The name must be 3 to 64 characters in length and can contain letters, digits, hyphens (-), and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test instance'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'A07E3902-B92E-44A6-B6C5-6AA111111****', + ], + 'Data' => [ + 'description' => 'The result returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The ID of the instance that you created.'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + 'InstanceType' => [ + 'description' => 'The edition of the instance that you created. Valid value:'."\n" + ."\n" + .'* **1**: Standard Edition instances'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A07E3902-B92E-44A6-B6C5-6AA111111****\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"MQ_INST_188077086902****_BXSuW61e\\",\\n \\"InstanceType\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsInstanceCreateResponse>\\n<Data>\\n <InstanceId>MQ_INST_188077086902****_BXSuW61e</InstanceId>\\n <InstanceType>1</InstanceType>\\n</Data>\\n<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>\\n</OnsInstanceCreateResponse>","errorExample":""}]', + 'title' => 'OnsInstanceCreate', + 'summary' => 'Creates a Message Queue for Apache RocketMQ instance.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'An instance is a virtual machine (VM) that can be used to store information about the topics and groups of ApsaraMQ for RocketMQ. You can call this operation when you need to create service resources for the business that you want to launch. Before you call this operation, take note of the following limits:'."\n" + ."\n" + .'* A maximum of eight ApsaraMQ for RocketMQ instances can be deployed in each region.'."\n" + .'* This operation can be called to create only a Standard Edition instance. You can use the ApsaraMQ for RocketMQ console to create Standard Edition instances and Enterprise Platinum Edition instances. For information about how to create ApsaraMQ for RocketMQ instances, see [Manage instances](~~200153~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Create an instance in the console'."\n" + ."\n" + .'You can also create an instance in the **ApsaraMQ for RocketMQ console**. For information about how to create an instance in the ApsaraMQ for RocketMQ console, see [Manage instances](~~200153~~).', + ], + 'OnsInstanceBaseInfo' => [ + 'summary' => 'Queries the basic information of a Message Queue for Apache RocketMQ instance and the endpoint that a client uses to connect to the Message Queue for Apache RocketMQ instance to send and receive messages.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsHF2FLP', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MQ_INST_138015630679****_BAAy1Hac', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceBaseInfo' => [ + 'description' => 'The information about the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Endpoints' => [ + 'description' => 'The endpoints used to access ApsaraMQ for RocketMQ over different protocols.', + 'type' => 'object', + 'properties' => [ + 'TcpEndpoint' => [ + 'description' => 'The private TCP endpoint of the instance.'."\n", + 'type' => 'string', + 'example' => 'http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080', + ], + 'TcpInternetEndpoint' => [ + 'description' => 'The public TCP endpoint of the instance.'."\n" + ."\n" + .'* Only instances that are deployed in the China (Chengdu), China (Qingdao), or China (Shenzhen) region can be accessed by using public TCP endpoints.'."\n" + ."\n" + .'* Before you use a public TCP endpoint, make sure that your client SDK meets the following requirements:'."\n" + ."\n" + .' * TCP client SDK for Java: V2.0.0.Final or later For more information, see [Release notes for the SDK for Java](~~325569~~).'."\n" + .' * TCP client SDK for C++: V3.0.0 or later For more information, see [Release notes for the SDK for C++](~~325570~~).'."\n" + ."\n" + .'* You are charged for Internet traffic when you use a public TCP endpoint. For more information, see [Internet traffic fee](~~325571~~).'."\n", + 'type' => 'string', + 'example' => 'http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80', + ], + 'HttpInternetEndpoint' => [ + 'description' => 'The public HTTP endpoint of the instance.'."\n", + 'type' => 'string', + 'example' => 'http://138015630679****.mqrest.cn-chengdu.aliyuncs.com', + ], + 'HttpInternalEndpoint' => [ + 'description' => 'The private HTTP endpoint of the instance.'."\n", + 'type' => 'string', + 'example' => 'http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com', + ], + 'HttpInternetSecureEndpoint' => [ + 'description' => 'The public HTTPS endpoint of the instance.'."\n", + 'type' => 'string', + 'example' => 'https://138015630679****.mqrest.cn-chengdu.aliyuncs.com', + ], + ], + ], + 'IndependentNaming' => [ + 'description' => 'Indicates whether the instance uses a namespace. Valid values:'."\n" + ."\n" + .'* **true**: The instance uses a separate namespace. The name of each resource must be unique in the instance. The names of resources in different instances can be the same.'."\n" + .'* **false**: The instance does not use a separate namespace. The name of each resource must be globally unique within the instance and across all instances.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'MaxTps' => [ + 'description' => 'The maximum messaging transactions per second (TPS). Valid values: 5000, 10000, 20000, 50000, 100000, 200000, 300000, 500000, 800000, and 1000000.'."\n" + ."\n" + .'You can view the details about messaging TPS on the buy page of ApsaraMQ for RocketMQ.'."\n" + ."\n" + .'> This parameter is available only to the ApsaraMQ for RocketMQ Enterprise Platinum Edition instances.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'Remark' => [ + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'example' => 'ons-cn-m7r1r5f****', + ], + 'InstanceName' => [ + 'description' => 'The name of the instance.'."\n" + ."\n" + .'The name must be 3 to 64 characters in length and can contain letters, digits, hyphens (-), and underscores (\\_).'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ReleaseTime' => [ + 'description' => 'The time when the Enterprise Platinum Edition instance expires.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603555200000', + ], + 'TopicCapacity' => [ + 'description' => 'The maximum number of topics that can be created on the instance. Valid values: 25, 50, 100, 300, and 500.'."\n" + ."\n" + .'> This parameter is available only to the ApsaraMQ for RocketMQ Enterprise Platinum Edition instances.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'InstanceStatus' => [ + 'description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'* **0**: The instance is being deployed. This value is valid only for Enterprise Platinum Edition instances.'."\n" + .'* **2**: The instance has overdue payments. This value is valid only for Standard Edition instances.'."\n" + .'* **5**: The instance is running. This value is valid for Standard Edition instances and Enterprise Platinum Edition instances.'."\n" + .'* **7**: The instance is being upgraded and is running. This value is valid only for Enterprise Platinum Edition instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_138015630679****_BAAy1Hac', + ], + 'InstanceType' => [ + 'description' => 'The instance type. Valid values:'."\n" + ."\n" + .'* **1**: Standard Edition instances that use the pay-as-you-go billing method.'."\n" + .'* **2**: Enterprise Platinum Edition instances that use the subscription billing method.'."\n" + ."\n" + .'For information about the editions and specifications of ApsaraMQ for RocketMQ instances, see [Instance editions](~~185261~~).', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CreateTime' => [ + 'description' => 'The time when the instance was created. The value of this parameter is a UNIX timestamp in milliseconds.'."\n", + 'type' => 'string', + 'example' => '1570701259403', + ], + 'spInstanceId' => [ + 'description' => 'The commodity ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'ons-cn-m7r1r5f****', + ], + 'spInstanceType' => [ + 'description' => 'The commodity type of the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + 1 => '', + '', + ], + 'example' => '1', + ], + 'SupportClassic' => [ + 'title' => '是否支持经典网络'."\n" + .'0:未知'."\n" + .'1:支持'."\n" + .'2:不支持', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '6CC46974-65E8-4C20-AB07-D20D102E****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"InstanceBaseInfo\\": {\\n \\"Endpoints\\": {\\n \\"TcpEndpoint\\": \\"http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080\\",\\n \\"TcpInternetEndpoint\\": \\"http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80\\",\\n \\"HttpInternetEndpoint\\": \\"http://138015630679****.mqrest.cn-chengdu.aliyuncs.com\\",\\n \\"HttpInternalEndpoint\\": \\"http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com\\",\\n \\"HttpInternetSecureEndpoint\\": \\"https://138015630679****.mqrest.cn-chengdu.aliyuncs.com\\"\\n },\\n \\"IndependentNaming\\": true,\\n \\"MaxTps\\": 10000,\\n \\"Remark\\": \\"ons-cn-m7r1r5f****\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"ReleaseTime\\": 1603555200000,\\n \\"TopicCapacity\\": 50,\\n \\"InstanceStatus\\": 5,\\n \\"InstanceId\\": \\"MQ_INST_138015630679****_BAAy1Hac\\",\\n \\"InstanceType\\": 2,\\n \\"CreateTime\\": \\"1570701259403\\",\\n \\"spInstanceId\\": \\"ons-cn-m7r1r5f****\\",\\n \\"spInstanceType\\": 1,\\n \\"SupportClassic\\": 2\\n },\\n \\"RequestId\\": \\"6CC46974-65E8-4C20-AB07-D20D102E****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsInstanceBaseInfoResponse>\\n <InstanceBaseInfo>\\n <Endpoints>\\n <TcpEndpoint>http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080</TcpEndpoint>\\n <HttpInternetEndpoint>http://138015630679****.mqrest.cn-chengdu.aliyuncs.com</HttpInternetEndpoint>\\n <HttpInternalEndpoint>http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com</HttpInternalEndpoint>\\n <HttpInternetSecureEndpoint>https://138015630679****.mqrest.cn-chengdu.aliyuncs.com</HttpInternetSecureEndpoint>\\n <TcpInternetEndpoint>http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80</TcpInternetEndpoint>\\n </Endpoints>\\n <IndependentNaming>true</IndependentNaming>\\n <MaxTps>10000</MaxTps>\\n <Remark>onspre-cn-m7r1r5f****</Remark>\\n <InstanceName>test</InstanceName>\\n <ReleaseTime>1603555200000</ReleaseTime>\\n <TopicCapacity>50</TopicCapacity>\\n <InstanceStatus>5</InstanceStatus>\\n <InstanceId>MQ_INST_138015630679****_BAAy1Hac</InstanceId>\\n <InstanceType>2</InstanceType>\\n </InstanceBaseInfo>\\n <RequestId>6CC46974-65E8-4C20-AB07-D20D102E****</RequestId>\\n</OnsInstanceBaseInfoResponse>","errorExample":""}]', + 'title' => 'OnsInstanceBaseInfo', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'To send and receive messages, a client must be connected to a ApsaraMQ for RocketMQ instance by using an endpoint. You can call this operation to query the endpoints of the instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OnsInstanceUpdate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The updated description of the instance. If you do not configure this parameter, the instance description remains unchanged.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Updateddescription'."\n", + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new name of the instance. The name must meet the following rules:'."\n" + ."\n" + .'* The name of the instance must be unique in the region where the instance is deployed.'."\n" + .'* The name must be 3 to 64 characters in length and can contain letters, digits, hyphens (-), underscores (\\_), and Chinese characters.'."\n" + .'* If you do not configure this parameter, the instance name remains unchanged.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Updatedname'."\n", + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance whose name or description you want to update.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'A07E3902-B92E-44A6-B6C5-6AA111111****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A07E3902-B92E-44A6-B6C5-6AA111111****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsInstanceUpdateResponse>\\r\\n<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>\\r\\n</OnsInstanceUpdateResponse>","errorExample":""}]', + 'title' => 'OnsInstanceUpdate', + 'summary' => 'Updates the name and description of a Message Queue for Apache RocketMQ instance.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'A maximum of eight ApsaraMQ for RocketMQ instances can be deployed in each region.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Update the name and description of an instance in the console'."\n" + ."\n" + .'You can also update the name and description of an instance in the **ApsaraMQ for RocketMQ console**. For more information, see [Manage instances](~~200153~~).', + ], + 'OnsInstanceInServiceList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '14932', + 'abilityTreeNodes' => [ + 'FEATUREonsICR0M4', + ], + ], + 'parameters' => [ + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags that you want to attach to the instance. You can attach up to 20 tags to the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key. This parameter is not required. If you configure this parameter, you must also configure **Value**.**** If you configure Key and Value in a request, this operation queries only the instances that use the specified tags. If you do not configure these parameters in a request, this operation queries all instances that you can access.'."\n" + ."\n" + .'* The value of this parameter cannot be an empty string.'."\n" + .'* The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CartService', + ], + 'Value' => [ + 'description' => 'The tag value. This parameter is not required. If you configure this parameter, you must also configure **Key**.**** If you configure Key and Value in a request, this operation queries only the instances that use the specified tags. If you do not configure these parameters in a request, this operation queries all instances that you can access.'."\n" + ."\n" + .'* The value of this parameter can be an empty string.'."\n" + .'* The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `acs:` or `aliyun`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SericeA', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'NeedResourceInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether you want the resource information to be returned.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '0598E46F-DB06-40E2-AD7B-C45923EE****', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceVO' => [ + 'description' => 'The returned information about the queried instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'IndependentNaming' => [ + 'description' => 'Indicates whether a namespace is used for the instance. Valid values:'."\n" + ."\n" + .'* **true**: A separate namespace is used for the instance. The identifier of each resource in the instance must be unique within the instance. However, the identifier of a resource in the instance can be the same as the identifier of a resource in another instance that uses a different namespace.'."\n" + .'* **false**: A separate namespace is not used for the instance. The name of each resource must be globally unique within the instance and across all instances.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceName' => [ + 'description' => 'The instance name.'."\n" + ."\n" + .'The name must be 3 to 64 characters in length and can contain letters, digits, hyphens (-), and underscores (\\_).'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + 'ReleaseTime' => [ + 'description' => 'The time when the instance expires. If the instance is of Enterprise Platinum Edition, this parameter is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1551024000000', + ], + 'InstanceStatus' => [ + 'description' => 'The instance status. Valid values:'."\n" + ."\n" + .'* **0**: The instance is being deployed. This value is valid only for Enterprise Platinum Edition instances.'."\n" + .'* **2**: The instance has overdue payments. This value is valid only for Standard Edition instances.'."\n" + .'* **5**: The instance is running. This value is valid only for Standard Edition instances and Enterprise Platinum Edition instances.'."\n" + .'* **7**: The instance is being upgraded and is running. This value is valid only for Enterprise Platinum Edition instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags that are attached to the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'CartService', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'ServiceA', + ], + ], + ], + ], + ], + ], + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + 'InstanceType' => [ + 'description' => 'The instance type. Valid values:'."\n" + ."\n" + .'* **1**: Standard Edition'."\n" + .'* **2**: Enterprise Platinum Edition'."\n" + ."\n" + .'For information about the instance editions and the differences between the editions, see [Instance editions](~~185261~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CreateTime' => [ + 'description' => 'The time when the instance was created. The value of this parameter is a UNIX timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640847284000', + ], + 'TopicCount' => [ + 'description' => 'The number of topics.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupCount' => [ + 'description' => 'The number of consumer groups.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0598E46F-DB06-40E2-AD7B-C45923EE****\\",\\n \\"Data\\": {\\n \\"InstanceVO\\": [\\n {\\n \\"IndependentNaming\\": true,\\n \\"InstanceName\\": \\"test1\\",\\n \\"ReleaseTime\\": 1551024000000,\\n \\"InstanceStatus\\": 5,\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"CartService\\",\\n \\"Value\\": \\"ServiceA\\"\\n }\\n ]\\n },\\n \\"InstanceId\\": \\"MQ_INST_188077086902****_BXSuW61e\\",\\n \\"InstanceType\\": 2,\\n \\"CreateTime\\": 1640847284000,\\n \\"TopicCount\\": 1,\\n \\"GroupCount\\": 3\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsInstanceInServiceListResponse>\\n<RequestId>0598E46F-DB06-40E2-AD7B-C45923EE****</RequestId>\\n<Data>\\n <InstanceVO>\\n <InstanceName>test1</InstanceName>\\n <InstanceId>MQ_INST_188077086902****_BXSuW61e</InstanceId>\\n <ReleaseTime>1551024000000</ReleaseTime>\\n <InstanceStatus>5</InstanceStatus>\\n <IndependentNaming>true</IndependentNaming>\\n <InstanceType>2</InstanceType>\\n <Tags>\\n <Tag>\\n <Value>ServiceA</Value>\\n <Key>CartService</Key>\\n </Tag>\\n </Tags>\\n </InstanceVO>\\n</Data>\\n</OnsInstanceInServiceListResponse>","errorExample":""}]', + 'title' => 'OnsInstanceInServiceList', + 'summary' => 'Queries all Message Queue for Apache RocketMQ instances in a specified region within the current account.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OnsInstanceDelete' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'A07E3902-B92E-44A6-B6C5-6AA111111****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A07E3902-B92E-44A6-B6C5-6AA111111****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsInstanceDeleteResponse>\\r\\n<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>\\r\\n</OnsInstanceDeleteResponse>","errorExample":""}]', + 'title' => 'OnsInstanceDelete', + 'summary' => 'Deletes a Message Queue for Apache RocketMQ instance.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'* You can call this operation when you need to reclaim resources. For example, after you unpublish an application, you can reclaim the resources that were used for the application. An instance can be deleted only when the instance does not contain topics and groups.'."\n" + .'* After an instance is deleted, the instance cannot be restored. Exercise caution when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Delete an instance in the console'."\n" + ."\n" + .'You can also delete an instance in the ApsaraMQ for RocketMQ console.**** For information about how to delete an instance in the ApsaraMQ for RocketMQ console, see [Manage instances](~~200153~~).', + ], + 'OnsTopicCreate' => [ + 'summary' => 'Creates a topic.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the topic that you want to create. The name must meet the following rules:'."\n" + ."\n" + .'* The name must be 3 to 64 characters in length and can contain letters, digits, hyphens (-), and underscores (\\_).'."\n" + .'* The topic name cannot start with CID or GID because CID and GID are reserved prefixes for group IDs.'."\n" + .'* If the ApsaraMQ for RocketMQ instance in which you want to create the topic uses a namespace, the topic name must be unique in the instance. The topic name cannot be the same as an existing topic name or a group ID in the instance. The topic name can be the same as a topic name or a group ID in another instance that uses a different namespace. For example, if Instance A and Instance B use different namespaces, a topic name in Instance A can be the same as a topic name or a group ID in Instance B.'."\n" + .'* If the instance in which you want to create the topic does not use a namespace, the topic name must be globally unique across instances and regions. The topic name cannot be the same as an existing topic name or group ID in all ApsaraMQ for RocketMQ instances that belong to your Alibaba Cloud account.'."\n" + ."\n" + .'> To check whether an instance uses a namespace, log on to the ApsaraMQ for RocketMQ console, go to the **Instance Details** page, and then view the value of the Namespace field in the **Basic Information** section.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'MessageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of messages that you want to publish to the topic. Valid values:'."\n" + ."\n" + .'* **0**: normal messages'."\n" + .'* **1**: partitionally ordered messages'."\n" + .'* **2**: globally ordered messages'."\n" + .'* **4**: transactional messages'."\n" + .'* **5**: scheduled or delayed messages'."\n" + ."\n" + .'For more information about message types, see [Message types](~~155952~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the topic that you want to create.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test'."\n", + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance in which you want to create the topic.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'B6949B58-223E-4B75-B4FE-7797C15E****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s, please check and retry later', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B6949B58-223E-4B75-B4FE-7797C15E****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsTopicCreateResponse>\\r\\n<RequestId>B6949B58-223E-4B75-B4FE-7797C15E****</RequestId>\\r\\n</OnsTopicCreateResponse>","errorExample":""}]', + 'title' => 'OnsTopicCreate', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'When you want to release a new application or expand your business, you can call this operation to create a topic based on your business requirements.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Create a topic in the console'."\n" + ."\n" + .'You can also create a topic in the ApsaraMQ for RocketMQ console.**** For more information, see [Manage topics](~~199535~~).', + ], + 'OnsTopicStatus' => [ + 'summary' => 'Queries the total number of messages in a topic and the status of the topic.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREons8BETJT', + ], + ], + 'parameters' => [ + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the topic that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance that contains the topic you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '427EE49D-D762-41FB-8F3D-9BAC96C3****', + ], + 'Data' => [ + 'description' => 'The data structure of the queried topic.'."\n", + 'type' => 'object', + 'properties' => [ + 'Perm' => [ + 'description' => 'Indicates the operations that you can perform on the topic. Valid values:'."\n" + ."\n" + .'* **2**: You can publish messages to the topic.'."\n" + .'* **4**: You can subscribe to the topic.'."\n" + .'* **6**: You can publish messages to and subscribe to the topic.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'LastTimeStamp' => [ + 'description' => 'The point in time when the latest message is ready in the topic. If no message exists in the topic, the return value of this parameter is 0.'."\n" + ."\n" + .'The value of this parameter is a UNIX timestamp in milliseconds.'."\n" + ."\n" + .'For information about the definition of ready messages and ready time, see [Terms](~~29533~~).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570864984364', + ], + 'TotalCount' => [ + 'description' => 'The total number of messages in all partitions of the topic.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2310', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"427EE49D-D762-41FB-8F3D-9BAC96C3****\\",\\n \\"Data\\": {\\n \\"Perm\\": 6,\\n \\"LastTimeStamp\\": 1570864984364,\\n \\"TotalCount\\": 2310\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsTopicStatusResponse>\\n<Data>\\n <Perm>6</Perm>\\n <TotalCount>2310</TotalCount>\\n <LastTimeStamp>1570864984364</LastTimeStamp>\\n</Data>\\n<RequestId>427EE49D-D762-41FB-8F3D-9BAC96C3****</RequestId>\\n</OnsTopicStatusResponse>","errorExample":""}]', + 'title' => 'OnsTopicStatus', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'You can determine the resource usage of a topic based on the information that is returned by this operation. The returned information includes the total number of messages in the topic and the most recent point in time when a message was published to the topic.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OnsTopicList' => [ + 'summary' => 'Queries the information about topics that belong to the current account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsXSOU1Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the topic that you want to query. This parameter is required if you want to query a specific topic. If you do not include this parameter in a request, all topics that you can access are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance that contains the topics you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of tags that are attached to the topic. A maximum of 20 tags can be included in the list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags to be returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag that is attached to the topics you want to query. This parameter is not required. If you configure this parameter, you must also configure the **Value** parameter.**** If you include the Key and Value parameters in a request, this operation queries only the topics that use the specified tag. If you do not include these parameters in a request, this operation queries all topics that you can access.'."\n" + ."\n" + .'* The value of this parameter cannot be an empty string.'."\n" + .'* A tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CartService', + ], + 'Value' => [ + 'description' => 'The value of the tag that is attached to the topics you want to query. This parameter is not required. If you configure this parameter, you must also configure the **Key** parameter.**** If you include the Key and Value parameters in a request, this operation queries only the topics that use the specified tag. If you do not include these parameters in a request, this operation queries all topics that you can access.'."\n" + ."\n" + .'* The value of this parameter can be an empty string.'."\n" + .'* A tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. It cannot start with `acs:` or `aliyun`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ServiceA', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '4A978869-7681-4529-B470-107E1379****', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PublishInfoDo' => [ + 'description' => 'The information about the topics.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a topic that is queried.'."\n", + 'type' => 'object', + 'properties' => [ + 'MessageType' => [ + 'description' => 'The message type. Valid values:'."\n" + ."\n" + .'* **0**: normal messages'."\n" + .'* **1**: partitionally ordered messages'."\n" + .'* **2**: globally ordered messages'."\n" + .'* **4**: transactional messages'."\n" + .'* **5**: scheduled or delayed messages'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RelationName' => [ + 'description' => 'The relationship between the current account and the topic. The value of this parameter indicates whether the current account is the owner of the topic, and whether the current account can subscribe or publish messages to the topic. the topic.'."\n", + 'type' => 'string', + 'example' => 'Publish and subscribe'."\n", + ], + 'Owner' => [ + 'description' => 'The user ID of the topic owner. The value of this parameter is an Alibaba account ID.'."\n", + 'type' => 'string', + 'example' => '138015630679****', + ], + 'IndependentNaming' => [ + 'description' => 'Indicates whether the instance that contains the topic uses a namespace. Valid values:'."\n" + ."\n" + .'* **true**: The instance uses a separate namespace. The name of each resource must be unique in the instance. The names of resources in different instances can be the same.'."\n" + .'* **false**: The instance does not use a separate namespace. The name of each resource must be globally unique within an instance and across all instances.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Remark' => [ + 'description' => 'The description of the topic.'."\n", + 'type' => 'string', + 'example' => 'Test'."\n", + ], + 'Relation' => [ + 'description' => 'Indicates the relationship between the current account and the topic. Valid values:'."\n" + ."\n" + .'* **1**: The current account is the owner of the topic.'."\n" + .'* **2**: The current account can publish messages to the topic.'."\n" + .'* **4**: The current account can subscribe to the topic.'."\n" + .'* **6**: The current account can publish messages to and subscribe to the topic.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'CreateTime' => [ + 'description' => 'The time when the topic was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570700947000', + ], + 'Topic' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags that are attached to the topic.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'CartService', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'SrviceA', + ], + ], + ], + ], + ], + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance that contains the topic.'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + 'ServiceStatus' => [ + 'description' => 'The status of the topic that is asynchronously created. Valid values:'."\n" + ."\n" + .'* **0**: The topic is being created.'."\n" + .'* **1**: The topic is being used.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4A978869-7681-4529-B470-107E1379****\\",\\n \\"Data\\": {\\n \\"PublishInfoDo\\": [\\n {\\n \\"MessageType\\": 0,\\n \\"RelationName\\": \\"授权发布/订阅\\",\\n \\"Owner\\": \\"138015630679****\\",\\n \\"IndependentNaming\\": true,\\n \\"Remark\\": \\"测试\\",\\n \\"Relation\\": 6,\\n \\"CreateTime\\": 1570700947000,\\n \\"Topic\\": \\"test\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"CartService\\",\\n \\"Value\\": \\"SrviceA\\"\\n }\\n ]\\n },\\n \\"InstanceId\\": \\"MQ_INST_188077086902****_BXSuW61e\\",\\n \\"ServiceStatus\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsTopicListResponse>\\n <RequestId>4A978869-7681-4529-B470-107E1379****</RequestId>\\n <Data>\\n <MessageType>0</MessageType>\\n <RelationName>授权发布/订阅</RelationName>\\n <Owner>138015630679****</Owner>\\n <IndependentNaming>true</IndependentNaming>\\n <Remark>测试</Remark>\\n <Relation>6</Relation>\\n <CreateTime>1570700947000</CreateTime>\\n <Topic>test</Topic>\\n <Tags>\\n <Key>CartService</Key>\\n <Value>SrviceA</Value>\\n </Tags>\\n <InstanceId>MQ_INST_188077086902****_BXSuW61e</InstanceId>\\n <ServiceStatus>0</ServiceStatus>\\n </Data>\\n</OnsTopicListResponse>","errorExample":""}]', + 'title' => 'OnsTopicList', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'This operation returns the basic information about topics and does not return the details of topics.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OnsTopicSubDetail' => [ + 'summary' => 'Queries the online consumer groups that subscribe to a specified topic.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14953', + 'abilityTreeNodes' => [ + 'FEATUREons8BETJT', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance that contains the topic you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the topic that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '87B6207F-2908-42B5-A134-84956DCA****', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'SubscriptionDataList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubscriptionDataList' => [ + 'description' => 'The information about the online consumer groups that subscribe to the topic.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'description' => 'The ID of the consumer group that subscribes to the topic.'."\n", + 'type' => 'string', + 'example' => 'GID_test', + ], + 'MessageModel' => [ + 'description' => 'The consumption mode. Valid values:'."\n" + ."\n" + .'* **CLUSTERING**: the clustering consumption mode'."\n" + .'* **BROADCASTING**: the broadcasting consumption mode'."\n" + ."\n" + .'For more information about consumption modes, see [Clustering consumption and broadcasting consumption](~~43163~~).'."\n", + 'type' => 'string', + 'example' => 'CLUSTERING', + ], + 'SubString' => [ + 'description' => 'The expression based on which consumers in the consumer group subscribe to the topic.'."\n", + 'type' => 'string', + 'example' => '*', + ], + 'Online' => [ + 'title' => '是否在线', + 'description' => 'Indicates whether the consumer group is online.', + 'type' => 'string', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'Topic' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"87B6207F-2908-42B5-A134-84956DCA****\\",\\n \\"Data\\": {\\n \\"SubscriptionDataList\\": {\\n \\"SubscriptionDataList\\": [\\n {\\n \\"GroupId\\": \\"GID_test\\",\\n \\"MessageModel\\": \\"CLUSTERING\\",\\n \\"SubString\\": \\"*\\",\\n \\"Online\\": \\"true\\"\\n }\\n ]\\n },\\n \\"Topic\\": \\"test\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsTopicSubDetailResponse>\\n<Data>\\n <Topic>test</Topic>\\n <SubscriptionDataList>\\n <SubscriptionDataList>\\n <SubString>*</SubString>\\n <MessageModel>CLUSTERING</MessageModel>\\n <GroupId>GID_test</GroupId>\\n </SubscriptionDataList>\\n </SubscriptionDataList>\\n</Data>\\n<RequestId>87B6207F-2908-42B5-A134-84956DCA****</RequestId>\\n</OnsTopicSubDetailResponse>","errorExample":""}]', + 'title' => 'OnsTopicSubDetail', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'You can call this operation to query the online consumer groups that subscribe to a specified topic. If all consumers in a group are offline, the information about the group is not returned.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## View consumer groups that subscribe to a topic in the console'."\n" + ."\n" + .'You can also view the information about the online consumer groups that subscribe to a topic in the **Message Queue for Apache RocketMQ console**. For more information, see [View subscriptions](~~90592~~).'."\n", + ], + 'OnsTopicDelete' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the topic that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the topic you want to delete belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '4189D4A6-231A-4028-8D89-F66A76C1****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4189D4A6-231A-4028-8D89-F66A76C1****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsTopicDeleteResponse>\\r\\n<RequestId>4189D4A6-231A-4028-8D89-F66A76C1****</RequestId>\\r\\n</OnsTopicDeleteResponse>","errorExample":""}]', + 'title' => 'OnsTopicDelete', + 'summary' => 'Deletes a topic.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur. - After you delete the topic, the publishing and subscription relationships that are constructed based on the topic are cleared. Exercise caution when you call this operation.'."\n" + ."\n" + .'You can call this operation to delete a topic when you need to reclaim the resources from the topic. For example, after an application is brought offline, you can delete the topics that are used for the application. After you delete a topic, the backend of ApsaraMQ for RocketMQ reclaims the resources from the topic. The system requires a long period of time to reclaim the resources. After you delete a topic, we recommend that you do not create a topic that uses the same name as the deleted topic within a short period of time. If the system fails to delete the specified topic, troubleshoot the issue based on the error code.', + 'requestParamsDescription' => ' ', + 'extraInfo' => '## Delete a topic in the console'."\n" + ."\n" + .'You can also delete a topic in the **ApsaraMQ for RocketMQ console**. For more information, see [Manage topics](~~199535~~).', + ], + 'OnsGroupCreate' => [ + 'summary' => 'Creates a consumer group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group that you want to create. The group ID must meet the following rules:'."\n" + ."\n" + .'* The group ID must be 2 to 64 characters in length and can contain only letters, digits, hyphens (-), and underscores (\\_).'."\n" + .'* If the ApsaraMQ for RocketMQ instance in which you want to create the consumer group uses a namespace, the group ID must be unique in the instance. The group ID cannot be the same as an existing group ID or a topic name in the instance. The group ID can be the same as a group ID or a topic name in another instance that uses a different namespace. For example, if Instance A and Instance B use different namespaces, a group ID in Instance A can be the same as a group ID or a topic name in Instance B.'."\n" + .'* If the instance does not use a namespace, the group ID must be globally unique across instances and regions. The group ID cannot be the same as an existing group ID or topic name in ApsaraMQ for RocketMQ instances that belong to your Alibaba Cloud account.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* After the consumer group is created, the group ID cannot be changed.'."\n" + ."\n" + .'* To check whether an instance uses a namespace, log on to the ApsaraMQ for RocketMQ console, go to the **Instance Details** page, and then view the value of the Namespace field in the **Basic Information** section.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_groupId', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the consumer group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance in which you want to create the consumer group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol over which clients in the consumer group communicate with the ApsaraMQ for RocketMQ broker. All clients in a consumer group communicate with the ApsaraMQ for RocketMQ broker over the same protocol. You must create different groups for TCP clients and HTTP clients. Valid values:'."\n" + ."\n" + .'* **tcp**: Clients in the consumer group consume messages over TCP. This is the default value.'."\n" + .'* **http**: Clients in the consumer group consume messages over HTTP.', + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + 'default' => 'tcp', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'A07E3902-B92E-44A6-B6C5-6AA111111****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s, please check and retry later', + ], + [ + 'errorCode' => 'Group.NumLimited', + 'errorMessage' => 'group count exceed limit.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A07E3902-B92E-44A6-B6C5-6AA111111****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsGroupCreateResponse>\\r\\n<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>\\r\\n</OnsGroupCreateResponse>","errorExample":""}]', + 'title' => 'OnsGroupCreate', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'When you release a new application or implement new business logic, you need new consumer groups. You can call this operation to create a consumer group.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Create a consumer group in the console'."\n" + ."\n" + .'You can also create a consumer group in the ApsaraMQ for RocketMQ console.**** For more information, see [Manage groups](~~200386~~).', + ], + 'OnsGroupConsumerUpdate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group for which you want to configure read permissions.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_groupId', + ], + ], + [ + 'name' => 'ReadEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to authorize the consumer group to read messages. Valid values:'."\n" + ."\n" + .'* **true**: The consumer group can read messages.'."\n" + .'* **false**: The consumer group cannot read messages.'."\n" + ."\n" + .'Default value: **true**.'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the consumer group you want to configure belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'A07E3902-B92E-44A6-B6C5-6AA111111****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A07E3902-B92E-44A6-B6C5-6AA111111****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsGroupConsumerUpdateResponse>\\r\\n<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>\\r\\n</OnsGroupConsumerUpdateResponse>","errorExample":""}]', + 'title' => 'OnsGroupConsumerUpdate', + 'summary' => 'Configures read permissions on messages for a consumer group that is identified by a group ID.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'You can call this operation to configure the permissions for a consumer group to read messages based on a specified region of ApsaraMQ for RocketMQ and a specified group ID. You can call this operation in scenarios in which you want to forbid consumers in a specific group from reading messages.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OnsGroupList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the consumer group you want to query belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is required only when you query specific consumer groups by using the fuzzy search method. If this parameter is not configured, the system queries all consumer groups that can be accessed by the current account.'."\n" + ."\n" + .'If you set this parameter to GID_ABC, the information about the consumer groups whose IDs contain GID_ABC is returned. For example, the information about the GID_test_GID_ABC\\_123 and GID_ABC\\_356 consumer groups is returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GID_test_group_id', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol over which the queried consumer group publishes and subscribes to messages. All clients in a consumer group communicate with the ApsaraMQ for RocketMQ broker over the same protocol. You must create different consumer groups for TCP clients and HTTP clients. Valid values:'."\n" + ."\n" + .'* **tcp**: specifies that the consumer group publishes or subscribes to messages over TCP. This value is the default value.'."\n" + .'* **http**: specifies that the consumer group publishes or subscribes to messages over HTTP.', + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + 'default' => 'tcp', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of tags that are attached to the consumer group. A maximum of 20 tags can be included in the list.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag that is attached to the consumer group. This parameter is not required. If you configure this parameter, you must configure the **Key** parameter.**** If you configure both the Key and Value parameters, the consumer groups are filtered based on the specified tag. If you do not configure these parameters, all consumer groups are queried.'."\n" + ."\n" + .'* The value of this parameter cannot be an empty string.'."\n" + .'* The tag value must be 1 to 128 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CartService', + ], + 'Value' => [ + 'description' => 'The value of the tag that is attached to the group. This parameter is not required. If you configure this parameter, you must configure the **Key** parameter.**** If you configure both the Key and Value parameters, the consumer groups are filtered based on the specified tag. If you do not configure these parameters, all consumer groups are queried.'."\n" + ."\n" + .'* The value of this parameter can be an empty string.'."\n" + .'* The tag key must be 1 to 128 characters in length and cannot contain `http://` or `https://`. It cannot start with `acs:` or `aliyun`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ServiceA', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '16996623-AC4A-43AF-9248-FD9D2D75****', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubscribeInfoDo' => [ + 'description' => 'The returned list of subscriptions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => 'The Alibaba Cloud account ID of the user who created the consumer group.'."\n", + 'type' => 'string', + 'example' => '138015630679****', + ], + 'UpdateTime' => [ + 'description' => 'The most recent point in time when the consumer group was updated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570700979000', + ], + 'IndependentNaming' => [ + 'description' => 'Indicates whether the instance uses a namespace. Valid values:'."\n" + ."\n" + .'* **true**: The instance uses a separate namespace. The name of each resource must be unique in the instance. The names of resources in different instances can be the same.'."\n" + .'* **false**: The instance does not use a separate namespace. The name of each resource must be globally unique within the instance and across all instances.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'GroupId' => [ + 'description' => 'The ID of the consumer group.'."\n", + 'type' => 'string', + 'example' => 'GID_test_group_id', + ], + 'Remark' => [ + 'description' => 'The description of the consumer group.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => 'The point in time when the consumer group was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568896605000', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags that are attached to the consumer group.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag that is attached to the consumer group.'."\n", + 'type' => 'string', + 'example' => 'CartService', + ], + 'Value' => [ + 'description' => 'The value of the tag that is attached to the consumer group.'."\n", + 'type' => 'string', + 'example' => 'ServiceA', + ], + ], + ], + ], + ], + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + 'GroupType' => [ + 'description' => 'The protocol over which the queried consumer group publishes and subscribes to messages. All clients in a consumer group communicate with the ApsaraMQ for RocketMQ broker over the same protocol. You must create different consumer groups for TCP clients and HTTP clients. Valid values:'."\n" + ."\n" + .'* **tcp**: indicates that the consumer group publishes and subscribes to messages over TCP.'."\n" + .'* **http**: indicates that the consumer group publishes and subscribes to messages over HTTP.', + 'type' => 'string', + 'example' => 'tcp', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16996623-AC4A-43AF-9248-FD9D2D75****\\",\\n \\"Data\\": {\\n \\"SubscribeInfoDo\\": [\\n {\\n \\"Owner\\": \\"138015630679****\\",\\n \\"UpdateTime\\": 1570700979000,\\n \\"IndependentNaming\\": true,\\n \\"GroupId\\": \\"GID_test_group_id\\",\\n \\"Remark\\": \\"test\\",\\n \\"CreateTime\\": 1568896605000,\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"CartService\\",\\n \\"Value\\": \\"ServiceA\\"\\n }\\n ]\\n },\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"GroupType\\": \\"tcp\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsGroupListResponse>\\n<RequestId>16996623-AC4A-43AF-9248-FD9D2D75****</RequestId>\\n<Data>\\n <SubscribeInfoDo>\\n <Owner>138015630679****</Owner>\\n <GroupType>tcp</GroupType>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <CreateTime>1568896605000</CreateTime>\\n <UpdateTime>1570700979000</UpdateTime>\\n <IndependentNaming>true</IndependentNaming>\\n <GroupId>GID_test_group_id</GroupId>\\n <Remark>test</Remark>\\n <Tags>\\n <Tag>\\n <Value>ServiceA</Value>\\n <Key>CartService</Key>\\n </Tag>\\n </Tags>\\n </SubscribeInfoDo>\\n</Data>\\n</OnsGroupListResponse>","errorExample":""}]', + 'title' => 'OnsGroupList', + 'summary' => 'Queries one or more group IDs.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OnsGroupSubDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the consumer group you want to query belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_group_id', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '3364E875-013B-442A-BC3C-C1A84DC6****', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'SubscriptionDataList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubscriptionDataList' => [ + 'description' => 'The topics to which consumers in the consumer group subscribe. If all consumers in the specified group are offline, no topics are returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SubString' => [ + 'description' => 'The expression based on which consumers in the consumer group subscribe to the topic.'."\n", + 'type' => 'string', + 'example' => '*', + ], + 'Topic' => [ + 'description' => 'The name of the topic to which consumers in the consumer group subscribe.'."\n", + 'type' => 'string', + 'example' => 'test-mq_topic', + ], + ], + ], + ], + ], + ], + 'GroupId' => [ + 'description' => 'The ID of the consumer group that you want to query.'."\n", + 'type' => 'string', + 'example' => 'GID_test_group_id', + ], + 'MessageModel' => [ + 'description' => 'The consumption mode. Valid values:'."\n" + ."\n" + .'* **CLUSTERING**: the clustering consumption mode'."\n" + .'* **BROADCASTING**: the broadcasting consumption mode'."\n" + ."\n" + .'For more information about consumption modes, see [Clustering consumption and broadcasting consumption](~~43163~~).'."\n", + 'type' => 'string', + 'example' => 'CLUSTERING', + ], + 'Online' => [ + 'description' => 'Indicates whether consumers in the group are online.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3364E875-013B-442A-BC3C-C1A84DC6****\\",\\n \\"Data\\": {\\n \\"SubscriptionDataList\\": {\\n \\"SubscriptionDataList\\": [\\n {\\n \\"SubString\\": \\"*\\",\\n \\"Topic\\": \\"test-mq_topic\\"\\n }\\n ]\\n },\\n \\"GroupId\\": \\"GID_test_group_id\\",\\n \\"MessageModel\\": \\"CLUSTERING\\",\\n \\"Online\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsGroupSubDetailResponse>\\n<Data>\\n <MessageModel>CLUSTERING</MessageModel>\\n <Online>true</Online>\\n <SubscriptionDataList>\\n <SubscriptionDataList>\\n <SubString>*</SubString>\\n <Topic>test-mq_topic</Topic>\\n </SubscriptionDataList>\\n </SubscriptionDataList>\\n <GroupId>GID_test_group_id</GroupId>\\n</Data>\\n<RequestId>3364E875-013B-442A-BC3C-C1A84DC6****</RequestId>\\n</OnsGroupSubDetailResponse>","errorExample":""}]', + 'title' => 'OnsGroupSubDetail', + 'summary' => 'Queries all topics to which a specified consumer group subscribes. If no consumer instance in the consumer group is online, no data is returned.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Query the topics to which a consumer group subscribe in the console'."\n" + ."\n" + .'You can also query the topics to which a consumer group subscribe in the ApsaraMQ for RocketMQ console.**** For more information, see [Query subscriptions](~~90592~~).', + ], + 'OnsGroupDelete' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_groupId', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RocketMQ instance to which the specified consumer group belongs.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'A07E3902-B92E-44A6-B6C5-6AA111111****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A07E3902-B92E-44A6-B6C5-6AA111111****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsGroupDeleteResponse>\\r\\n<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>\\r\\n</OnsGroupDeleteResponse>","errorExample":""}]', + 'title' => 'OnsGroupDelete', + 'summary' => 'Deletes a consumer group.', + 'description' => '> '."\n" + ."\n" + .'* API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + .'* After you delete a group, the consumers in the group immediately stop receiving messages. Exercise caution when you call this operation.'."\n" + ."\n" + .'You can call this operation to delete a group when you need to reclaim the resources of the group. For example, after an application is brought offline, you can delete the groups that are used for the application. After you delete a group, the backend of ApsaraMQ for RocketMQ reclaims the resources of the group. The system requires a long period of time to reclaim the resources. We recommend that you do not create a group that uses the same name as a deleted group immediately after you delete the group. If the system fails to delete the specified group, troubleshoot the issue based on the error code.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Delete a group in the console'."\n" + ."\n" + .'You can also delete a group in the **ApsaraMQ for RocketMQ console**. For more information, see [Manage groups](~~200386~~).', + ], + 'ListTagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RocketMQ instance to which the resource whose tags you want to query belongs.'."\n" + ."\n" + .'> This parameter is required when you query the tags of a topic or a group.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource whose tags you want to query. Valid values:'."\n" + ."\n" + .'* **INSTANCE**'."\n" + .'* **TOPIC**'."\n" + .'* **GROUP**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TOPIC', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that determines the start point of the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0****be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags that you want to query. A maximum of 20 tags can be included in the list.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag that you want to detach from the resource.'."\n" + ."\n" + .'* If you include this parameter in a request, the value of this parameter cannot be an empty string.'."\n" + .'* The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CartService', + ], + 'Value' => [ + 'description' => 'The value of the tag that you want to query.'."\n" + ."\n" + .'* The value of this parameter can be an empty string.'."\n" + .'* The tag key must be 1 to 128 characters in length and cannot contain `http://` or `https://`. It cannot start with `acs:` or `aliyun`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ServiceA', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource whose tags you want to query.'."\n" + ."\n" + .'* If the resource is a ApsaraMQ for RocketMQ instance, set the value of this parameter to the ID of the instance.'."\n" + .'* If the resource is a topic, set the value of this parameter to the name of the topic.'."\n" + .'* If the resource is a group, set the value of this parameter to the ID of the group.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'required' => false, + 'example' => 'TopicA', + 'maxItems' => 51, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token that determines the start point of the next query.'."\n", + 'type' => 'string', + 'example' => 'caeba0****be03f84eb48b699f0a4883', + ], + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '301D2CBE-66F8-403D-AEC0-82582478****', + ], + 'TagResources' => [ + 'description' => 'Details of the resource and tags, including the resource ID, the resource type, tag keys, and tag values.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The type of the resource whose tags you want to query.'."\n" + ."\n" + .'* ALIYUN::MQ::INSTANCE: indicates that the resource is a ApsaraMQ for RocketMQ instance.'."\n" + .'* ALIYUN::MQ::TOPIC: indicates that the resource is a topic.'."\n" + .'* ALIYUN::MQ::GROUP: indicates that the resource is a group.', + 'type' => 'string', + 'example' => 'ALIYUN::MQ::TOPIC', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + 'TagValue' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'ServiceA', + ], + 'ResourceId' => [ + 'description' => 'Indicates the ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'TopicA', + ], + 'TagKey' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'CartService', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0****be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"301D2CBE-66F8-403D-AEC0-82582478****\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"ALIYUN::MQ::TOPIC\\",\\n \\"InstanceId\\": \\"MQ_INST_188077086902****_BXSuW61e\\",\\n \\"TagValue\\": \\"ServiceA\\",\\n \\"ResourceId\\": \\"TopicA\\",\\n \\"TagKey\\": \\"CartService\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n<RequestId>301D2CBE-66F8-403D-AEC0-82582478****</RequestId>\\n<NextToken>caeba0****be03f84eb48b699f0a4883</NextToken>\\n<TagResources>\\n <ResourceId>TopicA</ResourceId>\\n <InstanceId>MQ_INST_188077086902****_BXSuW61e</InstanceId>\\n <TagKey>CartService</TagKey>\\n <ResourceType>ALIYUN::MQ::TOPIC</ResourceType>\\n <TagValue>ServiceA</TagValue>\\n</TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + 'title' => 'ListTagResources', + 'summary' => 'Queries the tags that are attached to a specified resource.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'When you call the **ListTagResources** operation, specify at least one of the following parameters in the request: **Key** and **ResourceId**. You can specify a resource ID to query all tags that are attached to the specified resource. You can also specify a tag key to query the tag value and resource to which the tag is attached.'."\n" + ."\n" + .'* If you include the **Key** parameter in a request, you can obtain the tag value and the ID of the resource to which the tag is attached.'."\n" + .'* If you include the **ResourceId** parameter in a request, you can obtain the keys and values of all tags that are attached to the specified resource.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Query resource tags in the console'."\n" + ."\n" + .'You can also query the tags that are attached to a resource in the ApsaraMQ for RocketMQ console.**** For more information, see [Manage tags](~~172713~~).', + ], + 'TagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RocketMQ instance that contains the resource to which you want to attach tags.'."\n" + ."\n" + .'> This parameter is required when you attach tags to a topic or a group.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource to which you want to attach tags. Valid values:'."\n" + ."\n" + .'* **INSTANCE**'."\n" + .'* **TOPIC**'."\n" + .'* **GROUP**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TOPIC', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags that you want to attach to the resource.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key. If you configure this parameter, you must also configure the **Value** parameter.****'."\n" + .'* The value of this parameter cannot be an empty string.'."\n" + .'* A tag key must be 1 to 128 characters in length and cannot contain `http://` or `https://`. A tag key cannot start with `acs:` or `aliyun`.', + 'type' => 'string', + 'required' => true, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => 'The value of the tag that you want to attach to the resource. If you configure this parameter, you must also configure the **Key** parameter.****'."\n" + .'* The value of this parameter can be an empty string.'."\n" + .'* A tag value must be 1 to 128 characters in length and cannot contain `http://` or `https://`. A tag value cannot start with `acs:` or `aliyun`.', + 'type' => 'string', + 'required' => true, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource to which you want to attach a tag.'."\n" + ."\n" + .'* If the resource is a ApsaraMQ for RocketMQ instance, specify the ID of the instance.'."\n" + .'* If the resource is a topic, specify the topic name.'."\n" + .'* If the resource is a group, specify the ID of the group.', + 'type' => 'string', + 'required' => false, + 'example' => 'TopicA', + ], + 'required' => true, + 'example' => 'TopicA', + 'maxItems' => 51, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use the ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '301D2CBE-66F8-403D-AEC0-82582478****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"301D2CBE-66F8-403D-AEC0-82582478****\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\r\\n<RequestId>301D2CBE-66F8-403D-AEC0-82582478****</RequestId>\\r\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => 'TagResources', + 'summary' => 'Adds tags to a resource.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'You can call this operation to attach tags to a source. You can use tags to classify resources in ApsaraMQ for RocketMQ. This can help you aggregate and search resources in an efficient manner.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Attach tags to a resource in the console'."\n" + ."\n" + .'You can also attach tags to a resource in the ApsaraMQ for RocketMQ console.**** For more information, see [Manage tags](~~172713~~).', + ], + 'UntagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is required when you detach tags from a topic or a group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'MQ_INST_188077086902****_BX4jvZZG', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource from which you want to detach tags. Valid values:'."\n" + ."\n" + .'* **INSTANCE**'."\n" + .'* **TOPIC**'."\n" + .'* **GROUP**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TOPIC', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove all tags that are attached to the specified resource. This parameter takes effect only if the **TagKey** parameter is empty. Default value: **false**.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource from which you want to detach tags.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TopicA', + ], + 'required' => true, + 'example' => 'TopicA', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tag keys of the resource.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key.'."\n" + .'* The tag key cannot be an empty string.'."\n" + .'* A tag key must be 1 to 128 characters in length and cannot contain `http://` or `https://`. A tag key cannot start with `acs:` or `aliyun`.', + 'type' => 'string', + 'required' => false, + 'example' => 'CartService', + ], + 'required' => false, + 'example' => 'CartService', + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use the ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '19780F2E-7841-4E0F-A5D9-C64A0530****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"19780F2E-7841-4E0F-A5D9-C64A0530****\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\r\\n<RequestId>19780F2E-7841-4E0F-A5D9-C64A0530****</RequestId>\\r\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => 'UntagResources', + 'summary' => 'Detaches tags from a specified resource and deletes the tags.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Detach and remove tags from a resource in the console'."\n" + ."\n" + .'You can also detach and remove tags from a resource in the ApsaraMQ for RocketMQ console.**** For more information, see [Manage tags](~~172713~~).', + ], + 'OnsConsumerStatus' => [ + 'summary' => 'Queries the detailed information about the status of a specified consumer group. This operation returns the transactions per second (TPS) for message consumption, load balancing status, consumer connection status, and whether all consumers in the consumer group subscribe to the same topics and tags.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREons0MOUAZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group whose details you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_group_id', + ], + ], + [ + 'name' => 'Detail', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query the details of the consumer group. Valid values:'."\n" + ."\n" + .'* **true**: The details of the consumer group are queried. You can obtain details from the **ConsumerConnectionInfoList** and **DetailInTopicList** response parameters.'."\n" + .'* **false**: The details of the consumer group are not queried. The values of the **ConsumerConnectionInfoList** and **DetailInTopicList** response parameters are empty. This value is the default value of the Detail parameter.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'NeedJstack', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query the information about thread stack traces. Valid values:'."\n" + ."\n" + .'* **true**: The information about thread stack traces is queried. You can obtain the information from the **Jstack** response parameter.'."\n" + ."\n" + .'> If you want to obtain the information about thread stack traces, make sure that the **Detail** parameter in the request is set to **true**.'."\n" + ."\n" + .'* **false**: The information about thread stack traces is not queried. The value of the **Jstack** response parameter is empty. This value is the default value of the NeedJstack parameter.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the consumer group belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '10EDC518-10E7-4B34-92FB-171235FA****', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConsumeTps' => [ + 'description' => 'The TPS for message consumption.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ConsumeModel' => [ + 'description' => 'The consumption mode. Valid values:'."\n" + ."\n" + .'* **CLUSTERING**: the clustering consumption mode'."\n" + .'* **BROADCASTING**: the broadcasting consumption mode'."\n" + ."\n" + .'For more information about consumption modes, see [Clustering consumption and broadcasting consumption](~~43163~~).'."\n", + 'type' => 'string', + 'example' => 'CLUSTERING', + ], + 'ConnectionSet' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConnectionDo' => [ + 'description' => 'The information about online consumers in the consumer group.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RemoteIP' => [ + 'description' => 'The private or public IP address of the host.'."\n", + 'type' => 'string', + 'example' => '42.120.74.**', + ], + 'Version' => [ + 'description' => 'The version of the consumer client.'."\n", + 'type' => 'string', + 'example' => 'V4_3_6_SNAPSHOT', + ], + 'ClientAddr' => [ + 'description' => 'The IP address and port number of the consumer instance.'."\n", + 'type' => 'string', + 'example' => '30.5.121.**', + ], + 'Language' => [ + 'description' => 'The programming language in which the consumer is developed.'."\n", + 'type' => 'string', + 'example' => 'JAVA', + ], + 'ClientId' => [ + 'description' => 'The ID of the consumer instance.'."\n", + 'type' => 'string', + 'example' => '30.5.121.**@25560#-1999745829#-1737591554#458773089270275', + ], + 'Diff' => [ + 'title' => '每个客户端的堆积数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + ], + ], + 'TotalDiff' => [ + 'description' => 'The total number of accumulated messages.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '197', + ], + 'ConsumerConnectionInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConsumerConnectionInfoDo' => [ + 'description' => 'The details of online consumers in the consumer group, including the information about the thread stack traces and the consumption response time (RT). If you want to obtain the details of online consumers in the consumer group, make sure that the **Detail** parameter in the request is set to **true**. If the Detail parameter is not set to true, the value of this parameter is empty.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ConsumeModel' => [ + 'description' => 'The consumption mode. Valid values:'."\n" + ."\n" + .'* **CLUSTERING**: the clustering consumption mode'."\n" + .'* **BROADCASTING**: the broadcasting consumption mode'."\n" + ."\n" + .'For more information about consumption modes, see [Clustering consumption and broadcasting consumption](~~43163~~).'."\n", + 'type' => 'string', + 'example' => 'CLUSTERING', + ], + 'RunningDataList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConsumerRunningDataDo' => [ + 'description' => 'The real-time statistics.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Rt' => [ + 'description' => 'The consumption RT. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Topic' => [ + 'description' => 'The name of the topic to which the consumer subscribes.'."\n", + 'type' => 'string', + 'example' => 'test-mq_topic', + ], + 'FailedCountPerHour' => [ + 'description' => 'The number of messages that failed to be consumed each hour.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'OkTps' => [ + 'description' => 'The TPS for successful message consumption.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'FailedTps' => [ + 'description' => 'The TPS for failed message consumption.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'SubscriptionSet' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubscriptionData' => [ + 'description' => 'The information about subscriptions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SubString' => [ + 'description' => 'The expression that is used to specify the tags of messages in the subscribed topic.'."\n", + 'type' => 'string', + 'example' => '*', + ], + 'SubVersion' => [ + 'description' => 'The subscription version. The value is of the LONG type and is automatically incremented.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570701364301', + ], + 'Topic' => [ + 'description' => 'The name of the topic to which the consumer subscribes.'."\n", + 'type' => 'string', + 'example' => 'test-mq_topic', + ], + 'TagsSet' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The information about the tags of the topic to which the consumer subscribes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the tags of the topic to which the consumer subscribes.'."\n", + 'type' => 'string', + 'example' => 'ff', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Jstack' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ThreadTrackDo' => [ + 'description' => 'The information about thread stack traces. If you want to obtain the information about thread stack traces, make sure that the **NeedJstack** parameter in the request is set to **true**. If the NeedJstack parameter is not set to true, the value of this parameter is empty.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TrackList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Track' => [ + 'description' => 'The details of thread stack traces.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of thread stack traces.'."\n", + 'type' => 'string', + 'example' => 'TID: 52 STATE: WAITING', + ], + ], + ], + ], + 'Thread' => [ + 'description' => 'The name of the thread.'."\n", + 'type' => 'string', + 'example' => 'ConsumeMessageThread_0', + ], + ], + ], + ], + ], + ], + 'LastTimeStamp' => [ + 'description' => 'The most recent point in time when a message was consumed.'."\n" + ."\n" + .'The value of this parameter is a UNIX timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570701368114', + ], + 'StartTimeStamp' => [ + 'description' => 'The earliest point in time when a message was consumed.'."\n" + ."\n" + .'The value of this parameter is a UNIX timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570701361528', + ], + 'Language' => [ + 'description' => 'The programming language that the consumer supports.'."\n", + 'type' => 'string', + 'example' => 'JAVA', + ], + 'ClientId' => [ + 'description' => 'The ID of the consumer instance.'."\n", + 'type' => 'string', + 'example' => '30.5.**.**@25560#-1999745829#-1737591554#458773089270275', + ], + 'Connection' => [ + 'description' => 'The connection information.'."\n", + 'type' => 'string', + 'example' => '**', + ], + 'Version' => [ + 'description' => 'The version of the consumer client.'."\n", + 'type' => 'string', + 'example' => 'V4_3_6', + ], + 'ConsumeType' => [ + 'description' => 'The mode in which the consumer consumes messages. Valid values:'."\n" + ."\n" + .'* **PUSH**: The ApsaraMQ for RocketMQ broker pushes messages to the consumer.'."\n" + .'* **PULL**: The consumer pulls messages from the ApsaraMQ for RocketMQ broker.', + 'type' => 'string', + 'example' => 'PUSH', + ], + 'ThreadCount' => [ + 'description' => 'The number of consumer threads.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + 'DetailInTopicList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DetailInTopicDo' => [ + 'description' => 'The information about message consumption by topic. If you want to obtain the information about the consumption status of each topic, make sure that the **Detail** parameter in the request is set to **true**. If the Detail parameter is not set to true, the value of this parameter is empty.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DelayTime' => [ + 'description' => 'The latency of message consumption in the topic. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalDiff' => [ + 'description' => 'The number of accumulated messages in the topic.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'LastTimestamp' => [ + 'description' => 'The most recent point in time when a message was consumed.'."\n" + ."\n" + .'The value of this parameter is a UNIX timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570701259403', + ], + 'Topic' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'example' => 'test-mq_topic', + ], + ], + ], + ], + ], + ], + 'SubscriptionSame' => [ + 'description' => 'Indicates whether all consumers in the consumer group subscribe to the same topics and tags.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DelayTime' => [ + 'description' => 'The maximum latency of message consumption in all topics to which the consumer group subscribes. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100857', + ], + 'LastTimestamp' => [ + 'description' => 'The most recent point in time when a message was consumed.'."\n" + ."\n" + .'The value of this parameter is a UNIX timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1566883844954', + ], + 'Online' => [ + 'description' => 'Indicates whether the consumer group is online.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RebalanceOK' => [ + 'description' => 'Indicates whether load balancing is performed as expected. Valid values:'."\n" + ."\n" + .'* **true**: Load balancing is performed as expected.'."\n" + .'* **false**: Load balancing is not performed as expected.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"10EDC518-10E7-4B34-92FB-171235FA****\\",\\n \\"Data\\": {\\n \\"ConsumeTps\\": 0,\\n \\"ConsumeModel\\": \\"CLUSTERING\\",\\n \\"ConnectionSet\\": {\\n \\"ConnectionDo\\": [\\n {\\n \\"RemoteIP\\": \\"42.120.74.**\\",\\n \\"Version\\": \\"V4_3_6_SNAPSHOT\\",\\n \\"ClientAddr\\": \\"30.5.121.**\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"ClientId\\": \\"30.5.121.**@25560#-1999745829#-1737591554#458773089270275\\",\\n \\"Diff\\": 100\\n }\\n ]\\n },\\n \\"TotalDiff\\": 197,\\n \\"ConsumerConnectionInfoList\\": {\\n \\"ConsumerConnectionInfoDo\\": [\\n {\\n \\"ConsumeModel\\": \\"CLUSTERING\\",\\n \\"RunningDataList\\": {\\n \\"ConsumerRunningDataDo\\": [\\n {\\n \\"Rt\\": 0,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"FailedCountPerHour\\": 0,\\n \\"OkTps\\": 0,\\n \\"FailedTps\\": 0\\n }\\n ]\\n },\\n \\"SubscriptionSet\\": {\\n \\"SubscriptionData\\": [\\n {\\n \\"SubString\\": \\"*\\",\\n \\"SubVersion\\": 1570701364301,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"TagsSet\\": {\\n \\"Tag\\": [\\n \\"ff\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"Jstack\\": {\\n \\"ThreadTrackDo\\": [\\n {\\n \\"TrackList\\": {\\n \\"Track\\": [\\n \\"TID: 52 STATE: WAITING\\"\\n ]\\n },\\n \\"Thread\\": \\"ConsumeMessageThread_0\\"\\n }\\n ]\\n },\\n \\"LastTimeStamp\\": 1570701368114,\\n \\"StartTimeStamp\\": 1570701361528,\\n \\"Language\\": \\"JAVA\\",\\n \\"ClientId\\": \\"30.5.**.**@25560#-1999745829#-1737591554#458773089270275\\",\\n \\"Connection\\": \\"**\\",\\n \\"Version\\": \\"V4_3_6\\",\\n \\"ConsumeType\\": \\"PUSH\\",\\n \\"ThreadCount\\": 20\\n }\\n ]\\n },\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"DetailInTopicList\\": {\\n \\"DetailInTopicDo\\": [\\n {\\n \\"DelayTime\\": 0,\\n \\"TotalDiff\\": 0,\\n \\"LastTimestamp\\": 1570701259403,\\n \\"Topic\\": \\"test-mq_topic\\"\\n }\\n ]\\n },\\n \\"SubscriptionSame\\": true,\\n \\"DelayTime\\": 100857,\\n \\"LastTimestamp\\": 1566883844954,\\n \\"Online\\": true,\\n \\"RebalanceOK\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsConsumerStatusResponse>\\n<data>\\n <connectionSet>\\n <bizVersion>V4_3_6</bizVersion>\\n <clientAddr>30.5.***.*</clientAddr>\\n <clientId>30.5.***.*@97730#-1999745829#-1737591554#729272961762836</clientId>\\n <language>JAVA</language>\\n <version>V4_3_6</version>\\n </connectionSet>\\n <consumeModel>CLUSTERING</consumeModel>\\n <consumeTps>0</consumeTps>\\n <consumerConnectionInfoList>\\n <bizVersion>V4_3_6</bizVersion>\\n <clientId>30.5.***.*@97730#-1999745829#-1737591554#729272961762836</clientId>\\n <consumeType>PUSH</consumeType>\\n <jstack>\\n <thread>ConsumeMessageThread_4</thread>\\n <trackList>TID: 44 STATE: WAITING</trackList>\\n <trackList>sun.misc.Unsafe.park(Native Method)</trackList>\\n <trackList>java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)</trackList>\\n <trackList>java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject.await(AbstractQueuedSynchronizer.java:2039)</trackList>\\n <trackList>java.util.concurrent.LinkedBlockingQueue.take(LinkedBlockingQueue.java:442)</trackList>\\n <trackList>java.util.concurrent.ThreadPoolExecutor.getTask(ThreadPoolExecutor.java:1074)</trackList>\\n <trackList>java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1134)</trackList>\\n <trackList>java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)</trackList>\\n <trackList>java.lang.Thread.run(Thread.java:748)</trackList>\\n </jstack>\\n <language>JAVA</language>\\n <lastTimeStamp>1570701368114</lastTimeStamp>\\n <runningDataList>\\n <failedCountPerHour>0</failedCountPerHour>\\n <failedTps>0</failedTps>\\n <okTps>0</okTps>\\n <rt>0</rt>\\n <topic>test-mq_topic</topic>\\n </runningDataList>\\n <startTimeStamp>1570701361528</startTimeStamp>\\n <subscriptionSet>\\n <subString>*</subString>\\n <subVersion>1570701364301</subVersion>\\n <topic>test-mq_topic</topic>\\n </subscriptionSet>\\n <threadCount>20</threadCount>\\n <version>V4_3_6</version>\\n </consumerConnectionInfoList>\\n <delayTime>0</delayTime>\\n <detailInTopicList>\\n <delayTime>0</delayTime>\\n <lastTimestamp>1570701259403</lastTimestamp>\\n <topic>test-mq_topic</topic>\\n <totalDiff>0</totalDiff>\\n </detailInTopicList>\\n <instanceId>MQ_INST_111111111111_DOxxxxxx</instanceId>\\n <lastTimestamp>1570701368114</lastTimestamp>\\n <online>true</online>\\n <rebalanceOK>true</rebalanceOK>\\n <subscriptionSame>true</subscriptionSame>\\n <totalDiff>0</totalDiff>\\n</data>\\n<requestId>10EDC518-10E7-4B34-92FB-171235FA****</requestId>\\n</OnsConsumerStatusResponse>","errorExample":""}]', + 'title' => 'OnsConsumerStatus', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'* You can call this operation in scenarios in which consumers are online and messages are accumulated. You can troubleshoot errors based on the information that is returned by this operation. You can check whether all consumers in the consumer group subscribe to the same topics and tags, and whether load balancing is performed as expected. You can also obtain the information about thread stack traces of online consumers.'."\n" + .'* This operation uses multiple backend operations to query and aggregate data. The system requires a long period of time to process a request. We recommend that you do not frequently call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## View the details of a consumer group in the console'."\n" + ."\n" + .'You can also view the details of a consumer group in the **ApsaraMQ for RocketMQ** console. For more information, see [View the status of consumers](~~94312~~).', + ], + 'OnsConsumerAccumulate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_consumer_id', + ], + ], + [ + 'name' => 'Detail', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query the details of each topic to which the consumer group subscribes. Valid values:'."\n" + ."\n" + .'* **true**: The details of each topic are queried. You can obtain the details from the **DetailInTopicList** response parameter.'."\n" + .'* **false**: The details of each topic are not queried. This is the default value. If you use this value, the value of the **DetailInTopicList** response parameter is empty.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'CE817BFF-B389-43CD-9419-95011AC9****', + ], + 'Data' => [ + 'description' => 'The message accumulation information about topics to which the specified consumer subscribes.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConsumeTps' => [ + 'description' => 'The transactions per second (TPS) for message consumption performed by consumers in the group.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'DelayTime' => [ + 'description' => 'The consumption latency.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'LastTimestamp' => [ + 'description' => 'The point in time when the latest message consumed by a consumer in the consumer group was produced.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1566231000000', + ], + 'TotalDiff' => [ + 'description' => 'The total number of accumulated messages in all topics to which the consumer group subscribes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Online' => [ + 'description' => 'Indicates whether the consumer group is online. The consumer group is online if one of the consumers in the group is online. Valid values:'."\n" + ."\n" + .'* **true**: The consumer group is online.'."\n" + .'* **false**: The consumer group is offline.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DetailInTopicList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DetailInTopicDo' => [ + 'description' => 'The information about each topic to which the consumer group subscribes. If the **Detail** parameter in the request is set to **false**, the value of this parameter is empty.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DelayTime' => [ + 'description' => 'The maximum latency of message consumption in the topic.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'TotalDiff' => [ + 'description' => 'The number of accumulated messages in the topic.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'LastTimestamp' => [ + 'description' => 'The point in time when the latest consumed message in the topic was produced.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1566231000000', + ], + 'Topic' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'example' => 'test-mq-topic', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CE817BFF-B389-43CD-9419-95011AC9****\\",\\n \\"Data\\": {\\n \\"ConsumeTps\\": 10,\\n \\"DelayTime\\": 10000,\\n \\"LastTimestamp\\": 1566231000000,\\n \\"TotalDiff\\": 100,\\n \\"Online\\": true,\\n \\"DetailInTopicList\\": {\\n \\"DetailInTopicDo\\": [\\n {\\n \\"DelayTime\\": 10000,\\n \\"TotalDiff\\": 100,\\n \\"LastTimestamp\\": 1566231000000,\\n \\"Topic\\": \\"test-mq-topic\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsConsumerAccumulateResponse>\\n<Data>\\n <DetailInTopicList>\\n <DetailInTopicDo>\\n <TotalDiff>100</TotalDiff>\\n <LastTimestamp>1566231000000</LastTimestamp>\\n <DelayTime>10000</DelayTime>\\n <Topic>test-mq-topic</Topic>\\n </DetailInTopicDo>\\n </DetailInTopicList>\\n <TotalDiff>100</TotalDiff>\\n <LastTimestamp>1566231000000</LastTimestamp>\\n <DelayTime>10000</DelayTime>\\n <Online>true</Online>\\n <ConsumeTps>10</ConsumeTps>\\n</Data>\\n<RequestId>0CCF6437-CBB0-4378-BFEC-E08AC258****</RequestId>\\n</OnsConsumerAccumulateResponse>","errorExample":""}]', + 'title' => 'OnsConsumerAccumulate', + 'summary' => 'Queries the information about message accumulation in topics to which a specified consumer group subscribes. The returned information includes the number of accumulated messages and the consumption latency.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'You can call this operation in scenarios in which you want to know the message consumption progress of a specified consumer group in production environments. You can obtain the information about message consumption and consumption latency based on the returned information. This operation returns the total number of accumulated messages in all topics to which the specified consumer group subscribes and the number of accumulated messages in each topic.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## View the information about message accumulation in the console'."\n" + ."\n" + .'You can also view the information about message accumulation in topics to which a consumer group subscribes in the **ApsaraMQ for RocketMQ** console. For more information, see [View the status of consumers](~~94312~~).', + ], + 'OnsConsumerGetConnection' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '14917', + 'abilityTreeNodes' => [ + 'FEATUREons0MOUAZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group whose client connection status you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_consumer_id', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the consumer group belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'DE4140C7-F42D-473D-A5FF-B1E31692****', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConnectionList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConnectionDo' => [ + 'description' => 'The client connection information of the consumer group.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => 'The version of the consumer client.'."\n", + 'type' => 'string', + 'example' => 'V4_3_6', + ], + 'ClientAddr' => [ + 'description' => 'The IP address and port number of the consumer client.'."\n", + 'type' => 'string', + 'example' => '30.5.121.**', + ], + 'Language' => [ + 'description' => 'The programming language in which the consumer application was developed.'."\n", + 'type' => 'string', + 'example' => 'JAVA', + ], + 'ClientId' => [ + 'description' => 'The ID of the consumer client.'."\n", + 'type' => 'string', + 'example' => '30.5.121.**@24813#-1999745829#-1737591554#453111174894656', + ], + ], + ], + ], + ], + ], + 'MessageModel' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DE4140C7-F42D-473D-A5FF-B1E31692****\\",\\n \\"Data\\": {\\n \\"ConnectionList\\": {\\n \\"ConnectionDo\\": [\\n {\\n \\"Version\\": \\"V4_3_6\\",\\n \\"ClientAddr\\": \\"30.5.121.**\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"ClientId\\": \\"30.5.121.**@24813#-1999745829#-1737591554#453111174894656\\"\\n }\\n ]\\n },\\n \\"MessageModel\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsConsumerGetConnectionResponse>\\r\\n <Data>\\r\\n <ConnectionList>\\r\\n <ConnectionDo>\\r\\n <ClientAddr>30.5.121.**</ClientAddr>\\r\\n <Language>JAVA</Language>\\r\\n <Version>V4_3_6</Version>\\r\\n <ClientId>30.5.121.**@24813#-1999745829#-1737591554#453111174894656</ClientId>\\r\\n </ConnectionDo>\\r\\n </ConnectionList>\\r\\n </Data>\\r\\n <RequestId>DE4140C7-F42D-473D-A5FF-B1E31692****</RequestId>\\r\\n</OnsConsumerGetConnectionResponse>","errorExample":""}]', + 'title' => 'OnsConsumerGetConnection', + 'summary' => 'Queries the client connection status of a specified consumer group.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'When messages are accumulated in a topic, you can call this operation to check whether a consumer is online.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## View the client connection status of a consumer group in the console'."\n" + ."\n" + .'You can also view the client connection status of a specific consumer group in the ApsaraMQ for RocketMQ console.**** For more information, see [View the status of consumers](~~94312~~).', + ], + 'OnsConsumerResetOffset' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group whose dead-letter message you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_consumer_id', + ], + ], + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the topic for which you want to reset the consumer offset.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-mq-topic', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method that you want to use to clear accumulated messages. Valid values:'."\n" + ."\n" + .'* **0:** All accumulated messages are cleared. Messages that are not consumed are ignored. Consumers in the specified consumer group consume only messages that are published to the topic after the specified point in time.'."\n" + ."\n" + .'If "reconsumeLater" is returned, the accumulated messages are not cleared because the system is retrying to resend the messages to consumers.'."\n" + ."\n" + .'* **1:** The messages that were published to the topic before the specified point in time are cleared. You must specify a point in time. Consumers in the specified consumer group consume only the messages that are published to the topic after the specified point in time.'."\n" + ."\n" + .'You can specify a point in time from the earliest point in time when a message was published to the topic to the most recent point in time when a message was published to the topic. Points in time that are not within the allowed time range are invalid.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ResetTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp to which you want to reset the consumer offset. This parameter takes effect only when the **Type** parameter is set to **1**. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1591153871000', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the consumer group belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'D52C68F8-EC5D-4294-BFFF-1A6A25AF****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D52C68F8-EC5D-4294-BFFF-1A6A25AF****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsConsumerResetOffsetResponse>\\r\\n <RequestId>D52C68F8-EC5D-4294-BFFF-1A6A25AF****</RequestId>\\r\\n</OnsConsumerResetOffsetResponse>","errorExample":""}]', + 'title' => 'OnsConsumerResetOffset', + 'summary' => 'Resets a consumer offset to a specified timestamp for a consumer group.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'You can call this operation to clear accumulated messages or reset a consumer offset to a specified timestamp. You can use one of the following methods to clear accumulated messages:'."\n" + ."\n" + .'* Clear all accumulated messages in a specified topic.'."\n" + .'* Clear the messages that were published to the specified topic before a specified point in time.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Reset the consumer offset of a consumer group in the console'."\n" + ."\n" + .'You can also reset the consumer offset for a consumer group in the ApsaraMQ for RocketMQ console.**** For more information, see [Reset consumer offsets](~~63390~~).', + ], + 'OnsConsumerTimeSpan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group whose reset time range you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_group_id', + ], + ], + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The topic to which the consumer group subscribes.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-mq_topic', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the consumer group belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'A07E3902-B92E-44A6-B6C5-6AA111111****', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxTimeStamp' => [ + 'description' => 'The point in time when the most recently stored message was published to the topic.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570761026804', + ], + 'ConsumeTimeStamp' => [ + 'description' => 'The most recent point in time when a message in the topic was consumed by the customer group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570761026400', + ], + 'Topic' => [ + 'description' => 'The name of the topic that you want to query.'."\n", + 'type' => 'string', + 'example' => 'test-mq_topic', + ], + 'MinTimeStamp' => [ + 'description' => 'The point in time when the earliest stored message was published to the topic.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570701231122', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance to which the consumer group belongs.'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A07E3902-B92E-44A6-B6C5-6AA111111****\\",\\n \\"Data\\": {\\n \\"MaxTimeStamp\\": 1570761026804,\\n \\"ConsumeTimeStamp\\": 1570761026400,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"MinTimeStamp\\": 1570701231122,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsConsumerTimeSpanResponse>\\n<Data>\\n <MinTimeStamp>1570701231122</MinTimeStamp>\\n <ConsumeTimeStamp>1570761026400</ConsumeTimeStamp>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <Topic>test-mq_topic</Topic>\\n <MaxTimeStamp>1570761026804</MaxTimeStamp>\\n</Data>\\n<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>\\n</OnsConsumerTimeSpanResponse>","errorExample":""}]', + 'title' => 'OnsConsumerTimeSpan', + 'summary' => 'Queries the time range within which you can specify a point in time to reset the consumer offset for a specified topic. The time range is from the point in time when the earliest stored message was published to the topic to the point in time when the most recently stored message was published to the topic.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'You can call this operation to query the point in time when the earliest stored message was published to a specified topic and the point in time when the most recently stored message was published to the specified topic. You can also call this operation to query the most recent point in time when a message in the topic was consumed. This operation is usually used with the \\*\\*OnsConsumerAccumulate\\*\\* operation to display the overview of the consumption progress.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OnsMessagePush' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group. For information about what a consumer group is, see [Terms](~~29533~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_group_id', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer client. You can call the [OnsConsumerGetConnection](~~29598~~) operation to query client IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '30.5.121.**@24813#-1999745829#-1737591554#453111174894656', + ], + ], + [ + 'name' => 'MsgId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0BC1669963053CF68F733BB70396****', + ], + ], + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The topic to which the message is pushed.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-mq_topic', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RocketMQ instance to which the specified consumer group belongs.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'B8EDC90D-F726-4B9E-8BEF-F0DD25EC****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B8EDC90D-F726-4B9E-8BEF-F0DD25EC****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsMessagePushResponse>\\n <RequestId>B8EDC90D-F726-4B9E-8BEF-F0DD25EC****</RequestId>\\n</OnsMessagePushResponse>","errorExample":""}]', + 'title' => 'OnsMessagePush', + 'summary' => 'Pushes a message to a specified consumer.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'This operation can be used to check whether messages in a specified topic can be consumed by consumers in a specified consumer group. This operation obtains the body of the message that is specified by the MsgId parameter, re-encapsulates the message body to produce a new message, and then pushes the new message to a specified consumer. The content of the message that is sent to the consumer is the same as the content of the original message. They are not the same message because they use different message IDs.'."\n", + ], + 'OnsTrendTopicInputTps' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the topic that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp that indicates the beginning of the time range to query. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1570852800000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp that indicates the end of the time range to query. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1570868400000', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of information that you want to query. Valid values:'."\n" + ."\n" + .'* **0**: the number of messages that are published to the topic during each sampling period.'."\n" + .'* **1**: the TPS for message publishing in the topic during each sampling period.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the topic you want to query belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sampling period. Unit: minutes. Valid values: 1, 5, and 10.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use the ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'E213AD8A-0730-4B3D-A35A-340DA47D****', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StatsDataDo' => [ + 'description' => 'The data set returned based on sampling period.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Y' => [ + 'description' => 'The Y axis. This parameter indicates the TPS for message publishing or the number of messages that are published.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'X' => [ + 'description' => 'The X axis. The value of this parameter is a UNIX timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570852800000', + ], + ], + ], + ], + ], + ], + 'XUnit' => [ + 'description' => 'The unit of the timestamp.'."\n", + 'type' => 'string', + 'example' => 'time', + ], + 'YUnit' => [ + 'description' => 'The unit of the Y axis.'."\n", + 'type' => 'string', + 'example' => 'msg', + ], + 'Title' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'example' => 'MQ_INST\\_111111111111\\_DOxxxxxx%test trend of received messages'."\n", + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E213AD8A-0730-4B3D-A35A-340DA47D****\\",\\n \\"Data\\": {\\n \\"Records\\": {\\n \\"StatsDataDo\\": [\\n {\\n \\"Y\\": 0,\\n \\"X\\": 1570852800000\\n }\\n ]\\n },\\n \\"XUnit\\": \\"ms\\",\\n \\"YUnit\\": \\"msg\\",\\n \\"Title\\": \\"TopicXXX Send Trend Chart\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsTrendTopicInputTpsResponse>\\n<Data>\\n <Records>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570852800000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570853400000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570854000000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570854600000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570860600000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570861200000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570861800000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570862400000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570863000000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570863600000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570864200000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>1</Y>\\n <X>1570864800000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570865400000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570866000000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570866600000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570867200000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570867800000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570868400000</X>\\n </StatsDataDo>\\n </Records>\\n <XUnit>time</XUnit>\\n <YUnit>msg</YUnit>\\n <Title>MQ_INST_111111111111_DOxxxxxx%test-mq_topic接收总量趋势图</Title>\\n</Data>\\n<RequestId>E213AD8A-0730-4B3D-A35A-340DA47D****</RequestId>\\n</OnsTrendTopicInputTpsResponse>","errorExample":""}]', + 'title' => 'OnsTrendTopicInputTps', + 'summary' => 'Queries the statistics about messages that are published to a topic within a period of time.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'You can call this operation to query the statistics of messages that are published to a specific topic in a production environment. You can query the number of messages that are published to the topic or the transactions per second (TPS) for message publishing within a specified time range based on your business requirements.'."\n" + ."\n" + .'If your application publishes a small number of messages and does not publish messages at specific intervals, we recommend that you query the number of messages that are published to the topic during each sampling period because the statistics of TPS may not show a clear change trend.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Query the statistics about messages published to a topic in the console'."\n" + ."\n" + .'You can view the statistics of the messages that are published to a topic in the ApsaraMQ for RocketMQ console.**** For more information, see [Dashboard](~~288246~~).', + ], + 'OnsTrendGroupOutputTps' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test', + ], + ], + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the topic that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp that indicates the beginning of the time range to query. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1570852800000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp that indicates the end of the time range to query. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1570868400000', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of information that you want to query. Valid values:'."\n" + ."\n" + .'* **0**: the number of messages that are consumed during each sampling period.'."\n" + .'* **1**: the TPS for message consumption during each sampling period.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the consumer group you want to query belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sampling period. Unit: minutes. Valid values: 1, 5, and 10.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use the ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'CE57AEDC-8FD2-43ED-8E3B-1F878077****', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StatsDataDo' => [ + 'description' => 'The data set returned based on sampling period.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Y' => [ + 'description' => 'The Y axis. This parameter indicates the TPS for message consumption or the number of messages that are consumed.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'X' => [ + 'description' => 'The X axis. The value of this parameter is a UNIX timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570867800000', + ], + ], + ], + ], + ], + ], + 'XUnit' => [ + 'description' => 'The unit of the timestamp.'."\n", + 'type' => 'string', + 'example' => 'time', + ], + 'YUnit' => [ + 'description' => 'The total number of messages.'."\n", + 'type' => 'string', + 'example' => 'msg', + ], + 'Title' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'example' => 'MQ_INST\\_111111111111\\_DOxxxxxx%test@MQ_INST\\_111111111111\\_DOxxxxxx%GID_test trend chart of delivered messages'."\n", + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CE57AEDC-8FD2-43ED-8E3B-1F878077****\\",\\n \\"Data\\": {\\n \\"Records\\": {\\n \\"StatsDataDo\\": [\\n {\\n \\"Y\\": 0,\\n \\"X\\": 1570867800000\\n }\\n ]\\n },\\n \\"XUnit\\": \\"ms\\",\\n \\"YUnit\\": \\"msg\\",\\n \\"Title\\": \\"TopicXXX@GID_XXXReceive Trend Chart\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsTrendGroupOutputTpsResponse>\\n<Data>\\n <Records>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570852800000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570853400000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570854000000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570854600000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570855200000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570860600000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570861200000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570861800000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570862400000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570863000000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570863600000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570864200000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>1</Y>\\n <X>1570864800000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570865400000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570866000000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570866600000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570867200000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570867800000</X>\\n </StatsDataDo>\\n <StatsDataDo>\\n <Y>0</Y>\\n <X>1570868400000</X>\\n </StatsDataDo>\\n </Records>\\n <XUnit>time</XUnit>\\n <YUnit>数量</YUnit>\\n <Title>MQ_INST_111111111111_DOxxxxxx%test@MQ_INST_111111111111_DOxxxxxx%GID_test投递总量趋势图</Title>\\n</Data>\\n<RequestId>CE57AEDC-8FD2-43ED-8E3B-1F878077****</RequestId>\\n</OnsTrendGroupOutputTpsResponse>","errorExample":""}]', + 'title' => 'OnsTrendGroupOutputTps', + 'summary' => 'Queries the statistics about messages that are consumed by a consumer group within a specific period of time.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'You can call this operation to query the following statistics that are collected in a production environment:'."\n" + ."\n" + .'* The number of messages that are consumed during each sampling period'."\n" + .'* The transactions per second (TPS) for message consumption during each sampling period'."\n" + ."\n" + .'If your application consumes a small number of messages and does not consume messages at specific intervals, we recommend that you query the number of messages that are consumed during each sampling period because the statistics of TPS may not show a clear change trend.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## View the statistics about message consumption in the console'."\n" + ."\n" + .'You can also view the statistics about message consumption by consumers in a consumer group in the ApsaraMQ for RocketMQ console.**** For more information, see [Dashboard](~~288246~~).', + ], + 'OnsTraceQueryByMsgId' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The topic that contains the message you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'MsgId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the message that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1E05791C117818B4AAC23B1BB0CE****', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1570852800000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1570968000000', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RocketMQ instance that contains the specified topic.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'B93332A3-160D-404F-880F-1F8736D1****', + ], + 'QueryId' => [ + 'description' => 'The ID of the query task. You can call the [OnsTraceGetResult](~~59832~~) operation to query the details of the message trace based on the task ID.'."\n", + 'type' => 'string', + 'example' => '272967562652883649157096685****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B93332A3-160D-404F-880F-1F8736D1****\\",\\n \\"QueryId\\": \\"272967562652883649157096685****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsTraceQueryByMsgIdResponse>\\n<RequestId>B93332A3-160D-404F-880F-1F8736D1039F</RequestId>\\n<QueryId>272967562652883649157096685****</QueryId>\\n</OnsTraceQueryByMsgIdResponse>","errorExample":""}]', + 'title' => 'OnsTraceQueryByMsgId', + 'summary' => 'Creates a task to query the trace of a message based on the message ID and the name of the topic in which the message is stored. The task ID is returned.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'If you want to query the trace of a message based on the message ID, you can call this operation to create a query task. After you obtain the task ID, you can call the [OnsTraceGetResult](~~59832~~) operation to query the details of the message trace based on the task ID.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Create a task to query a message trace in the console'."\n" + ."\n" + .'You can also create a task to query the trace of a message in the ApsaraMQ for RocketMQ console.**** For more information, see [Query a message](~~29540~~).', + ], + 'OnsTraceQueryByMsgKey' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The topic that contains the message you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'MsgKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the message that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ORDERID_100', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1570852800000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1570968000000', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RocketMQ instance that contains the specified topic.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'F8654231-122A-4DBD-801F-38E35538****', + ], + 'QueryId' => [ + 'description' => 'The ID of the query task. You can call the [OnsTraceGetResult](~~59832~~) operation to query the details of the message trace based on the task ID.'."\n", + 'type' => 'string', + 'example' => '272967562652883649157096685****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F8654231-122A-4DBD-801F-38E35538****\\",\\n \\"QueryId\\": \\"272967562652883649157096685****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsTraceQueryByMsgKeyResponse>\\n<RequestId>F8654231-122A-4DBD-801F-38E35538****</RequestId>\\n<QueryId>272967562652883649157096685****</QueryId>\\n</OnsTraceQueryByMsgKeyResponse>","errorExample":""}]', + 'title' => 'OnsTraceQueryByMsgKey', + 'summary' => 'Creates a trace query task based on the topic name and message key and obtains the ID of the query task.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'If you want to query the trace of a message based on the message key that you obtained, you can call this operation to create a query task. After you obtain the task ID, you can call the OnsTraceGetResult operation to query the details of the message trace based on the task ID.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Create a task to query the trace of a message in the console'."\n" + ."\n" + .'You can also create a task to query the trace of a message in the ApsaraMQ for RocketMQ console.**** For more information, see [Query a message](~~29540~~).', + ], + 'OnsTraceGetResult' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'QueryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the task that was created to query the trace of the message.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '272967562652883649157096685****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the message you want to query belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The topic to which the message belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '84EE24D2-851F-40D6-B99E-4D6AB909****', + ], + 'TraceData' => [ + 'description' => 'The details of the message trace.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* **finish**: The task is complete.'."\n" + .'* **working**: The task is in progress.'."\n" + .'* **removed**: The task is deleted.'."\n", + 'type' => 'string', + 'example' => 'finish', + ], + 'MsgKey' => [ + 'description' => 'The key of the message that is queried.'."\n", + 'type' => 'string', + 'example' => 'ORDERID_100', + ], + 'UpdateTime' => [ + 'description' => 'The most recent point in time when the task was updated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570966877000', + ], + 'CreateTime' => [ + 'description' => 'The point in time when the task was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570966857000', + ], + 'Topic' => [ + 'description' => 'The topic in which the message is stored.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'UserId' => [ + 'description' => 'The ID of the user who created the task.'."\n", + 'type' => 'string', + 'example' => '27296756265288****', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + 'MsgId' => [ + 'description' => 'The ID of the message that is queried.'."\n", + 'type' => 'string', + 'example' => '1E05791C117818B4AAC23B1BB0CE****', + ], + 'TraceList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TraceMapDo' => [ + 'description' => 'The details of the message trace.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Indicates whether the message is sent. Valid values:'."\n" + ."\n" + .'* **SEND_SUCCESS**: The message is sent.'."\n" + .'* **SEND_FAILED**: The message failed to be sent.'."\n" + .'* **SEND_ROLLBACK:** The message is a transactional message and is rolled back.'."\n" + .'* **SEND_UNKNOWN:** The message is a transactional message and is not committed.'."\n" + .'* **SEND_DELAY:** The message is a scheduled or delayed message and is waiting to be consumed at the specified point in time.'."\n", + 'type' => 'string', + 'example' => 'SEND_SUCCESS', + ], + 'MsgKey' => [ + 'description' => 'The key of the message.'."\n", + 'type' => 'string', + 'example' => 'ORDERID_100', + ], + 'PubTime' => [ + 'description' => 'The point in time when the message was sent.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570850870478', + ], + 'SubList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubMapDo' => [ + 'description' => 'The consumption traces of the message.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClientList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubClientInfoDo' => [ + 'description' => 'The information about message consumption by consumers in the group.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Indicates whether the message is consumed. Valid values:'."\n" + ."\n" + .'* **CONSUME_FAILED**: The message failed to be consumed.'."\n" + .'* **CONSUME_SUCCESS**: The message is consumed.'."\n" + .'* **CONSUME_NOT_RETURN:** No responses are returned.'."\n" + .'* **SEND_UNKNOWN:** The message is a transactional message and is not committed.'."\n" + .'* **SEND_DELAY:** The message is a scheduled or delayed message and is waiting to be consumed at the specified point in time.'."\n", + 'type' => 'string', + 'example' => 'CONSUME_SUCCESS', + ], + 'SubTime' => [ + 'description' => 'The earliest point in time when the message was consumed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570851590511', + ], + 'ReconsumeTimes' => [ + 'description' => 'The number of attempts that the ApsaraMQ for RocketMQ broker tried to send the message to the consumer.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SubGroupName' => [ + 'description' => 'The ID of the group that contains the consumer.'."\n", + 'type' => 'string', + 'example' => 'GID_test', + ], + 'ClientHost' => [ + 'description' => 'The address of the consumer.'."\n", + 'type' => 'string', + 'example' => '30.5.**.**', + ], + 'CostTime' => [ + 'description' => 'The period of time that the system took to consume the message. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '43', + ], + ], + ], + ], + ], + ], + 'FailCount' => [ + 'description' => 'The number of consumption failures.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SubGroupName' => [ + 'description' => 'The ID of the consumer group.'."\n", + 'type' => 'string', + 'example' => 'GID_test', + ], + 'SuccessCount' => [ + 'description' => 'The number of successful consumptions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'Topic' => [ + 'description' => 'The topic to which the message belongs.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'CostTime' => [ + 'description' => 'The period of time that the system took to send the message. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'Tag' => [ + 'description' => 'The tag of the message.'."\n", + 'type' => 'string', + 'example' => 'TagA', + ], + 'MsgId' => [ + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'example' => '0BC1F01800002A9F000000531246****', + ], + 'PubGroupName' => [ + 'description' => 'The ID of the group that contains the producer.'."\n", + 'type' => 'string', + 'example' => 'GID_test', + ], + 'BornHost' => [ + 'description' => 'The address of the producer that generated the message.'."\n", + 'type' => 'string', + 'example' => '30.5.**.**', + ], + ], + ], + ], + ], + ], + 'QueryId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => '272967562652883649157096685****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84EE24D2-851F-40D6-B99E-4D6AB909****\\",\\n \\"TraceData\\": {\\n \\"Status\\": \\"finish\\",\\n \\"MsgKey\\": \\"ORDERID_100\\",\\n \\"UpdateTime\\": 1570966877000,\\n \\"CreateTime\\": 1570966857000,\\n \\"Topic\\": \\"test\\",\\n \\"UserId\\": \\"27296756265288****\\",\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"MsgId\\": \\"1E05791C117818B4AAC23B1BB0CE****\\",\\n \\"TraceList\\": {\\n \\"TraceMapDo\\": [\\n {\\n \\"Status\\": \\"SEND_SUCCESS\\",\\n \\"MsgKey\\": \\"ORDERID_100\\",\\n \\"PubTime\\": 1570850870478,\\n \\"SubList\\": {\\n \\"SubMapDo\\": [\\n {\\n \\"ClientList\\": {\\n \\"SubClientInfoDo\\": [\\n {\\n \\"Status\\": \\"CONSUME_SUCCESS\\",\\n \\"SubTime\\": 1570851590511,\\n \\"ReconsumeTimes\\": 1,\\n \\"SubGroupName\\": \\"GID_test\\",\\n \\"ClientHost\\": \\"30.5.**.**\\",\\n \\"CostTime\\": 43\\n }\\n ]\\n },\\n \\"FailCount\\": 0,\\n \\"SubGroupName\\": \\"GID_test\\",\\n \\"SuccessCount\\": 1\\n }\\n ]\\n },\\n \\"Topic\\": \\"test\\",\\n \\"CostTime\\": 24,\\n \\"Tag\\": \\"TagA\\",\\n \\"MsgId\\": \\"0BC1F01800002A9F000000531246****\\",\\n \\"PubGroupName\\": \\"GID_test\\",\\n \\"BornHost\\": \\"30.5.**.**\\"\\n }\\n ]\\n },\\n \\"QueryId\\": \\"272967562652883649157096685****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsTraceGetResultResponse>\\n<TraceData>\\n <MsgId>1E05791C117818B4AAC23B1BB0CE****</MsgId>\\n <Status>finish</Status>\\n <TraceList>\\n <TraceMapDo>\\n <BornHost>30.5.**.**</BornHost>\\n <MsgId>0BC1F01800002A9F000000531246****</MsgId>\\n <Status>SEND_SUCCESS</Status>\\n <CostTime>24</CostTime>\\n <PubTime>1570850870478</PubTime>\\n <Tag>TagA</Tag>\\n <Topic>test</Topic>\\n <MsgKey>ORDERID_100</MsgKey>\\n <PubGroupName>GID_test</PubGroupName>\\n <SubList>\\n <SubMapDo>\\n <ClientList>\\n <SubClientInfoDo>\\n <Status>CONSUME_SUCCESS</Status>\\n <CostTime>43</CostTime>\\n <ClientHost>30.5.**.**</ClientHost>\\n <ReconsumeTimes>1</ReconsumeTimes>\\n <SubTime>1570851590511</SubTime>\\n <SubGroupName>GID_test</SubGroupName>\\n </SubClientInfoDo>\\n </ClientList>\\n <SuccessCount>1</SuccessCount>\\n <FailCount>0</FailCount>\\n <SubGroupName>GID_test</SubGroupName>\\n </SubMapDo>\\n </SubList>\\n </TraceMapDo>\\n </TraceList>\\n <CreateTime>1570966857000</CreateTime>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <Topic>test</Topic>\\n <UpdateTime>1570966877000</UpdateTime>\\n <QueryId>272967562652883649157096685****</QueryId>\\n <UserId>27296756265288****</UserId>\\n</TraceData>\\n<RequestId>84EE24D2-851F-40D6-B99E-4D6AB909****</RequestId>\\n</OnsTraceGetResultResponse>","errorExample":""}]', + 'title' => 'OnsTraceGetResult', + 'summary' => 'The tracing results are queried by specifying the ID of a trace query task.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'* Before you call this operation to query the details of the trace of a message, you must create a task to query the trace of the message based on the message ID or message key and obtain the task ID. Then, you can call this operation to query the details of the message trace based on the task ID. You can call the [OnsTraceQueryByMsgId](~~445322~~) operation or the [OnsTraceQueryByMsgKey](~~445324~~) operation to create a task to query the trace of the message and obtain the task ID from the **QueryId** response parameter.'."\n" + .'* A trace query task is time-consuming. If you call this operation to query the details immediately after you create a trace query task, the results may be empty. In this case, we recommend that you try again later.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Query the trace of a message in the console'."\n" + ."\n" + .'You can also query the trace of a message in the ApsaraMQ for RocketMQ console.**** For more information, see [Query a message trace](~~43357~~).', + ], + 'OnsDLQMessagePageQueryByGroupId' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group whose dead-letter messages you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_group_id', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds. If you specify a valid value for the **TaskId** parameter in the request, this parameter does not take effect. The system uses the value of the BeginTime parameter that you specified in the request when you created the specified query task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1570723200000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds. If you specify a valid value for the **TaskId** parameter in the request, this parameter does not take effect. The system uses the value of the EndTime parameter that you specified in the request when you created the specified query task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1570809600000', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the query task. The first time you call this operation to query dead-letter messages that are sent to a specified consumer group within a specified time range, this parameter is not required. This parameter is required in subsequent queries for dead-letter messages on a specified page. You can obtain the task ID from the returned result of the first query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0BC1310300002A9F000021E4D7A48346', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1. Valid values: 1 to 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of dead-letter messages to return on each page. Valid values: 5 to 50. Default value: 20. If you specify a valid value for the **TaskId** parameter in the request, this parameter does not take effect. The system uses the value of the PageSize parameter that you specified in the request when you created the specified query task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the dead-letter messages you want to query belong.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'B00CD3C8-D81E-4A41-85E2-38F19252****', + ], + 'MsgFoundDo' => [ + 'description' => 'The information about dead-letter messages that are queried.'."\n", + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MsgFoundList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OnsRestMessageDo' => [ + 'description' => 'The information about dead-letter messages that are returned on the current page. The information that is contained in this parameter is the same as the information that is returned by the [OnsDLQMessageGetById](~~112667~~) operation.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StoreSize' => [ + 'description' => 'The size of the message. Unit: KB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '406', + ], + 'ReconsumeTimes' => [ + 'description' => 'The number of retries that were performed to send the message to consumers.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StoreTimestamp' => [ + 'description' => 'The timestamp that indicates the point in time when the ApsaraMQ for RocketMQ broker stored the message.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570760999811', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + 'MsgId' => [ + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'example' => '1E0578FE110F18B4AAC235C05F2*****', + ], + 'StoreHost' => [ + 'description' => 'The ApsaraMQ for RocketMQ broker that stores the message.', + 'type' => 'string', + 'example' => '11.193.***.***:10911', + ], + 'Topic' => [ + 'description' => 'The topic to which the message belongs.'."\n", + 'type' => 'string', + 'example' => 'test-mq_topic', + ], + 'PropertyList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MessageProperty' => [ + 'description' => 'The attributes of the message.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of the attribute.'."\n", + 'type' => 'string', + 'example' => 'TagA', + ], + 'Name' => [ + 'description' => 'The name of the attribute. Valid values:'."\n" + ."\n" + .'* **TRACE_ON**: indicates whether a trace of the message exists.'."\n" + .'* **KEYS**: indicates the key of the message.'."\n" + .'* **TAGS**: indicates the tag that is attached to the message.'."\n" + .'* **INSTANCE_ID**: indicates the ID of the instance that contains the message.'."\n" + ."\n" + .'For information about the terms that are used in ApsaraMQ for RocketMQ, see [Terms](~~29533~~).', + 'type' => 'string', + 'example' => 'TAGS', + ], + ], + ], + ], + ], + ], + 'BornTimestamp' => [ + 'description' => 'The timestamp that indicates when the message was produced.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570760999721', + ], + 'BodyCRC' => [ + 'description' => 'The cyclic redundancy check (CRC) value of the message body.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '914112295', + ], + 'BornHost' => [ + 'description' => 'The producer instance that generated the message.'."\n", + 'type' => 'string', + 'example' => '42.120.***.***:59270', + ], + ], + ], + ], + ], + ], + 'MaxPageCount' => [ + 'description' => 'The total number of returned pages.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '400', + ], + 'TaskId' => [ + 'description' => 'The ID of the query task. The first time you call this operation to query the dead-letter messages that are sent to a specified consumer group within a specified time range, this parameter is returned. You can use the task ID to query the details of dead-letter messages on other returned pages.'."\n", + 'type' => 'string', + 'example' => '0BC1310300002A9F000021E4D7A48346', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B00CD3C8-D81E-4A41-85E2-38F19252****\\",\\n \\"MsgFoundDo\\": {\\n \\"CurrentPage\\": 1,\\n \\"MsgFoundList\\": {\\n \\"OnsRestMessageDo\\": [\\n {\\n \\"StoreSize\\": 406,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570760999811,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C05F2*****\\",\\n \\"StoreHost\\": \\"11.193.***.***:10911\\",\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"PropertyList\\": {\\n \\"MessageProperty\\": [\\n {\\n \\"Value\\": \\"TagA\\",\\n \\"Name\\": \\"TAGS\\"\\n }\\n ]\\n },\\n \\"BornTimestamp\\": 1570760999721,\\n \\"BodyCRC\\": 914112295,\\n \\"BornHost\\": \\"42.120.***.***:59270\\"\\n }\\n ]\\n },\\n \\"MaxPageCount\\": 400,\\n \\"TaskId\\": \\"0BC1310300002A9F000021E4D7A48346\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsDLQMessagePageQueryByGroupIdResponse>\\n <MsgFoundDo>\\n <MaxPageCount>400</MaxPageCount>\\n <MsgFoundList>\\n <OnsRestMessageDo>\\n <MsgId>1E0578FE110F18B4AAC235C05F2*****</MsgId>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <ReconsumeTimes>1</ReconsumeTimes>\\n <BornHost>42.120.***.***:59270</BornHost>\\n <StoreTimestamp>1570760999811</StoreTimestamp>\\n <StoreHost>11.193.***.***:10911</StoreHost>\\n <BodyCRC>914112295</BodyCRC>\\n <Topic>test-mq_topic</Topic>\\n <BornTimestamp>1570760999721</BornTimestamp>\\n <StoreSize>406</StoreSize>\\n <PropertyList>\\n <MessageProperty>\\n <Name>TAGS</Name>\\n <Value>TagA</Value>\\n </MessageProperty>\\n </PropertyList>\\n </OnsRestMessageDo>\\n </MsgFoundList>\\n <TaskId>0BC1310300002A9F000021E4D7A48346</TaskId>\\n <CurrentPage>1</CurrentPage>\\n </MsgFoundDo>\\n <RequestId>5DC2A47E-2B31-4722-96C8-FA59C9*****</RequestId>\\n</OnsDLQMessagePageQueryByGroupIdResponse>","errorExample":""}]', + 'title' => 'OnsDLQMessagePageQueryByGroupId', + 'summary' => 'Queries all dead-letter messages in a group within a period of time by page.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'* If you do not know the ID of the dead-letter message that you want to query, you can call this operation to query all dead-letter messages that are sent to a specified consumer group within a specified time range. The results are returned by page.'."\n" + ."\n" + .'* We recommend that you specify a short time range to query dead-letter messages in this method. If you specify a long time range, a large number of dead-letter messages are returned. In this case, you cannot find the dead-letter message that you want to query in an efficient manner. You can perform the following steps to query dead-letter messages:'."\n" + ."\n" + .' 1. Perform a paged query by specifying the group ID, start time, end time, and number of entries to return on each page. If matched messages are found, the information about the dead-letter messages on the first page, total number of pages, and task ID are returned by default.'."\n" + .' 2. Specify the task ID and a page number to call this operation again to query the dead-letter messages on the specified page. In this query, the BeginTime, EndTime, and PageSize parameters do not take effect. By default, the system uses the values of these parameters that you specified in the request when you created the specified query task.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => '## View dead-letter messages in the console'."\n" + ."\n" + .'You can also view the dead-letter messages of a consumer group in the ApsaraMQ for RocketMQ console.**** For more information, see [Dead-letter queues](~~87277~~).', + ], + 'OnsDLQMessageGetById' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'MsgId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the dead-letter message that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0BC16699165C03B925DB8A404E2D****', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group whose dead-letter message you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_group_id', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the message you want to query belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID.'."\n", + 'type' => 'string', + 'example' => 'A07E3902-B92E-44A6-B6C5-6AA111111****', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'StoreSize' => [ + 'description' => 'The size of the message. Unit: KB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '407', + ], + 'ReconsumeTimes' => [ + 'description' => 'The number of retries that were performed to send the message to consumers.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StoreTimestamp' => [ + 'description' => 'The timestamp that indicates the point in time when the ApsaraMQ for RocketMQ broker stored the message. Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570761026708', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + 'MsgId' => [ + 'description' => 'The ID of the dead-letter message.'."\n", + 'type' => 'string', + 'example' => '0BC16699165C03B925DB8A404E2D****', + ], + 'StoreHost' => [ + 'description' => 'The ApsaraMQ for RocketMQ broker that stores the message.', + 'type' => 'string', + 'example' => '11.220.***.***:10911', + ], + 'Topic' => [ + 'description' => 'The topic to which the message belongs.'."\n", + 'type' => 'string', + 'example' => 'test-mq_topic', + ], + 'PropertyList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MessageProperty' => [ + 'description' => 'The attributes of the message.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of the attribute.'."\n", + 'type' => 'string', + 'example' => 'TagA', + ], + 'Name' => [ + 'description' => 'The name of the attribute. Valid values:'."\n" + ."\n" + .'* **TRACE_ON**: indicates whether the message trace exists.'."\n" + .'* **KEYS**: indicates the key of the message.'."\n" + .'* **TAGS**: indicates the tag that is attached to the message.'."\n" + .'* **INSTANCE_ID**: indicates the ID of the instance that contains the message.'."\n" + ."\n" + .'For information about the terms that are used in ApsaraMQ for RocketMQ, see [Terms](~~29533~~).', + 'type' => 'string', + 'example' => 'TAGS', + ], + ], + ], + ], + ], + ], + 'BornTimestamp' => [ + 'description' => 'The timestamp that indicates the point in time when the message was generated. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570761026630', + ], + 'BodyCRC' => [ + 'description' => 'The cyclic redundancy check (CRC) value of the message body.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '914112295', + ], + 'BornHost' => [ + 'description' => 'The producer instance that generated the message.'."\n", + 'type' => 'string', + 'example' => '42.120.**.**:64646', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A07E3902-B92E-44A6-B6C5-6AA111111****\\",\\n \\"Data\\": {\\n \\"StoreSize\\": 407,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"MsgId\\": \\"0BC16699165C03B925DB8A404E2D****\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"PropertyList\\": {\\n \\"MessageProperty\\": [\\n {\\n \\"Value\\": \\"TagA\\",\\n \\"Name\\": \\"TAGS\\"\\n }\\n ]\\n },\\n \\"BornTimestamp\\": 1570761026630,\\n \\"BodyCRC\\": 914112295,\\n \\"BornHost\\": \\"42.120.**.**:64646\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsDLQMessageGetByIdResponse>\\n<Data>\\n <MsgId>1E0578FE110F18B4AAC235C0C8460BA2</MsgId>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <ReconsumeTimes>1</ReconsumeTimes>\\n <BornHost>42.120.**.**:64646</BornHost>\\n <BodyCRC>914112295</BodyCRC>\\n <StoreHost>11.220.***.***:10911</StoreHost>\\n <StoreTimestamp>1570761026708</StoreTimestamp>\\n <BornTimestamp>1570761026630</BornTimestamp>\\n <Topic>test-mq_topic</Topic>\\n <StoreSize>407</StoreSize>\\n <PropertyList>\\n <MessageProperty>\\n <Name>TRACE_ON</Name>\\n <Value>true</Value>\\n </MessageProperty>\\n <MessageProperty>\\n <Name>RETRY_TOPIC</Name>\\n <Value>MQ_INST_111111111111_DOxxxxxx%test-mq_topic</Value>\\n </MessageProperty>\\n <MessageProperty>\\n <Name>KEYS</Name>\\n <Value>ORDERID_993</Value>\\n </MessageProperty>\\n <MessageProperty>\\n <Name>UNIQ_KEY</Name>\\n <Value>1E0578FE110F18B4AAC235C0C84*****</Value>\\n </MessageProperty>\\n <MessageProperty>\\n <Name>WAIT</Name>\\n <Value>false</Value>\\n </MessageProperty>\\n <MessageProperty>\\n <Name>TAGS</Name>\\n <Value>TagA</Value>\\n </MessageProperty>\\n <MessageProperty>\\n <Name>INSTANCE_ID</Name>\\n <Value>MQ_INST_111111111111_DOxxxxxx</Value>\\n </MessageProperty>\\n </PropertyList>\\n</Data>\\n<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>\\n</OnsDLQMessageGetByIdResponse>","errorExample":""}]', + 'title' => 'OnsDLQMessageGetById', + 'summary' => 'Queries a dead-letter message based on the message ID. The queried information about the dead-letter message includes the point in time when the message is stored, the message body, and attributes such as the message tag and the message key.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'This operation uses the exact match method to query a dead-letter message based on the message ID. You can obtain the message ID that is required to query the information about a dead-letter message from the SendResult parameter that is returned after the message is sent. You can also obtain the message ID by calling the OnsDLQMessagePageQueryByGroupId operation to query multiple messages at a time. The queried information about the dead-letter message includes the point in time when the message is stored, the message body, and attributes such as the message tag and the message key.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => '## View the information about a dead-letter message in the console'."\n" + ."\n" + .'You can also view the information about a dead-letter message in the ApsaraMQ for RocketMQ console. For more information, see [Dead-letter queues](~~87277~~).', + ], + 'OnsDLQMessageResendById' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'MsgId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the dead-letter message that you want to send to a consumer group for consumption.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0BC16699343051CD9F1D798E7734****', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group in which you want to query dead-letter messages.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GID_test_group_id', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance in which the dead-letter message you want to query resides.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_188077086902****_BXSuW61e', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'D94CC769-4DC3-4690-A868-9D0631B1****', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MsgId' => [ + 'description' => 'The returned messages.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'example' => '0BC16699343051CD9F1D798E7734****', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D94CC769-4DC3-4690-A868-9D0631B1****\\",\\n \\"Data\\": {\\n \\"MsgId\\": [\\n \\"0BC16699343051CD9F1D798E7734****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<OnsDLQMessageResendByIdResponse>\\r\\n<RequestId>D94CC769-4DC3-4690-A868-9D0631B1****</RequestId>\\r\\n</OnsDLQMessageResendByIdResponse>","errorExample":""}]', + 'title' => 'OnsDLQMessageResendById', + 'summary' => 'Resends a dead-letter message based on a specified message ID so that the dead-letter message can be consumed by consumers.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'* A dead-letter message is a message that still fails to be consumed after the number of consumption retries reaches the upper limit. If the message still cannot be consumed after you re-send it, a message with the same message ID is added to the corresponding dead-letter queue. You can query the message ID on the Dead-letter Queues page in the ApsaraMQ for RocketMQ console or by calling API operations. You can obtain the number of consumption failures for a message based on the number of dead-letter messages with the same message ID in the dead-letter queue.'."\n" + .'* A dead-letter message is a message that fails to be consumed after the number of consumption retries reaches the upper limit. Generally, dead-letter messages are produced because of incorrect consumption logic. We recommend that you troubleshoot the consumption failures and then call this operation to send the message to the consumer group for consumption again.'."\n" + .'* ApsaraMQ for RocketMQ does not manage the status of dead-letter messages based on the consumption status of the dead-letter messages. After you call this operation to send a dead-letter message to a consumer group and the message is consumed, ApsaraMQ for RocketMQ does not remove the dead-letter message from the dead-letter queue. You must manage dead-letter messages and determine whether to send a dead-letter message to a consumer group for consumption. This way, you do not resend or reconsume the messages that are consumed.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '> If the message fails to be sent, the message ID is returned in the response.'."\n", + 'extraInfo' => '## Send a dead-letter message to a consumer group in the console'."\n" + ."\n" + .'You can also send a dead-letter message to a consumer group for consumption in the ApsaraMQ for RocketMQ console. For more information, see [Dead-letter queues](~~87277~~).', + ], + 'OnsTopicUpdate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the topic that you want to manage.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Perm', + 'in' => 'query', + 'schema' => [ + 'description' => 'The read/write mode that you want to configure for the topic. Valid values:'."\n" + ."\n" + .'* **6**: Both read and write operations are allowed.'."\n" + .'* **4**: Write operations are forbidden.'."\n" + .'* **2**: Read operations are forbidden.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the topic belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'MQ_INST_111111111111_DOxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '81979ADA-4A78-4F64-9DEC-5700446D****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"81979ADA-4A78-4F64-9DEC-5700446D****\\"\\n}","errorExample":""},{"type":"xml","example":"<OnsTopicUpdateResponse>\\r\\n<RequestId>81979ADA-4A78-4F64-9DEC-5700446D****</RequestId>\\r\\n</OnsTopicUpdateResponse>","errorExample":""}]', + 'title' => 'OnsTopicUpdate', + 'summary' => 'Configures the read/write mode for a specified topic.', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'You can call this operation to forbid read or write operations on a specific topic.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'ons.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'ons.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'ons.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'ons.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'ons.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'mq-internet-access', + 'endpoint' => 'ons.mq-internet-access.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'ons.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'ons.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'ons.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'ons.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'ons.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'ons.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'ons.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'ons.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'ons.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'ons.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'ons.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'ons.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'ons.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'ons.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'ons.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'ons.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'ons.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'ons.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'ons.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'ons.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'ons.me-central-1.aliyuncs.com', + ], + ], +]; |