'1.0', 'info' => ['style' => 'ROA', 'product' => 'RocketMQ', 'version' => '2022-08-01'], 'directories' => [ [ 'children' => ['CreateTopic', 'UpdateTopic'], 'type' => 'directory', 'title' => 'Subject', ], [ 'children' => ['ListConsumerGroups', 'GetConsumerGroup'], 'type' => 'directory', 'title' => 'Consumer groups', ], [ 'children' => ['ListConsumerGroupSubscriptions'], 'type' => 'directory', 'title' => 'Subscription Relationships', ], [ 'children' => ['ListConsumerConnections', 'GetConsumerGroupLag'], 'type' => 'directory', 'title' => 'Usage', ], [ 'children' => ['ListMessages', 'GetMessageDetail', 'VerifySendMessage'], 'type' => 'directory', 'title' => 'Messages', ], [ 'children' => ['CreateInstanceAccount', 'UpdateInstanceAccount', 'ListInstanceAccount', 'GetInstanceAccount', 'CreateInstanceAcl', 'UpdateInstanceAcl'], 'type' => 'directory', 'title' => 'Access control list (ACL)', ], [ 'children' => ['ListMigrations', 'ListMigrationOperations', 'ExecuteMigrationOperation', 'FinishMigrationStage'], 'type' => 'directory', 'title' => 'Cloud migration', ], [ 'children' => ['CreateDisasterRecoveryPlan', 'UpdateDisasterRecoveryPlan', 'ListDisasterRecoveryPlans', 'GetDisasterRecoveryPlan', 'ListDisasterRecoveryItems'], 'type' => 'directory', 'title' => 'Global Replicator', ], [ 'children' => ['GetConsumeTimespan'], 'type' => 'directory', 'title' => 'Other', ], [ 'children' => [ 'AddDisasterRecoveryItem', 'ChangeResourceGroup', 'CreateConsumerGroup', 'CreateInstance', 'CreateInstanceIpWhitelist', 'DeleteConsumerGroup', 'DeleteConsumerGroupSubscription', 'DeleteDisasterRecoveryItem', 'DeleteDisasterRecoveryPlan', 'DeleteInstance', 'DeleteInstanceAccount', 'DeleteInstanceAcl', 'DeleteInstanceIpWhitelist', 'DeleteTopic', 'GetConsumerGroupSubscription', 'GetConsumerStack', 'GetDisasterRecoveryItem', 'GetInstance', 'GetInstanceAcl', 'GetInstanceIpWhitelist', 'GetTopic', 'GetTrace', 'ListAvailableZones', 'ListDisasterRecoveryCheckpoints', 'ListInstanceAcl', 'ListInstanceIpWhitelist', 'ListInstances', 'ListMetricMeta', 'ListRegions', 'ListTagResources', 'ListTopicSubscriptions', 'ListTopics', 'ListTraces', 'ResetConsumeOffset', 'StartDisasterRecoveryItem', 'StopDisasterRecoveryItem', 'SyncDisasterRecoveryCheckpoint', 'TagResources', 'UntagResources', 'UpdateConsumerGroup', 'UpdateDisasterRecoveryItem', 'UpdateInstance', 'VerifyConsumeMessage', ], 'title' => 'Others', 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AddDisasterRecoveryItem' => [ 'path' => '/disaster_recovery/{planId}/items', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225043', 'abilityTreeNodes' => ['FEATUREonsOVRH1R', 'FEATUREonsU22PJL'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', 'schema' => ['description' => 'Backup plan ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'Request body structure. Required.', 'type' => 'object', 'properties' => [ 'topics' => [ 'title' => '容灾Item所包含的容灾主题', 'description' => 'Topics included in the backup mapping. Required.', 'type' => 'array', 'items' => [ 'description' => 'Topics included in the backup mapping', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'Region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], 'instanceType' => [ 'title' => '实例类型', 'description' => 'Instance type'."\n" .' - ALIYUN_ROCKETMQ: Alibaba Cloud instance'."\n" .' - EXTERNAL_ROCKETMQ: External instance, open-source instance, open-source cluster', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALIYUN_ROCKETMQ' => '阿里云实例', 'EXTERNAL_ROCKETMQ' => '外部实例'], 'example' => 'ALIYUN_ROCKETMQ'."\n", ], 'instanceId' => ['title' => '实例ID', 'description' => 'Instance ID, an instance ID will be automatically generated when `instanceType` is `EXTERNAL_ROCKETMQ`, and it can be obtained by querying the backup plan.', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-em93y94xxx'], 'topicName' => ['title' => '容灾主题名称', 'description' => 'Disaster recovery topic name, required', 'type' => 'string', 'required' => false, 'example' => 'Topic_xxx'], 'consumerGroupId' => ['title' => '消费者组ID', 'description' => 'Consumer group ID, required for ACTIVE_ACTIVE bidirectional backup', 'type' => 'string', 'required' => false, 'example' => 'GID_xxx', 'deprecated' => true], 'deliveryOrderType' => [ 'type' => 'string', 'required' => false, 'description' => 'The order in which messages are delivered to the target instance. The parameter values ​​are as follows:'."\n" .' - Concurrently: concurrent delivery'."\n" .' - Orderly: sequential delivery', 'example' => 'Concurrently', 'enumValueTitles' => ['Concurrently' => '并发投递', 'Orderly' => '顺序投递'], 'title' => '', ], ], 'required' => false, 'title' => '', ], 'required' => false, ], ], 'required' => false, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '请求ID', 'description' => 'Request ID', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['title' => '是否成功', 'description' => 'Whether the operation was successful', 'type' => 'boolean', 'example' => 'true'], 'data' => ['description' => 'Return result, mapping task ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1300000016', 'title' => ''], 'code' => ['title' => '错误码', 'description' => 'Error code', 'type' => 'string', 'example' => '200'], 'message' => ['title' => '错误信息', 'description' => 'Error message', 'type' => 'string', 'example' => 'xxx'], 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '动态错误码', 'description' => 'Dynamic error code', 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '动态错误信息', 'description' => 'Dynamic error message', 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => 'Access denied details, only in the scenario where the user is denied access due to RAM not having permission', 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": 1300000016,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'AddDisasterRecoveryItem', 'summary' => 'Adds a topic mapping to a Global Replicator task.', 'translator' => 'machine', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDisasterRecoveryItem'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:AddDisasterRecoveryItem', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'ChangeResourceGroup' => [ 'path' => '/resourceGroup/change', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'resourceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource. Set this parameter to the ID of the ApsaraMQ for RocketMQ instance whose resource group you want to change.', 'type' => 'string', 'required' => true, 'example' => 'c2c5d1274a8d4317a13bc5b0d4******', 'title' => ''], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region in which the instance resides.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'resourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of resource.'."\n" ."\n" .'Set this parameter to **instance**. The value of this parameter cannot be changed.'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => ['instance' => '实例'], 'example' => 'instance', 'title' => '', ], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group to which the instance is changed.'."\n" ."\n" .'You can call the [ListResourceGroups](https://www.alibabacloud.com/help/resource-management/latest/listresourcegroups) operation to query existing resource groups.', 'type' => 'string', 'required' => true, 'example' => 'rg-9gLOoK****', 'title' => ''], ], ], 'responses' => [ 200 => [ '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. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['description' => 'Indicates whether the call was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'data' => ['description' => 'The returned result.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'code' => ['description' => 'The error code returned if the call failed.'."\n", 'type' => 'string', 'example' => 'Instance.NotFound', 'title' => ''], 'message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The instance cannot be found.', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'dynamicCode' => ['description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId', 'title' => ''], 'dynamicMessage' => ['description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId', 'title' => ''], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Instance.NotFound\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'ChangeResourceGroup', 'summary' => 'Changes the resource group to which a ApsaraMQ for RocketMQ instance belongs.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'CreateConsumerGroup' => [ 'summary' => 'Creates a consumer group for ApsaraMQ for RocketMQ. A consumer group is a load balancing group that contains multiple consumers with the same consumption behavior. Consumers must specify a consumer group and the relevant topics to subscribe to messages.', 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREonsTT47IL'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['title' => 'The response object.'."\n", 'description' => 'The ID of the instance to which the consumer group belongs.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'consumerGroupId', 'in' => 'path', 'schema' => ['title' => 'Indicates whether the call is successful.'."\n", 'description' => 'The ID of the consumer group that you want to create. This ID is used to identify the consumer group and must be globally unique.'."\n" ."\n" .'The value must meet the following requirements:'."\n" ."\n" .'- The ID can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" ."\n" .'- The ID must be 1 to 60 characters in length.'."\n" ."\n" .'For more information about reserved characters, see [Parameter limits](~~440347~~).', 'type' => 'string', 'required' => true, 'example' => 'GID_test_groupId'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'remark' => ['title' => 'The error message.'."\n", 'description' => 'The remarks on the consumer group.', 'type' => 'string', 'required' => false, 'example' => 'This is the remark for test.'], 'deliveryOrderType' => [ 'title' => 'The dynamic error code.'."\n", 'description' => 'The delivery order of the consumer group.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Concurrently: Messages are delivered concurrently.'."\n" ."\n" .'- Orderly: Messages are delivered in order.', 'enumValueTitles' => ['Concurrently' => 'Concurrent delivery', 'Orderly' => 'Orderly delivery'], 'type' => 'string', 'required' => true, 'enum' => ['Orderly', 'Concurrently'], 'example' => 'Concurrently', ], 'consumeRetryPolicy' => [ 'title' => '', 'description' => 'The retry policy for the consumer group. For more information, see'."\n" .'[Message retry](~~440356~~).', 'type' => 'object', 'properties' => [ 'maxRetryTimes' => ['description' => 'The maximum number of retries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '16'], 'retryPolicy' => [ 'description' => 'The type of the retry policy. For more information, see [Message retry](~~440356~~).'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- FixedRetryPolicy: retries at a fixed interval. This policy is available only for orderly message delivery.'."\n" ."\n" .'- DefaultRetryPolicy: retries with a backoff. This policy is available only for concurrent message delivery.', 'enumValueTitles' => ['FixedRetryPolicy' => 'Fixed-interval retry', 'DefaultRetryPolicy' => 'Backoff retry'], 'type' => 'string', 'required' => true, 'enum' => ['DefaultRetryPolicy', 'FixedRetryPolicy'], 'title' => '', 'example' => 'DefaultRetryPolicy', ], 'deadLetterTargetTopic' => ['description' => 'The dead-letter topic.'."\n" ."\n" .'If a consumer fails to consume a message after the maximum number of retries, the message is delivered to a dead-letter topic. You can then perform business recovery or backtrace the message. For more information, see [Message retry and dead-letter messages](~~440356~~).', 'type' => 'string', 'required' => false, 'example' => 'DLQ_mqtest', 'title' => ''], 'fixedIntervalRetryTime' => ['description' => 'The fixed retry interval. Unit: seconds. This parameter is valid only if you set the retry policy to FixedRetryPolicy.'."\n" .'Valid values:'."\n" ."\n" .'- Concurrent delivery: 10 to 1800'."\n" ."\n" .'- Orderly delivery: 1 to 600', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => true, 'example' => '', ], 'maxReceiveTps' => ['description' => 'The maximum TPS for message consumption.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], 'messageModel' => [ 'description' => 'The consumption mode. Valid values:'."\n" ."\n" .'- CLUSTERING'."\n" ."\n" .'- LITE\\_SELECTIVE', 'type' => 'string', 'example' => 'LITE_SELECTIVE', 'default' => 'CLUSTERING', 'enum' => ['CLUSTERING', 'LITE_SELECTIVE'], 'title' => '', 'required' => false, ], 'topicName' => ['description' => 'The name of the lite topic that the consumer group subscribes to. This parameter is required if you set messageModel to LITE\\_SELECTIVE.', 'type' => 'string', 'example' => 'liteTopicTest', 'title' => '', 'required' => false], 'exclusive' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result\\', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID. Each request has a unique ID. You can use this ID to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => ['description' => 'The data returned.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'InvalidConsumerGroupId'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Parameter consumerGroupId is invalid.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '400'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'ConsumerGroupId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'consumerGroupId'], ], 'example' => '', ], ], ], 'title' => 'CreateConsumerGroup', 'description' => '>'."\n" ."\n" .'The Alibaba Cloud OpenAPI is a management API used to manage and query Alibaba Cloud service resources. Integrate this API for management purposes only. Do not use this API for core data links that send and receive messages. This can introduce risks to your data links.'."\n" ."\n" .'>', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConsumerGroup'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'rocketmq:CreateConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"InvalidConsumerGroupId\\",\\n \\"message\\": \\"Parameter consumerGroupId is invalid.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"ConsumerGroupId\\",\\n \\"dynamicMessage\\": \\"consumerGroupId\\"\\n}","type":"json"}]', ], 'CreateDisasterRecoveryPlan' => [ 'path' => '/disaster_recovery', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225047', 'abilityTreeNodes' => ['FEATUREonsOVRH1R', 'FEATUREonsU22PJL'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ 'planName' => ['title' => '', 'description' => 'The name of the Global Replicator task. You must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'planDesc' => ['title' => '', 'description' => 'The description of the Global Replicator task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'planType' => [ 'title' => '', 'description' => 'The type of the Global Replicator task. You must specify this parameter. For more information, see [Global Replicator](~~2843187~~). Valid values:'."\n" ."\n" .'* ACTIVE_PASSIVE: one-way backup'."\n" .'* ACTIVE_ACTIVE: two-way backup'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ACTIVE_ACTIVE' => '双向备份', 'ACTIVE_PASSIVE' => '单向备份'], 'example' => 'ACTIVE_ACTIVE', ], 'instances' => [ 'title' => '', 'description' => 'The instances involved in the Global Replicator task. You must specify this parameter.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance involved in the Global Replicator task.'."\n", 'type' => 'object', 'properties' => [ 'instanceType' => [ 'title' => '', 'description' => 'The instance type. Valid values:'."\n" ."\n" .'* ALIYUN_ROCKETMQ: ApsaraMQ for RocketMQ instance'."\n" .'* EXTERNAL_ROCKETMQ: external RocketMQ instance'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* ALIYUN_ROCKETMQ: ApsaraMQ for RocketMQ instance'."\n" .'* EXTERNAL_ROCKETMQ: external RocketMQ instance'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALIYUN_ROCKETMQ' => '阿里云mq实例', 'EXTERNAL_ROCKETMQ' => '外部实例'], 'example' => 'ALIYUN_ROCKETMQ', ], 'regionId' => ['title' => '', 'description' => 'The region where the instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], 'instanceId' => ['title' => '', 'description' => 'The instance ID. This parameter is required only if you set instanceType to ALIYUN_ROCKETMQ.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-******'], 'instanceRole' => [ 'title' => '', 'description' => 'The instance role. Valid values:'."\n" ."\n" .'* ACTIVE: primary instance'."\n" .'* Passive: secondary instance'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['PASSIVE' => '备', 'ACTIVE' => '主'], 'example' => 'PASSIVE', ], 'authType' => [ 'title' => '', 'description' => 'The authentication method. If you set instanceType to ALIYUN_ROCKETMQ and the instance is an ApsaraMQ for RocketMQ 4.0 instance, you do not need to specify this parameter.'."\n" ."\n" .'* NO_AUTH: no authentication'."\n" .'* ACL_AUTH: access control list (ACL)-based authentication'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* NO_AUTH: no authentication'."\n" .'* ACL_AUTH: access control list (ACL)-based authentication'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['NO_AUTH' => '无须认证', 'ACL_AUTH' => 'acl认证'], 'example' => 'ACL_AUTH', ], 'username' => ['title' => '', 'description' => 'The username used for authentication. This parameter is required only if you set authType to ACL_AUTH.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'password' => ['title' => '', 'description' => 'The password used for authentication. This parameter is required only if you set authType to ACL_AUTH. If you set instanceType to ALIYUN_ROCKETMQ, you do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'endpointUrl' => ['title' => '', 'description' => 'The instance endpoint. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'networkType' => [ 'title' => '', 'description' => 'The network type. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ. Valid values:'."\n" ."\n" .'* TCP_INTERNET: Internet over TCP'."\n" .'* TCP_VPC: virtual private cloud (VPC) over TCP.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['TCP_VPC' => 'tcp专有网络', 'TCP_INTERNET' => 'tcp公网'], 'example' => 'TCP_INTERNET', ], 'vpcId' => ['title' => 'VPC ID', 'description' => 'The ID of the VPC with which the instance is associated. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-wz9qt50xhtj9krb******'."\n"], 'vSwitchId' => ['title' => '', 'description' => 'The ID of the vSwitch with which the instance is associated. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6gwtbn6etadpv******'."\n"], 'messageProperty' => [ 'description' => 'The message attribute. When you synchronize a message to the destination cluster, the system automatically adds the attribute to the message for SQL-based filtering.'."\n", 'type' => 'object', 'properties' => [ 'propertyKey' => ['description' => 'The attribute key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aaa', 'title' => ''], 'propertyValue' => ['description' => 'The attribute value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'bbb', 'title' => ''], ], 'required' => false, 'title' => '', ], 'securityGroupId' => ['description' => 'The ID of the security group to which the instance belongs. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-bp17hpmgz9******', 'title' => ''], 'consumerGroupId' => ['description' => 'The ID of the consumer group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'GID_DS_XXX_YYY', 'title' => ''], ], 'required' => false, 'title' => '', ], 'required' => false, ], 'autoSyncCheckpoint' => [ 'title' => '', 'description' => 'Specifies whether to enable automatic consumer progress synchronization.'."\n" ."\n" .'> This parameter takes effect only when you set `syncCheckpointEnabled` to true.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'required' => false, 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], 'example' => 'true', ], 'syncCheckpointEnabled' => [ 'description' => 'Specifies whether to enable consumer progress synchronization.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'required' => false, 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], 'example' => 'true', 'title' => '', ], ], 'required' => false, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5xxxx'], 'success' => ['title' => '', 'description' => 'Indicates whether the operation was successful', 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The result, which is the backup plan ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], 'code' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '200'], 'message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'xxx'], 'httpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'Dynamic error code', 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'Dynamic error message', 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'Access denied details, provided only in scenarios where access is denied due to lack of RAM permissions', 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7E8AE3A-219B-52EE-BE32-4036F5xxxx\\",\\n \\"success\\": true,\\n \\"data\\": 1234,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'CreateDisasterRecoveryPlan', 'summary' => 'Create Disaster Recovery Plan', 'translator' => 'machine', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:CreateDisasterRecoveryPlan', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'CreateInstance' => [ 'summary' => 'Creates an ApsaraMQ for RocketMQ 5.x instance.', 'path' => '/instances', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '145030', 'abilityTreeNodes' => ['FEATUREonsWNMPZ3'], ], 'parameters' => [ [ 'name' => 'clientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token to ensure request idempotence. The token must be unique for each request and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'c2c5d1274a8d4317a13bc5b0d4******', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'instanceName' => ['description' => 'The name of the instance. If you do not specify this parameter, the instance ID is used as its name.'."\n" ."\n" .'If left blank, the instance ID is used as the instance name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rmq-cn-72u3048uxxx'], 'serviceCode' => ['description' => 'The service code of the instance. For Message Queue for Apache RocketMQ, the service code is `rmq`.', 'type' => 'string', 'required' => true, 'example' => 'rmq', 'default' => 'rmq', 'title' => ''], 'seriesCode' => [ 'description' => 'The primary edition of the instance. For more information about the differences between primary editions, see [Product selection](~~444722~~).'."\n" ."\n" .'>'."\n" ."\n" .'After an instance is created, you can only upgrade its edition, not downgrade it. The upgrade path is: Standard Edition > Professional Edition > Platinum Edition.'."\n" ."\n" .'>', 'enumValueTitles' => ['standard' => 'Standard Edition', 'ultimate' => 'Platinum Edition', 'professional' => 'Professional Edition'], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'standard', ], 'subSeriesCode' => [ 'description' => 'The sub-edition of the instance. For more information about the differences between sub-editions, see [Product selection](~~444722~~).'."\n" ."\n" .'If you set the `seriesCode` parameter to `ultimate` (Platinum Edition), this parameter can only be set to `cluster_ha` (High-availability Cluster Edition).'."\n" .'>After an instance is created, you cannot change its sub-edition.>', 'enumValueTitles' => ['serverless' => 'Serverless Edition', 'cluster_ha' => 'High-availability Cluster Edition', 'single_node' => 'Single-node Testing Edition'], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cluster_ha', ], 'paymentType' => [ 'description' => 'The billing method of the instance. Message Queue for Apache RocketMQ supports subscription and pay-as-you-go.'."\n" ."\n" .'For more information, see [Billing methods](~~427234~~).', 'enumValueTitles' => ['PayAsYouGo' => 'pay-as-you-go. This is a postpaid mode in which you are billed for your actual usage.', 'Subscription' => 'subscription. This is a prepaid mode in which you pay for a subscription duration in advance.'], 'type' => 'string', 'required' => true, 'enum' => ['Subscription', 'PayAsYouGo'], 'title' => '', 'example' => 'Subscription', ], 'period' => ['description' => 'The subscription duration. This parameter is required only if you set the `paymentType` parameter to `Subscription`.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- If `periodUnit` is set to `Month`, valid values are 1, 2, 3, 4, 5, and 6.'."\n" ."\n" .'- If `periodUnit` is set to `Year`, valid values are 1, 2, and 3.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '3'], 'periodUnit' => [ 'description' => 'The unit of the subscription duration.', 'enumValueTitles' => ['Month' => 'The subscription duration is specified in months.', 'Year' => 'The subscription duration is specified in years.'], 'type' => 'string', 'required' => false, 'enum' => ['Month', 'Year'], 'title' => '', 'example' => 'Month', ], 'autoRenew' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. This parameter is valid only for subscription instances.', 'enumValueTitles' => ['true' => 'Enables auto-renewal.', 'false' => 'Disables auto-renewal.'], 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true', ], 'autoRenewPeriod' => ['description' => 'The auto-renewal period. This parameter is valid only if auto-renewal is enabled. Unit: months.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- 1, 2, 3, 6, and 12.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '3'], 'remark' => ['description' => 'The remarks on the instance.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'This is the remark for test.'], 'productInfo' => [ 'title' => '', 'description' => 'The specifications of the instance.', 'type' => 'object', 'properties' => [ 'msgProcessSpec' => ['description' => 'The computing specification for message sending and receiving. For information about the TPS limits for message sending and receiving, see [Instance specifications](~~444715~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rmq.s2.2xlarge'], 'sendReceiveRatio' => ['description' => 'The ratio of TPS for sending messages to the total TPS of the instance.'."\n" ."\n" .'For example, if the TPS limit for an instance is 1,000 and the ratio is 0.8, the TPS limit for sending messages is 800 and the TPS limit for receiving messages is 200.'."\n" ."\n" .'The value of this parameter must be a decimal between 0.05 and 0.95. Default value: 0.5.', 'type' => 'number', 'format' => 'float', 'title' => '', 'required' => false, 'example' => '0.5'], 'autoScaling' => [ 'description' => 'Specifies whether to enable elastic TPS for the instance.'."\n" ."\n" .'If you enable this feature, the instance can process more messages than the number specified by the basic specifications. You are charged for the extra TPS. For more information, see [Computing fees](~~427237~~).'."\n" ."\n" .'> This feature is supported only by specific instance editions. For more information, see [Instance specifications](~~444715~~).', 'enumValueTitles' => ['true' => 'Enables elastic TPS.', 'false' => 'Disables elastic TPS.'], 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true', ], 'messageRetentionTime' => ['description' => 'The message retention period. Unit: hours.'."\n" ."\n" .'For information about the value range, see the "Message retention period" section in the [Limits](~~440347~~) topic.'."\n" ."\n" .'Message Queue for Apache RocketMQ provides serverless message storage that is billed based on your actual usage. You can adjust the message retention period to manage storage capacity. For more information, see [Storage fees](~~427238~~).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '72'], 'storageEncryption' => ['description' => 'Specifies whether to enable storage encryption.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], 'storageSecretKey' => ['description' => 'The key that is used for storage encryption.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxxxx'], 'capacityType' => [ 'description' => 'The capacity mode.', 'enumValueTitles' => ['provisioned' => 'Reserved + Elastic', 'ondemand' => 'pay-as-you-go'], 'type' => 'string', 'enum' => ['provisioned', 'ondemand'], 'title' => '', 'required' => false, 'example' => 'provisioned', ], 'provisionedCapacity' => ['description' => 'The reserved capacity.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '5000'], 'traceOn' => ['description' => 'Specifies whether to enable the message trace feature.'."\n" .'Valid values:'."\n" ."\n" .'This parameter is valid only for serverless instances. If you enable the message trace feature, you are charged for the feature. For more information, see [Billing of serverless instances](~~482974#section-57o-99e-x93~~). For pay-as-you-go and subscription instances, this parameter does not take effect. The message trace feature is enabled for these instances by default.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], 'drReplicationMode' => [ 'description' => 'The cross-zone replication mode.', 'enumValueTitles' => ['async_cross_az' => 'asynchronous replication', 'sync_cross_az' => 'synchronous replication'], 'type' => 'string', 'example' => 'async_cross_az', 'title' => '', 'required' => false, ], ], 'required' => false, 'example' => '', ], 'networkInfo' => [ 'title' => '', 'description' => 'The network configurations.', 'type' => 'object', 'properties' => [ 'vpcInfo' => [ 'title' => '', 'description' => 'The virtual private cloud (VPC) configurations.', 'type' => 'object', 'properties' => [ 'vpcId' => ['description' => 'The ID of the VPC to which the instance is connected.'."\n" ."\n" .'> After a Message Queue for Apache RocketMQ instance is created, you cannot change the VPC to which the instance is connected. If you want to change the VPC, you must release the instance and purchase a new one.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'vpc-wz9qt50xhtj9krb******'], 'vSwitchId' => ['description' => 'The ID of the vSwitch to which the instance is connected. If you want to connect the instance to multiple vSwitches, separate the vSwitch IDs with vertical bars (|).'."\n" ."\n" .'> After a Message Queue for Apache RocketMQ instance is created, you cannot change the vSwitch to which the instance is connected. If you want to change the vSwitch, you must release the instance and purchase a new one.'."\n" ."\n" .'>'."\n" ."\n" .'This parameter is deprecated. We recommend that you use the `vSwitches` parameter.'."\n" ."\n" .'>', 'type' => 'string', 'deprecated' => true, 'required' => false, 'title' => '', 'example' => 'vsw-uf6gwtbn6etadpv*******'], 'securityGroupIds' => ['description' => 'The ID of the security group.', 'type' => 'string', 'required' => false, 'example' => 'sg-bp17hpmgz96tvnsdy6so', 'title' => ''], 'vSwitches' => [ 'description' => 'The list of vSwitches.'."\n" ."\n" .'> After a Message Queue for Apache RocketMQ instance is created, you cannot change the vSwitches for the instance. If you want to change the vSwitches, you must release the instance and purchase a new one.'."\n" ."\n" .'>'."\n" ."\n" .'This parameter is required. We recommend that you use this parameter to specify a vSwitch instead of the deprecated `vSwitchId` parameter.'."\n" ."\n" .'>', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'vSwitchId' => ['description' => 'The ID of the vSwitch to which the instance is connected.', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6gwtbn6etadpv*******', 'title' => ''], ], 'required' => false, 'description' => 'The vSwitches.', 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => true, 'example' => '', ], 'internetInfo' => [ 'title' => '', 'description' => 'The Internet access configurations.', 'type' => 'object', 'properties' => [ 'internetSpec' => [ 'description' => 'Specifies whether to enable Internet access.'."\n" ."\n" .'By default, instances can be accessed only within a VPC. If you enable Internet access for an instance, you are charged for Internet traffic that is generated by the instance. For more information, see [Internet access fees](~~427240~~).', 'enumValueTitles' => ['enable' => 'Enables Internet access.', 'disable' => 'Disables Internet access.'], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'disable', ], 'flowOutType' => [ 'description' => 'The billing method for Internet access.', 'enumValueTitles' => ['payByBandwidth' => 'pay-by-bandwidth. This billing method is available only when you enable Internet access.', 'payByTraffic' => 'pay-by-traffic. This billing method is available only when you enable Internet access.', 'uninvolved' => 'not involved. This value is used when you disable Internet access.'], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'uninvolved', ], 'flowOutBandwidth' => ['description' => 'The Internet bandwidth. Unit: Mbit/s.'."\n" ."\n" .'This parameter is required only when the billing method for Internet access is pay-by-bandwidth.'."\n" ."\n" .'Value range: 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '100'], 'ipWhitelist' => [ 'title' => '', 'description' => 'The IP address whitelist for Internet access. You can configure an IP address whitelist only for public endpoints. VPC endpoints do not support this feature.'."\n" ."\n" .'- If you do not configure an IP address whitelist, all IP addresses are allowed to access the Message Queue for Apache RocketMQ instance over the Internet.'."\n" ."\n" .'- If you configure an IP address whitelist, only the IP addresses in the whitelist can access the Message Queue for Apache RocketMQ instance over the Internet.', 'type' => 'array', 'items' => ['description' => 'An IP address or CIDR block in the whitelist.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '192.168.x.x/24'], 'deprecated' => true, 'required' => false, 'example' => '', ], ], 'required' => true, 'example' => '', ], ], 'required' => true, 'example' => '', ], 'commodityCode' => ['description' => 'The commodity code.'."\n" ."\n" .''."\n" ."\n" .'- `ons_rmqsub_public_cn`: subscription instance'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- `ons_rmqpost_public_cn`: pay-as-you-go instance'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- `ons_rmqsrvlesspost_public_cn`: serverless instance'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- `ons_rmqpost_public_intl`: pay-as-you-go instance'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- `ons_rmqsub_public_intl`: subscription instance'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- `ons_rmqsrvlesspost_public_intl`: serverless instance'."\n" ."\n" .'', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'ons_ rmqpost_public_cn', 'title' => ''], 'resourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-aekzy6pist7uuna'], 'tags' => [ 'description' => 'The resource tags.', 'type' => 'array', 'items' => [ 'description' => 'The resource tag.', 'type' => 'object', 'properties' => [ 'key' => ['description' => 'The key of the resource tag.', 'type' => 'string', 'required' => false, 'example' => 'xxxKey', 'title' => ''], 'value' => ['description' => 'The value of the resource tag.', 'type' => 'string', 'required' => false, 'example' => 'xxxValue', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], 'aclInfo' => [ 'type' => 'object', 'properties' => [ 'defaultVpcAuthFree' => ['description' => 'Specifies whether to enable password-free access to the instance within the VPC by using intelligent identity recognition.'."\n" ."\n" .'- `true`: Enables password-free access.'."\n" ."\n" .'- `false`: Disables password-free access.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], 'title' => '', 'description' => 'The access control information.', 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => ['description' => 'The ID of the instance that is created.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-7e22ody****'], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Success'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], ], 'example' => '', ], ], ], 'title' => 'CreateInstance', 'description' => '>'."\n" ."\n" .'Alibaba Cloud\'s OpenAPI is a management API for managing and querying your resources. It is intended for integration with the management plane only. To prevent instability, do not use OpenAPI for message transport in core data links.'."\n" ."\n" .'>', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'rocketmq:CreateInstance', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'rocketmq:InternetSpec', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:Instance/*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": \\"rmq-cn-7e22ody****\\",\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"Success\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', ], 'CreateInstanceAccount' => [ 'summary' => 'Creates an access account for an instance.', 'path' => '/instances/{instanceId}/accounts', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'password' => ['description' => 'The password of the account.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'xxx'], 'username' => ['description' => 'The name of the account.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], 'remark' => ['description' => 'The remarks on the account.', 'type' => 'string', 'example' => 'This is the remark for test.', 'title' => '', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3AE0999C-8DBA-5CEE-8D9A-BE8D4A90DF8D'], 'success' => ['description' => 'Indicates whether the call is successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => ['description' => 'The returned data.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'MissingInstanceId'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The instance cannot be found.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'accessDeniedDetail' => ['description' => 'The details of the access denial. This parameter is returned only when the request is denied due to RAM permissions.', 'type' => 'string', 'title' => '', 'example' => 'xxx'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3AE0999C-8DBA-5CEE-8D9A-BE8D4A90DF8D\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'CreateInstanceAccount', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstanceAccount'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'rocketmq:CreateInstanceAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'CreateInstanceAcl' => [ 'summary' => 'Creates an access control list (ACL) in a specific instance.', 'path' => '/instances/{instanceId}/acl/account/{username}', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '209893', 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'username', 'in' => 'path', 'schema' => ['description' => 'The username of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'abc', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ 'resourceType' => [ 'title' => '', 'description' => 'The type of the resource on which you want to grant permissions.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Group'."\n" .'* Topic'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], 'enum' => ['Topic', 'Group'], 'example' => 'Topic', ], 'resourceName' => ['title' => '', 'description' => 'The name of the resource on which you want to grant permissions.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test'], 'decision' => [ 'title' => '', 'description' => 'The decision result of the authorization.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Deny'."\n" .'* Allow'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => ['Deny' => '拒绝访问', 'Allow' => '允许访问'], 'enum' => ['Allow', 'Deny'], 'example' => 'Allow', ], 'actions' => [ 'description' => 'The type of operations that can be performed on the resource.'."\n" ."\n" .'The following types of operations are supported based on the resource type:'."\n" ."\n" .'* Topic: Pub, Sub, and Pub|Sub'."\n" .'* Group: Sub'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Sub: subscribe'."\n" .'* Pub|Sub: publish and subscribe'."\n" .'* Pub: publish'."\n", 'type' => 'array', 'items' => ['description' => 'The type of operations that can be performed on the resource.'."\n" ."\n" .'The following types of operations are supported based on the resource type:'."\n" ."\n" .'* Topic: Pub, Sub, and Pub|Sub'."\n" .'* Group: Sub'."\n", 'type' => 'string', 'required' => false, 'example' => 'Pub', 'title' => ''], 'required' => true, 'enumValueTitles' => ['Sub' => '订阅', 'Pub|Sub' => '发送订阅', 'Pub' => '发送'], 'example' => 'Pub', 'title' => '', ], 'ipWhitelists' => [ 'description' => 'The IP addresses in the whitelist.'."\n", 'type' => 'array', 'items' => ['description' => 'The IP address in the whitelist. IP addresses and CIDR blocks are supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0', 'title' => ''], 'required' => false, 'title' => '', ], ], 'required' => false, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5F88833'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The returned data.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'MissingInstanceId'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'title' => 'CreateInstanceAcl', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstanceAcl'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'rocketmq:CreateInstanceAcl', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7E8AE3A-219B-52EE-BE32-4036F5F88833\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', ], 'CreateInstanceIpWhitelist' => [ 'path' => '/instances/{instanceId}/ip/whitelist', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ 'ipWhitelists' => [ 'description' => 'The IP address whitelists.'."\n", 'type' => 'array', 'items' => ['description' => 'The IP address whitelist.'."\n", 'type' => 'string', 'required' => true, 'example' => '0.0.0.0/0', 'title' => ''], 'required' => true, 'title' => '', ], ], 'required' => false, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A07B41BD-6DD3-5349-9E76-00303DF04BBE'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The returned data.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'MissingInstanceId'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The instance cannot be found.'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A07B41BD-6DD3-5349-9E76-00303DF04BBE\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'CreateInstanceIpWhitelist', 'summary' => 'Creates an IP address whitelist.', 'translator' => 'machine', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstanceIpWhitelist'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'rocketmq:CreateInstanceIpWhitelist', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'CreateTopic' => [ 'summary' => 'Creates a topic in ApsaraMQ for RocketMQ. A topic is the primary container for message transmission and storage. It is used to categorize messages that share the same business logic. In the producer-consumer model, producers send messages to topics, and consumers subscribe to these topics to consume the messages.', 'path' => '/instances/{instanceId}/topics/{topicName}', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREonsHZ457W'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance to which the topic belongs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['description' => 'The name of the topic to create. The name identifies the topic and must be globally unique.'."\n" ."\n" .'The name must meet the following requirements:'."\n" ."\n" .'- The name can contain letters (a-z and A-Z), digits (0-9), underscores (\\_), and hyphens (-).'."\n" ."\n" .'- The name must be 1 to 60 characters in length.'."\n" ."\n" .'For information about reserved characters, see [Parameter limits](~~440347~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'topic_test'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The information about the topic.', 'type' => 'object', 'properties' => [ 'messageType' => [ 'description' => 'The message type of the topic to create.'."\n" ."\n" .'>'."\n" ."\n" .'The topic type must match the type of messages sent to it. For example, if you create a topic for ordered messages, the topic can be used only to send and receive ordered messages. You cannot use it for other message types.'."\n" ."\n" .'>', 'enumValueTitles' => ['TRANSACTION' => 'Transactional message', 'FIFO' => 'Ordered message', 'DELAY' => 'Scheduled and delayed message', 'NORMAL' => 'Normal message'], 'type' => 'string', 'required' => true, 'enum' => ['NORMAL', 'FIFO', 'DELAY', 'TRANSACTION', 'LITE'], 'title' => '', 'example' => 'NORMAL', ], 'remark' => ['description' => 'The remarks on the topic to create.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'This is the remark for test.'], 'maxSendTps' => ['description' => 'The maximum transactions per second (TPS) for sending messages.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1500', 'title' => ''], 'liteTopicExpiration' => ['description' => 'The time-to-live (TTL) for a lite topic, in minutes.'."\n" .'Valid values: 30 to 720.'."\n" .'The default value is -1, which indicates that the topic never expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'default' => '-1', 'title' => '', 'required' => false], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID. Each request has a unique ID that can be used to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => ['description' => 'The returned result.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'Topic.Existed'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The topic already exists.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '400'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'TopicName'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'topicName'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.Existed\\",\\n \\"message\\": \\"The topic already exists.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"TopicName\\",\\n \\"dynamicMessage\\": \\"topicName\\"\\n}","type":"json"}]', 'title' => 'CreateTopic', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTopic'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'rocketmq:CreateTopic', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'DeleteConsumerGroup' => [ 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', 'methods' => ['delete'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the instance from which you want to delete the consumer group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'consumerGroupId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the consumer group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'CID-TEST'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The response object.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.'."\n", 'type' => 'string', 'example' => 'C7F94090-3358-506A-97DC-34BC803C****'], 'success' => ['title' => '', 'description' => 'Indicates whether the call is successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The result data that is returned.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'InvalidConsumerGroupId'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Parameter consumerGroupId is invalid.'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'ConsumerGroupId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'consumerGroupId'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7F94090-3358-506A-97DC-34BC803C****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"InvalidConsumerGroupId\\",\\n \\"message\\": \\"Parameter consumerGroupId is invalid.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"ConsumerGroupId\\",\\n \\"dynamicMessage\\": \\"consumerGroupId\\"\\n}","type":"json"}]', 'title' => 'DeleteConsumerGroup', 'summary' => 'Deletes 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" .'After you delete a consumer group, the consumer client associated with the consumer group cannot consume messages. Exercise caution when you call this operation.'."\n", 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], ], ], 'DeleteConsumerGroupSubscription' => [ 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'consumerGroupId', 'in' => 'path', 'schema' => ['description' => 'The ID of the consumer group for which you want to delete subscriptions.'."\n", 'type' => 'string', 'required' => true, 'example' => 'CID-TEST', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'query', 'schema' => ['description' => 'The topic name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'topic_test', 'title' => ''], ], [ 'name' => 'filterType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the filter expression. Valid values:'."\n" ."\n" .'* SQL: filters messages by using SQL expressions.'."\n" .'* TAG: filters messages by using tags.', 'type' => 'string', 'required' => true, 'enumValueTitles' => ['TAG' => 'TAG过滤', 'SQL' => 'SQL过滤'], 'example' => 'TAG', 'title' => '', ], ], [ 'name' => 'filterExpression', 'in' => 'query', 'schema' => ['description' => 'The filter expression.'."\n", 'type' => 'string', 'required' => true, 'example' => '*', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '723CDA5C-E25C-5EAF-9601-******'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The returned data.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => '200'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"723CDA5C-E25C-5EAF-9601-******\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'DeleteConsumerGroupSubscription', 'summary' => 'Deletes the subscriptions of a consumer group.', 'translator' => 'machine', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConsumerGroupSubscription'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteConsumerGroupSubscription', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], ], ], 'DeleteDisasterRecoveryItem' => [ 'path' => '/disaster_recovery/{planId}/items/{itemId}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', 'schema' => ['description' => 'Backup plan ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016', 'title' => ''], ], [ 'name' => 'itemId', 'in' => 'path', 'schema' => ['description' => 'Backup mapping task ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100000650', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '0B962390-D84B-5D44-8C11-79DFxxxx'], 'success' => ['title' => '', 'description' => 'Whether the operation was successful', 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The return data', 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'DisasterRecoveryItemStatus.Error'], 'message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'The current status of the disaster recovery item does not support this operation.'], 'httpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'Dynamic error code', 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'Dynamic error message', 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'Access denied details, only in the scenario where the user is denied access due to RAM not having permission', 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B962390-D84B-5D44-8C11-79DFxxxx\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"DisasterRecoveryItemStatus.Error\\",\\n \\"message\\": \\"The current status of the disaster recovery item does not support this operation.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'DeleteDisasterRecoveryItem', 'summary' => 'Deletes a topic mapping of a Global Replicator task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDisasterRecoveryItem'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:DeleteDisasterRecoveryItem', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'DeleteDisasterRecoveryPlan' => [ 'path' => '/disaster_recovery/{planId}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', 'schema' => ['description' => 'The ID of the global message backup plan.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'."\n"], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The data returned.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'DisasterRecoveryPlanStatus.Error'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The current status of the disaster recovery plan does not support this operation.'], 'httpStatusCode' => ['title' => '', 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\\\n\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"DisasterRecoveryPlanStatus.Error\\",\\n \\"message\\": \\"The current status of the disaster recovery plan does not support this operation.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'DeleteDisasterRecoveryPlan', 'summary' => 'Deletes a global message backup plan.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDisasterRecoveryPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:DeleteDisasterRecoveryPlan', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'DeleteInstance' => [ 'path' => '/instances/{instanceId}', 'methods' => ['delete'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the ApsaraMQ for RocketMQ instance that you want to delete.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody0129'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '048242AA-BADA-5F29-B2CD-ED9FA344467F'], 'success' => ['title' => '', 'description' => 'Indicates whether the call was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The returned result.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code returned if the call failed.'."\n", 'type' => 'string', 'example' => 'MissingInstanceId'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"048242AA-BADA-5F29-B2CD-ED9FA344467F\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'DeleteInstance', 'summary' => 'Releases an 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" .'* After an instance is deleted, the instance cannot be restored. Exercise caution when you call this operation.'."\n" .'* This operation is used to delete a pay-as-you-go instance. A subscription instance is automatically released after it expires. You do not need to manually delete a subscription instance.'."\n", 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'DeleteInstanceAccount' => [ 'path' => '/instances/{instanceId}/accounts/{username}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'username', 'in' => 'path', 'schema' => ['description' => 'Account name', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '请求ID', 'description' => 'The request ID.'."\n" ."\n", 'type' => 'string', 'example' => '157DF7D4-53FB-58C6-BEBC-A9400E7EF68A'], 'success' => ['title' => '是否成功', 'description' => 'Indicates whether the request was successful.'."\n" ."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '返回结果', 'description' => 'The returned data.'."\n" ."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '错误码', 'description' => 'The error code.'."\n" ."\n", 'type' => 'string', 'example' => 'Instance.NotFound'], 'message' => ['title' => '错误信息', 'description' => 'The error message.'."\n" ."\n", 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'The HTTP status code.'."\n" ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '动态错误码', 'description' => 'The dynamic error code.'."\n" ."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '动态错误信息', 'description' => 'The dynamic error message.'."\n" ."\n", 'type' => 'string', 'example' => 'InstanceId'], 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.', 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"157DF7D4-53FB-58C6-BEBC-A9400E7EF68A\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Instance.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'DeleteInstanceAccount', 'summary' => 'Delete access control ACL user', 'translator' => 'machine', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstanceAccount'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteInstanceAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'DeleteInstanceAcl' => [ 'path' => '/instances/{instanceId}/acl/account/{username}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'username', 'in' => 'path', 'schema' => ['description' => 'The username of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'resourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the resource on which the permissions are granted.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Group'."\n" .'* Topic'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], 'example' => 'Topic', 'title' => '', ], ], [ 'name' => 'resourceName', 'in' => 'query', 'schema' => ['description' => 'The name of the resource on which the permissions are granted.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7358418D-83BD-507A-8079-*****'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The returned data.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'MissingInstanceId'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The instance cannot be found.'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied due to the reason that the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7358418D-83BD-507A-8079-*****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'DeleteInstanceAcl', 'summary' => 'Deletes the permissions of a specific account of an instance.', 'translator' => 'machine', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteInstanceAcl', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'DeleteInstanceIpWhitelist' => [ 'path' => '/instances/{instanceId}/ip/whitelist', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '209878', 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'ipWhitelist', 'in' => 'query', 'schema' => ['description' => 'The IP address whitelist.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '0.0.0.0/0', 'title' => ''], ], [ 'name' => 'ipWhitelists', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'string', 'required' => false, 'description' => 'The IP address whitelist.', 'example' => '0.0.0.0/0'."\n", 'title' => ''], 'required' => false, 'description' => 'The IP address whitelist.', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '16425867-C948-5A0C-9A24-5259727BE727'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The returned data.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'MissingInstanceId'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied due to the reason that the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"16425867-C948-5A0C-9A24-5259727BE727\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'DeleteInstanceIpWhitelist', 'summary' => 'Deletes a specific IP address whitelist from an instance.', 'translator' => 'machine', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteInstanceIpWhitelist', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'DeleteTopic' => [ 'path' => '/instances/{instanceId}/topics/{topicName}', 'methods' => ['delete'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the instance to which the topic belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The name of the topic.'."\n", 'type' => 'string', 'required' => true, 'example' => 'topic_test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The response object.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.'."\n", 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['title' => '', 'description' => 'Indicates whether the call is successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The result data that is returned.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Topic.NotFound'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The topic cannot be found.'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'TopicName'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'topicName'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic cannot be found.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"TopicName\\",\\n \\"dynamicMessage\\": \\"topicName\\"\\n}","type":"json"}]', 'title' => 'DeleteTopic', 'summary' => 'Deletes a specified topic.', 'description' => 'If you delete the topic, the publishing and subscription relationships that are established based on the topic are cleared. Exercise caution when you call this operation.'."\n", 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteTopic', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'ExecuteMigrationOperation' => [ 'summary' => 'Executes a specified operation on a migration task.', 'path' => '/migrations/{migrationId}/stages/{stageType}/operations/{operationId}/execute', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'migrationId', 'in' => 'path', 'schema' => ['description' => 'The migration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '44', 'title' => ''], ], [ 'name' => 'instanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-x0r37kel***', 'title' => ''], ], [ 'name' => 'stageType', 'in' => 'path', 'schema' => [ 'description' => 'The migration stage type.', 'enumValueTitles' => ['MIGRATE_MESSAGE' => 'message migration'], 'type' => 'string', 'required' => true, 'example' => 'MIGRATE_MESSAGE', 'title' => '', ], ], [ 'name' => 'operationId', 'in' => 'path', 'schema' => ['description' => 'The migration operation ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2729', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'operationParam' => [ 'title' => '', 'description' => 'The operation parameters.', 'type' => 'object', 'properties' => [ 'paramData' => ['description' => 'The parameters for the operation, provided as a JSON string. See the example for details.'."\n" ."\n" .'The action (operation) field accepts the following values:'."\n" ."\n" .'- MIGRATE\\_FORWARD (fast-forward migration)'."\n" ."\n" .'- MIGRATE\\_BACKWARD (backward migration)'."\n" ."\n" .'The targetStage field accepts the following values:'."\n" ."\n" .'- MIGRATE\\_WAIT (Read from and write to the source cluster)'."\n" ."\n" .'- DOUBLE\\_READ (Write to the source cluster and perform redundant reads)'."\n" ."\n" .'- SWITCH\\_WRITE (Write to the destination cluster and perform redundant reads)'."\n" ."\n" .'- MIGRATE\\_FINISH (Read from and write to the destination cluster)'."\n" ."\n" .'> * For a fast-forward migration, you can only advance one stage at a time.'."\n" .'>'."\n" .'> * For a backward migration, you can roll back to any previous stage.', 'type' => 'any', 'example' => 'Migrate forward: {"action":"MIGRATE_FORWARD","targetStage":"MIGRATE_FINISH"}'."\n" ."\n" .'Migrate backward: {"action":"MIGRATE_BACKWARD","targetStage":"MIGRATE_WAIT"}', 'title' => '', 'required' => false], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'description' => 'The request body.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '814BCD66-2D76-5080-AAD2-E50E5BDB0995'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'operationId' => ['description' => 'The migration operation ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '110'], 'migrationId' => ['description' => 'The migration ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '6'], 'stageType' => [ 'description' => 'The migration stage type.', 'enumValueTitles' => ['MIGRATE_MESSAGE' => 'Migrate messages.'], 'type' => 'string', 'title' => '', 'example' => 'MIGRATE_MESSAGE', ], 'operationType' => ['description' => 'The operation type.', 'type' => 'string', 'title' => '', 'example' => 'MIGRATE_MESSAGE'], 'operationStatus' => [ 'description' => 'The operation status:', 'enumValueTitles' => ['INIT' => 'The operation has not started.', 'DONE' => 'The operation is complete.', 'DOING' => 'The operation is in progress.', 'FAIL' => 'The operation has failed.'], 'type' => 'string', 'title' => '', 'example' => 'DOING', ], 'operationKey' => ['description' => 'The primary key of the operation object.', 'type' => 'string', 'title' => '', 'example' => 'normal-topic-1'], 'businessStatus' => [ 'description' => 'The business status of the operation:', 'enumValueTitles' => ['MIGRATE_CHECK' => 'Reading from and writing to the source cluster.', 'SWITCH_WRITE' => 'Writing to the destination cluster and performing redundant reads.', 'MIGRATE_FINISH' => 'Reading from and writing to the destination cluster.', 'DOUBLE_READ' => 'Writing to the source cluster and performing redundant reads.', 'ALREADY_MIGRATED' => 'The object has been migrated.'], 'type' => 'string', 'title' => '', 'example' => 'MIGRATE_WAIT', ], 'operationParam' => [ 'title' => '', 'description' => 'The operation parameters.', 'type' => 'object', 'properties' => [ 'paramData' => ['description' => 'The parameter information.', 'type' => 'any', 'title' => '', 'example' => '{"action":"MIGRATE_FORWARD","targetStage":"MIGRATE_FINISH"}'], ], 'example' => '', ], 'operationResult' => [ 'title' => '', 'description' => 'The operation result.', 'type' => 'object', 'properties' => [ 'resultData' => ['description' => 'The detailed result of the operation.', 'type' => 'any', 'title' => '', 'example' => '{'."\n" .' "checkStatus": "WAIT_CHECK",'."\n" .' "sourceTopicStatus": "PERM_6",'."\n" .' "targetTopicStatus": "PERM_4",'."\n" .' "checkResult": {},'."\n" .' "migrateStage": "DOUBLE_READ"'."\n" .'}'], ], 'example' => '', ], 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 20:05:50'], 'updateTime' => ['description' => 'The time when the operation was last updated.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 20:05:50'], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'Topic.NotFound'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The topic already exists.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"814BCD66-2D76-5080-AAD2-E50E5BDB0995\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"operationId\\": 110,\\n \\"migrationId\\": 6,\\n \\"stageType\\": \\"MIGRATE_MESSAGE\\",\\n \\"operationType\\": \\"MIGRATE_MESSAGE\\",\\n \\"operationStatus\\": \\"DOING\\",\\n \\"operationKey\\": \\"normal-topic-1\\",\\n \\"businessStatus\\": \\"MIGRATE_WAIT\\",\\n \\"operationParam\\": {\\n \\"paramData\\": \\"{\\\\\\"action\\\\\\":\\\\\\"MIGRATE_FORWARD\\\\\\",\\\\\\"targetStage\\\\\\":\\\\\\"MIGRATE_FINISH\\\\\\"}\\"\\n },\\n \\"operationResult\\": {\\n \\"resultData\\": \\"{\\\\n \\\\\\"checkStatus\\\\\\": \\\\\\"WAIT_CHECK\\\\\\",\\\\n \\\\\\"sourceTopicStatus\\\\\\": \\\\\\"PERM_6\\\\\\",\\\\n \\\\\\"targetTopicStatus\\\\\\": \\\\\\"PERM_4\\\\\\",\\\\n \\\\\\"checkResult\\\\\\": {},\\\\n \\\\\\"migrateStage\\\\\\": \\\\\\"DOUBLE_READ\\\\\\"\\\\n}\\"\\n },\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\"\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic already exists.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'ExecuteMigrationOperation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:ExecuteMigrationOperation', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'translator' => 'machine', ], 'FinishMigrationStage' => [ 'summary' => 'Completes the current migration stage for a specified migration task.', 'path' => '/migrations/{migrationId}/stages/{stageType}/finish', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'migrationId', 'in' => 'path', 'schema' => ['description' => 'The migration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'instanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-pe334f1nx04', 'title' => ''], ], [ 'name' => 'stageType', 'in' => 'path', 'schema' => [ 'description' => 'The type of the migration stage. The value MIGRATE\\_MESSAGE indicates message migration.', 'enumValueTitles' => ['MIGRATE_MESSAGE' => 'Message migration.'], 'type' => 'string', 'required' => true, 'example' => 'MIGRATE_MESSAGE', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '16425867-C948-5A0C-9A24-5259727BE727'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => ['description' => 'The returned result.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'InvalidConsumerGroupId'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"16425867-C948-5A0C-9A24-5259727BE727\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"InvalidConsumerGroupId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'FinishMigrationStage', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:FinishMigrationStage', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'GetConsumeTimespan' => [ 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeTimespan/{topicName}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREons0MOUAZ'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'consumerGroupId', 'in' => 'path', 'schema' => ['description' => 'The ID of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'CID-TEST', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['description' => 'The name of the topic to which the consumer group subscribes.', 'type' => 'string', 'required' => true, 'example' => 'topicxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'instanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****', 'title' => ''], 'topicName' => ['description' => 'The topic to which the consumer group subscribes.', 'type' => 'string', 'example' => 'topic_test', 'title' => ''], 'consumerGroupId' => ['description' => 'The ID of the consumer group.', 'type' => 'string', 'example' => 'CID-TEST', 'title' => ''], 'minTimestamp' => ['description' => 'The production time of the earliest message in the topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026222', 'title' => ''], 'maxTimestamp' => ['description' => 'The production time of the latest message in the topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026833', 'title' => ''], 'consumeTimestamp' => ['description' => 'The last time the consumer group consumed a message from this topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026400', 'title' => ''], ], 'title' => '', 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MissingInstanceId', 'title' => ''], 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetConsumeTimespan', 'summary' => 'Queries the time range in which a consumer offset can be reset for a topic.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetConsumeTimespan', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}/consumergroup/{#ConsumerGroupId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C115601B-8736-5BBF-AC99-7FEAE1245A80\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"minTimestamp\\": 1570761026222,\\n \\"maxTimestamp\\": 1570761026833,\\n \\"consumeTimestamp\\": 1570761026400\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"xxx\\",\\n \\"dynamicMessage\\": \\"xxx\\"\\n}","type":"json"}]', ], 'GetConsumerGroup' => [ 'summary' => 'Retrieves the details of a specified consumer group.', 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '144684', 'abilityTreeNodes' => ['FEATUREonsJCXOZ6'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance that contains the consumer group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'consumerGroupId', 'in' => 'path', 'schema' => ['description' => 'The ID of the consumer group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'CID-TEST'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The unique ID for the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'C7F94090-3358-506A-97DC-34BC803C****'], 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The ID of the region to which the instance belongs.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], 'instanceId' => ['description' => 'The ID of the instance to which the consumer group belongs.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-7e22ody****'], 'consumerGroupId' => ['description' => 'The ID of the consumer group.', 'type' => 'string', 'title' => '', 'example' => 'CID-TEST'], 'status' => [ 'description' => 'The state of the consumer group.', 'enumValueTitles' => ['RUNNING' => 'The consumer group is running.', 'CREATING' => 'The consumer group is being created.'], 'type' => 'string', 'enum' => ['CREATING', 'RUNNING'], 'title' => '', 'example' => 'RUNNING', ], 'remark' => ['description' => 'The remarks on the consumer group.', 'type' => 'string', 'title' => '', 'example' => 'This is the remark for test.'], 'createTime' => ['description' => 'The time when the consumer group was created.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 20:05:50'], 'updateTime' => ['description' => 'The time when the consumer group was last updated.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 20:05:50'], 'deliveryOrderType' => [ 'description' => 'The message delivery order for the consumer group.', 'enumValueTitles' => ['Concurrently' => 'Concurrent delivery', 'Orderly' => 'Orderly delivery'], 'type' => 'string', 'enum' => ['Orderly', 'Concurrently'], 'title' => '', 'example' => 'Concurrently', ], 'consumeRetryPolicy' => [ 'title' => '', 'description' => 'The consumption retry policy. For more information, see'."\n" .'[Consumption retry](~~440356~~).', 'type' => 'object', 'properties' => [ 'retryPolicy' => [ 'description' => 'The retry policy.', 'enumValueTitles' => ['FixedRetryPolicy' => 'fixed-interval retry', 'DefaultRetryPolicy' => 'backoff retry'], 'type' => 'string', 'enum' => ['DefaultRetryPolicy', 'FixedRetryPolicy'], 'title' => '', 'example' => 'DefaultRetryPolicy', ], 'maxRetryTimes' => ['description' => 'The maximum number of retries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '16'], 'deadLetterTargetTopic' => ['description' => 'The dead-letter topic.'."\n" ."\n" .'If a message fails to be consumed after the maximum number of retries, it is sent to a dead-letter topic. You can use the dead-letter topic for business recovery or message tracing. For more information, see [Consumption retry and dead-letter messages](~~440356~~).', 'type' => 'string', 'example' => 'DLQ_mqtest', 'title' => ''], 'fixedIntervalRetryTime' => ['description' => 'The fixed retry interval, in seconds. The valid value ranges are:'."\n" ."\n" .'- Concurrent delivery: 10 to 1,800'."\n" ."\n" .'- Orderly delivery: 1 to 600', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], 'example' => '', ], 'maxReceiveTps' => ['description' => 'The maximum transactions per second (TPS) for message consumption.', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', 'title' => ''], 'messageModel' => ['description' => 'The consumption mode. Valid values:'."\n" ."\n" .'- CLUSTERING: clustering'."\n" ."\n" .'- BROADCASTING: broadcasting', 'type' => 'string', 'example' => 'LITE_SELECTIVE', 'title' => ''], 'topicName' => ['description' => 'The name of the topic.', 'type' => 'string', 'example' => 'test1', 'title' => ''], 'exclusive' => ['description' => 'Indicates whether exclusive consumption is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'InvalidConsumerGroupId'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Parameter consumerGroupId is invalid.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '400'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'ConsumerGroupId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'consumerGroupId'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7F94090-3358-506A-97DC-34BC803C****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"remark\\": \\"This is the remark for test.\\",\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\",\\n \\"deliveryOrderType\\": \\"Concurrently\\",\\n \\"consumeRetryPolicy\\": {\\n \\"retryPolicy\\": \\"DefaultRetryPolicy\\",\\n \\"maxRetryTimes\\": 16,\\n \\"deadLetterTargetTopic\\": \\"DLQ_mqtest\\",\\n \\"fixedIntervalRetryTime\\": 20\\n },\\n \\"maxReceiveTps\\": 2000,\\n \\"messageModel\\": \\"LITE_SELECTIVE\\",\\n \\"topicName\\": \\"test1\\",\\n \\"exclusive\\": false\\n },\\n \\"code\\": \\"InvalidConsumerGroupId\\",\\n \\"message\\": \\"Parameter consumerGroupId is invalid.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"ConsumerGroupId\\",\\n \\"dynamicMessage\\": \\"consumerGroupId\\"\\n}","type":"json"}]', 'title' => 'GetConsumerGroup', 'description' => '>'."\n" ."\n" .'The Alibaba Cloud OpenAPI is a control plane API for managing and querying cloud resources. We recommend that you integrate this API for control plane tasks only. Do not rely on OpenAPI for core data paths that send and receive messages, as this can introduce risks to your service.'."\n" ."\n" .'>', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConsumerGroup'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], ], ], 'GetConsumerGroupLag' => [ 'summary' => 'Queries the message accumulation of a consumer group.', 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/lag', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '145824', 'abilityTreeNodes' => ['FEATUREonsJCXOZ6'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-2r42vrvde0j', 'title' => ''], ], [ 'name' => 'consumerGroupId', 'in' => 'path', 'schema' => ['description' => 'The consumer group ID.', 'type' => 'string', 'required' => true, 'example' => 'CID-TEST', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'query', 'schema' => ['description' => 'The name of the topic to which the consumer group subscribes.', 'type' => 'string', 'required' => false, 'example' => 'normal-topic-1', 'title' => ''], ], [ 'name' => 'liteTopicName', 'in' => 'query', 'schema' => ['description' => 'The name of the lite topic.', 'type' => 'string', 'example' => 'abc', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result\\', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F5764C40-FB8C-53AE-B95D-96AB3D0E9375'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-7e22ody****'], 'consumerGroupId' => ['description' => 'The consumer group ID.', 'type' => 'string', 'title' => '', 'example' => 'CID-TEST'], 'totalLag' => [ 'title' => '', 'description' => 'The total message accumulation.', 'type' => 'object', 'properties' => [ 'readyCount' => ['description' => 'The number of ready messages.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'inflightCount' => ['description' => 'The number of inflight messages.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'deliveryDuration' => ['description' => 'The delivery latency. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12'], 'lastConsumeTimestamp' => ['description' => 'The timestamp of the last consumption.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1735629607846'], ], 'example' => '', ], 'topicLagMap' => [ 'title' => '', 'description' => 'The message accumulation for each topic.', 'type' => 'object', 'additionalProperties' => [ 'type' => 'object', 'properties' => [ 'readyCount' => ['description' => 'The number of ready messages.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'inflightCount' => ['description' => 'The number of inflight messages.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'deliveryDuration' => ['description' => 'The delivery latency. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12'], 'lastConsumeTimestamp' => ['description' => 'The timestamp of the last consumption.', 'type' => 'integer', 'format' => 'int64', 'example' => '1735629607846', 'title' => ''], ], 'description' => 'The message accumulation details.', 'title' => '', 'example' => '', ], 'example' => '', ], 'topicName' => ['description' => 'The name of the subscribed topic.', 'type' => 'string', 'example' => 'test1', 'title' => ''], 'liteTopicLagMap' => [ 'type' => 'object', 'additionalProperties' => [ 'type' => 'object', 'properties' => [ 'readyCount' => ['description' => 'The number of accumulated messages.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''], 'deliveryDuration' => ['description' => 'The delivery latency. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], ], 'title' => '', 'description' => 'The message accumulation for the lite topic.', 'example' => '', ], 'description' => 'The message accumulation for lite topics.', 'title' => '', 'example' => '', ], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'Topic.NotFound'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F5764C40-FB8C-53AE-B95D-96AB3D0E9375\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"totalLag\\": {\\n \\"readyCount\\": 1,\\n \\"inflightCount\\": 1,\\n \\"deliveryDuration\\": 12,\\n \\"lastConsumeTimestamp\\": 1735629607846\\n },\\n \\"topicLagMap\\": {\\n \\"key\\": {\\n \\"readyCount\\": 1,\\n \\"inflightCount\\": 1,\\n \\"deliveryDuration\\": 12,\\n \\"lastConsumeTimestamp\\": 1735629607846\\n }\\n },\\n \\"topicName\\": \\"test1\\",\\n \\"liteTopicLagMap\\": {\\n \\"key\\": {\\n \\"readyCount\\": 300,\\n \\"deliveryDuration\\": 30\\n }\\n }\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'GetConsumerGroupLag', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConsumerGroupLag'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetConsumerGroupLag', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], ], ], 'GetConsumerGroupSubscription' => [ 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions/{topicName}', 'methods' => ['get'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-uqm32kqyy11', 'title' => ''], ], [ 'name' => 'consumerGroupId', 'in' => 'path', 'schema' => ['description' => 'The ID of the consumer group whose subscriptions you want to query.'."\n", 'type' => 'string', 'required' => true, 'example' => 'common_dev', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['description' => 'The name of the topic to which the consumer group subscribes.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mq003', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '157DF7D4-53FB-58C6-BEBC-A9400E7EF68A'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The data returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The subscriptions.'."\n", 'type' => 'object', 'properties' => [ 'subscriptionDTO' => [ 'description' => 'The subscription details.'."\n", 'type' => 'object', 'properties' => [ 'consumerGroupId' => ['title' => '', 'description' => 'The consumer group ID.'."\n", 'type' => 'string', 'example' => 'GID_inspector_group'], 'topicName' => ['title' => '', 'description' => 'The topic to which the consumer group subscribes.'."\n", 'type' => 'string', 'example' => 'Topic_normal_inspector'], 'messageModel' => ['title' => '', 'description' => 'The consumption mode of the consumer group. Valid values:'."\n" ."\n" .'* BROADCASTING: broadcasting consumption'."\n" .'* CLUSTERING: clustering consumption'."\n", 'type' => 'string', 'example' => 'BROADCASTING'], 'subscriptionStatus' => ['title' => '', 'description' => 'The subscription status. Valid values:'."\n" ."\n" .'* ONLINE: The consumer group is online. If the consumer group contains multiple consumers, this value is returned if at least one of the consumers is online.'."\n" .'* OFFLINE: The consumer group is offline. If the consumer group contains multiple consumers, this value is returned only if all consumers are offline.'."\n", 'type' => 'string', 'example' => 'ONLINE'], 'filterExpression' => ['title' => '', 'description' => 'The filter expression.'."\n", 'type' => 'string', 'example' => '*'], 'filterExpressionType' => ['title' => '', 'description' => 'The type of the filter expression. Valid values:'."\n" ."\n" .'* SQL: filters messages by using SQL expressions.'."\n" .'* TAG: filters messages by using tags.'."\n", 'type' => 'string', 'example' => 'UNSPECIFIED'], ], 'title' => '', ], 'connectionDTO' => [ 'description' => 'The connection details.'."\n", 'type' => 'object', 'properties' => [ 'clientId' => ['title' => '', 'description' => 'The client ID.'."\n", 'type' => 'string', 'example' => '192.168.50.191@19908#-2093249153#1534215565#40385215750900'], 'hostname' => ['title' => '', 'description' => 'The host name.'."\n", 'type' => 'string', 'example' => 'nginx'], 'egressIp' => ['title' => '', 'description' => 'The public IP address of the host.'."\n", 'type' => 'string', 'example' => 'xx.xx.xx.xx'], 'language' => ['title' => '', 'description' => 'The language used by the client.'."\n", 'type' => 'string', 'example' => 'zh'], 'version' => ['title' => '', 'description' => 'The client version.'."\n", 'type' => 'string', 'example' => '1.0.0'], 'messageModel' => ['title' => '', 'description' => 'The consumption mode of the consumer group. Valid values:'."\n" ."\n" .'* BROADCASTING: broadcasting consumption'."\n" .'* CLUSTERING: clustering consumption'."\n", 'type' => 'string', 'example' => 'BROADCASTING'], ], 'title' => '', ], ], 'title' => '', ], ], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Instance.NotFound'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['title' => '', 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"157DF7D4-53FB-58C6-BEBC-A9400E7EF68A\\",\\n \\"success\\": true,\\n \\"data\\": [\\n {\\n \\"subscriptionDTO\\": {\\n \\"consumerGroupId\\": \\"GID_inspector_group\\",\\n \\"topicName\\": \\"Topic_normal_inspector\\",\\n \\"messageModel\\": \\"BROADCASTING\\",\\n \\"subscriptionStatus\\": \\"ONLINE\\",\\n \\"filterExpression\\": \\"*\\",\\n \\"filterExpressionType\\": \\"UNSPECIFIED\\"\\n },\\n \\"connectionDTO\\": {\\n \\"clientId\\": \\"192.168.50.191@19908#-2093249153#1534215565#40385215750900\\",\\n \\"hostname\\": \\"nginx\\",\\n \\"egressIp\\": \\"xx.xx.xx.xx\\",\\n \\"language\\": \\"zh\\",\\n \\"version\\": \\"1.0.0\\",\\n \\"messageModel\\": \\"BROADCASTING\\"\\n }\\n }\\n ],\\n \\"code\\": \\"Instance.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'GetConsumerGroupSubscription', 'summary' => 'Queries the subscriptions of a consumer group.', 'translator' => 'machine', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConsumerGroupSubscription'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetConsumerGroupSubscription', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], ], ], 'GetConsumerStack' => [ 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/stack', 'methods' => ['get'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-tl32upjeb08', 'title' => ''], ], [ 'name' => 'consumerGroupId', 'in' => 'path', 'schema' => ['description' => 'The consumer Group ID.', 'type' => 'string', 'required' => true, 'example' => 'GID_TT_TASK', 'title' => ''], ], [ 'name' => 'clientId', 'in' => 'query', 'schema' => ['description' => 'The client ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '172.26.76.48@Lqd7dImlp9KJ5V84', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30F2CBC7-F69D-5D78-9661-0254C9E1FBFA'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'regionId' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou'], 'instanceId' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], 'consumerGroupId' => ['title' => '', 'description' => 'The ID of the consumer group.'."\n", 'type' => 'string', 'example' => 'CID-TEST'], 'stacks' => [ 'title' => '', 'description' => 'Stack Information.', 'type' => 'array', 'items' => [ 'description' => 'Consume stack information.', 'type' => 'object', 'properties' => [ 'thread' => ['title' => '', 'description' => 'Thread id.', 'type' => 'string', 'example' => '123'], 'tracks' => [ 'title' => '', 'description' => 'Stack Information.', 'type' => 'array', 'items' => ['description' => 'Stack Information.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], ], 'title' => '', ], ], ], ], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Topic.NotFound'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The instance cannot be found.'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"30F2CBC7-F69D-5D78-9661-0254C9E1FBFA\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"stacks\\": [\\n {\\n \\"thread\\": \\"123\\",\\n \\"tracks\\": [\\n \\"xxx\\"\\n ]\\n }\\n ]\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'GetConsumerStack', 'summary' => 'Queries the stack information about a consumer.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConsumerStack'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetConsumerStack', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], ], ], 'GetDisasterRecoveryItem' => [ 'path' => '/disaster_recovery/{planId}/items/{itemId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225053', 'abilityTreeNodes' => ['FEATUREonsOVRH1R'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', 'schema' => ['description' => 'The ID of the global message backup plan.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016', 'title' => ''], ], [ 'name' => 'itemId', 'in' => 'path', 'schema' => ['description' => 'The ID of the topic mapping.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100070284', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'itemId' => ['description' => 'The ID of the topic mapping', 'type' => 'integer', 'format' => 'int64', 'example' => '100070284', 'title' => ''], 'planId' => ['title' => '', 'description' => 'The ID of the global message backup plan.', 'type' => 'integer', 'format' => 'int64', 'example' => '1300000016'], 'itemStatus' => ['title' => '', 'description' => 'The topic mapping task status.', 'type' => 'string', 'example' => 'RUNNING'], 'topics' => [ 'title' => '', 'description' => 'Topics included in the backup mapping', 'type' => 'array', 'items' => [ 'description' => 'Topics included in the backup mapping', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'regionId', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'instanceType' => ['title' => '', 'description' => 'Instance type'."\n" .' - ALIYUN_ROCKETMQ: Alibaba Cloud instance'."\n" .' - EXTERNAL_ROCKETMQ: External instance, open-source instance, open-source cluster', 'type' => 'string', 'example' => 'ALIYUN_ROCKETMQ'], 'instanceId' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rmq-cn-wwo3xxx'], 'topicName' => ['title' => '', 'description' => 'The topic name.'."\n", 'type' => 'string', 'example' => 'order_push_xxx'], 'consumerGroupId' => ['title' => '', 'description' => 'The consumer group ID.'."\n", 'type' => 'string', 'example' => 'xxx_reserve_group', 'deprecated' => true], 'deliveryOrderType' => [ 'description' => 'The order in which messages are delivered to the target instance. The parameter values ​​are as follows:'."\n" .' - Concurrently: concurrent delivery'."\n" .' - Orderly: sequential delivery', 'type' => 'string', 'enumValueTitles' => ['Concurrently' => '并发投递', 'Orderly' => '顺序投递'], 'example' => 'Concurrently', 'title' => '', ], ], 'title' => '', ], ], 'extInfo' => [ 'title' => '', 'description' => 'Additional Information', 'type' => 'object', 'additionalProperties' => ['type' => 'string', 'example' => '{}', 'description' => 'Additional Information', 'title' => ''], ], 'createTime' => ['title' => '', 'description' => 'The time when the topic mapping task was created.', 'type' => 'string', 'example' => '2024-06-24 02:57:31'], 'updateTime' => ['title' => '', 'description' => 'The time when the topic mapping task was last updated.', 'type' => 'string', 'example' => '2024-09-26 02:13:10'], ], ], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => '200'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'xxx'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n" ."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n" ."\n", 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"itemId\\": 100070284,\\n \\"planId\\": 1300000016,\\n \\"itemStatus\\": \\"RUNNING\\",\\n \\"topics\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceType\\": \\"ALIYUN_ROCKETMQ\\",\\n \\"instanceId\\": \\"rmq-cn-wwo3xxx\\",\\n \\"topicName\\": \\"order_push_xxx\\",\\n \\"consumerGroupId\\": \\"xxx_reserve_group\\",\\n \\"deliveryOrderType\\": \\"Concurrently\\"\\n }\\n ],\\n \\"extInfo\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"createTime\\": \\"2024-06-24 02:57:31\\",\\n \\"updateTime\\": \\"2024-09-26 02:13:10\\"\\n },\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'GetDisasterRecoveryItem', 'summary' => 'Queries the details of a topic mapping in a Global Replicator task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDisasterRecoveryItem'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetDisasterRecoveryItem', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'GetDisasterRecoveryPlan' => [ 'path' => '/disaster_recovery/{planId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225054', 'abilityTreeNodes' => ['FEATUREonsOVRH1R'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', 'schema' => ['description' => 'The ID of the Global Replicator task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7358418D-83BD-507A-8079-611C63E0xxx'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'planId' => ['title' => '', 'description' => 'The ID of the Global Replicator task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1300000016'], 'planName' => ['title' => '', 'description' => 'The name of the Global Replicator task.'."\n", 'type' => 'string', 'example' => 'xxx'], 'planDesc' => ['title' => '', 'description' => 'The description of the Global Replicator task.'."\n", 'type' => 'string', 'example' => 'xxxx'], 'planType' => ['title' => '', 'description' => 'The type of the Global Replicator task. Valid values:'."\n" ."\n" .'* ACTIVE_PASSIVE: one-way backup'."\n" .'* ACTIVE_ACTIVE: two-way backup'."\n", 'type' => 'string', 'example' => 'ACTIVE_PASSIVE'], 'planStatus' => ['title' => '', 'description' => 'The status of the Global Replicator task. Valid values:'."\n" ."\n" .'* CREATED'."\n" .'* RUNNING'."\n" .'* DELETED'."\n", 'type' => 'string', 'example' => 'RUNNING'], 'extInfo' => [ 'title' => '', 'description' => 'The extended information.'."\n", 'type' => 'object', 'additionalProperties' => ['type' => 'string', 'example' => 'xxxx', 'description' => 'The extended information.'."\n", 'title' => ''], ], 'instances' => [ 'title' => '', 'description' => 'The instances involved in the Global Replicator task.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance involved in the Global Replicator task.'."\n", 'type' => 'object', 'properties' => [ 'instanceType' => ['title' => '', 'description' => 'The instance type.'."\n", 'type' => 'string', 'example' => 'ALIYUN_ROCKETMQ'], 'regionId' => ['title' => '', 'description' => 'The ID of the region where the instance resides.'."\n", 'type' => 'string', 'example' => 'cn-shanghai'], 'instanceId' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rmq-cn-gpz3qtcdxxx'], 'instanceRole' => ['title' => '', 'description' => 'The instance role.'."\n", 'type' => 'string', 'example' => 'ACTIVE'], 'authType' => ['title' => '', 'description' => 'The authentication type.'."\n", 'type' => 'string', 'example' => 'ACL_AUTH'], 'username' => ['title' => '', 'description' => 'The username used for authentication.'."\n", 'type' => 'string', 'example' => 'xxx'], 'password' => ['title' => '', 'description' => 'The password used for authentication.'."\n", 'type' => 'string', 'example' => 'xxx'], 'endpointUrl' => ['title' => '', 'description' => 'The endpoint.'."\n", 'type' => 'string', 'example' => 'xxx'], 'networkType' => ['title' => '', 'description' => 'The network type.'."\n", 'type' => 'string', 'example' => 'TCP_INTERNET'], 'vpcId' => ['title' => 'VPC ID', 'description' => 'The virtual private cloud (VPC) ID.'."\n", 'type' => 'string', 'example' => 'vpc-wz9qt50xhtj9krb******'."\n"], 'vSwitchId' => ['title' => '', 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-uf6gwtbn6etadpv******'."\n"], 'messageProperty' => [ 'description' => 'The message attribute.'."\n", 'type' => 'object', 'properties' => [ 'propertyKey' => ['description' => 'The attribute key.'."\n", 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'propertyValue' => ['description' => 'The attribute value.'."\n", 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], 'title' => '', ], 'securityGroupId' => ['description' => 'The security group ID.'."\n", 'type' => 'string', 'example' => 'sg-bp17hpmgz9******'."\n", 'title' => ''], 'consumerGroupId' => ['description' => 'The consumer Group ID.', 'type' => 'string', 'example' => 'GID_DS_XXX_YYY', 'title' => ''], ], 'title' => '', ], ], 'createTime' => ['title' => '', 'description' => 'The time when the query task was created.'."\n", 'type' => 'string', 'example' => '2022-08-01 20:05:50'], 'updateTime' => ['title' => '', 'description' => 'The time when the query task was last modified.'."\n", 'type' => 'string', 'example' => '2022-08-01 20:05:50'], 'autoSyncCheckpoint' => [ 'description' => 'Indicates whether automatic consumer progress synchronization is enabled.'."\n" ."\n" .'> This parameter takes effect only when `syncCheckpointEnabled` is set to true.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], 'example' => 'true', 'title' => '', ], 'syncCheckpointEnabled' => [ 'description' => 'Indicates whether consumer progress synchronization is enabled.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], 'example' => 'true', 'title' => '', ], ], ], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => '200'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'xxx'], 'httpStatusCode' => ['title' => '', 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7358418D-83BD-507A-8079-611C63E0xxx\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"planId\\": 1300000016,\\n \\"planName\\": \\"xxx\\",\\n \\"planDesc\\": \\"xxxx\\",\\n \\"planType\\": \\"ACTIVE_PASSIVE\\",\\n \\"planStatus\\": \\"RUNNING\\",\\n \\"extInfo\\": {\\n \\"key\\": \\"xxxx\\"\\n },\\n \\"instances\\": [\\n {\\n \\"instanceType\\": \\"ALIYUN_ROCKETMQ\\",\\n \\"regionId\\": \\"cn-shanghai\\",\\n \\"instanceId\\": \\"rmq-cn-gpz3qtcdxxx\\",\\n \\"instanceRole\\": \\"ACTIVE\\",\\n \\"authType\\": \\"ACL_AUTH\\",\\n \\"username\\": \\"xxx\\",\\n \\"password\\": \\"xxx\\",\\n \\"endpointUrl\\": \\"xxx\\",\\n \\"networkType\\": \\"TCP_INTERNET\\",\\n \\"vpcId\\": \\"vpc-wz9qt50xhtj9krb******\\\\n\\",\\n \\"vSwitchId\\": \\"vsw-uf6gwtbn6etadpv******\\\\n\\",\\n \\"messageProperty\\": {\\n \\"propertyKey\\": \\"xxx\\",\\n \\"propertyValue\\": \\"xxx\\"\\n },\\n \\"securityGroupId\\": \\"sg-bp17hpmgz9******\\\\n\\",\\n \\"consumerGroupId\\": \\"GID_DS_XXX_YYY\\"\\n }\\n ],\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\",\\n \\"autoSyncCheckpoint\\": true,\\n \\"syncCheckpointEnabled\\": true\\n },\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'GetDisasterRecoveryPlan', 'summary' => 'Queries the details of a Global Replicator task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDisasterRecoveryPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetDisasterRecoveryPlan', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'GetInstance' => [ 'summary' => 'Retrieves the detailed information of a specified instance.', 'path' => '/instances/{instanceId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '147017', 'abilityTreeNodes' => ['FEATUREonsHF2FLP'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the instance to query.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique ID that can be used to troubleshoot issues.', 'type' => 'string', 'example' => '05AB7FBD-F1D3-5D87-BF78-BD782249****'], 'success' => ['title' => '', 'description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'regionId' => ['title' => '', 'description' => 'The region ID of the instance.', 'type' => 'string', 'example' => 'cn-hangzhou'], 'instanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], 'instanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'test instance'], 'status' => [ 'title' => '', 'description' => 'The instance status.', 'enumValueTitles' => ['RELEASED' => 'Released.', 'RUNNING' => 'Running.', 'STOPPED' => 'Stopped.', 'CHANGING' => 'Changing.', 'CREATING' => 'Creating.'], 'type' => 'string', 'enum' => ['CREATING', 'CHANGING', 'RUNNING', 'STOPPED', 'RELEASED'], 'example' => 'RUNNING', ], 'startTime' => ['title' => '', 'description' => 'The start time of the instance.', 'type' => 'string', 'example' => '2022-08-01 00:00:00'], 'expireTime' => ['title' => '', 'description' => 'The expiration time of the instance.', 'type' => 'string', 'example' => '2022-09-01 00:00:00'], 'releaseTime' => ['title' => '', 'description' => 'The release time of the instance.', 'type' => 'string', 'example' => '2022-09-07 00:00:00'], 'userId' => ['title' => '', 'description' => 'The ID of the user who owns the instance.', 'type' => 'string', 'example' => '111111111111111'], 'bid' => ['title' => '', 'description' => 'The sales channel BID of the commodity.', 'type' => 'string', 'example' => '26842'], 'commodityCode' => ['title' => '', 'description' => 'The commodity code of the ApsaraMQ for RocketMQ 5.x instance, such as ons_rmqsub_public_cn.', 'type' => 'string', 'example' => 'ons_rmqsub_public_cn'], 'serviceCode' => ['title' => '', 'description' => 'The service code of the instance. The service code for ApsaraMQ for RocketMQ is rmq.', 'type' => 'string', 'example' => 'rmq'], 'seriesCode' => [ 'title' => '', 'description' => 'The primary series code of the instance. For differences between primary series, see [Edition selection](~~444722~~).', 'enumValueTitles' => ['standard' => 'Standard Edition.', 'shared' => 'Shared Edition.', 'dedicated' => 'Dedicated Edition.', 'ultimate' => 'Platinum Edition.', 'professional' => 'Professional Edition.'], 'type' => 'string', 'example' => 'standard', ], 'subSeriesCode' => [ 'title' => '', 'description' => 'The sub-series code of the instance. For differences between sub-series, see [Edition selection](~~444722~~).', 'enumValueTitles' => ['serverless' => 'Serverless Edition.', 'cluster_ha' => 'Cluster high-availability Edition.', 'single_node' => 'Single-node Edition.'], 'type' => 'string', 'example' => 'cluster_ha', ], 'paymentType' => [ 'title' => '', 'description' => 'The payment type of the instance.', 'enumValueTitles' => ['PayAsYouGo' => 'Pay-as-you-go (postpaid).', 'Subscription' => 'Subscription (prepaid).'], 'type' => 'string', 'enum' => ['Subscription', 'PayAsYouGo'], 'example' => 'Subscription', ], 'remark' => ['title' => '', 'description' => 'The remark of the instance.', 'type' => 'string', 'example' => 'This is remark for instance.'], 'networkInfo' => [ 'title' => '', 'description' => 'The network information.', 'type' => 'object', 'properties' => [ 'vpcInfo' => [ 'title' => '', 'description' => 'The VPC information.', 'type' => 'object', 'properties' => [ 'vpcId' => ['title' => '', 'description' => 'The ID of the VPC associated with the instance.', 'type' => 'string', 'example' => 'vpc-uf6of9452b2pba82c****'], 'vSwitchId' => ['title' => '', 'description' => 'The ID of the vSwitch associated with the instance.'."\n" ."\n" .'This field is deprecated. Use the vSwitches field instead. For compatibility, this field returns only one vSwitch.>', 'type' => 'string', 'deprecated' => true, 'example' => 'vsw-uf6gwtbn6etadpvz7****'], 'vSwitches' => [ 'title' => '', 'description' => 'The list of vSwitches.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'vSwitchId' => ['title' => '', 'description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-uf6gwtbn6etadpvz7****'], 'zoneId' => ['title' => '', 'description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'securityGroupIds' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-hp35r2hc3a3sv8q2sb16', 'title' => ''], ], 'example' => '', ], 'endpoints' => [ 'title' => '', 'description' => 'The endpoint information.', 'type' => 'array', 'items' => [ 'description' => 'The endpoint information.', 'type' => 'object', 'properties' => [ 'endpointType' => [ 'title' => '', 'description' => 'The endpoint type of the instance.', 'enumValueTitles' => ['TCP_VPC' => 'VPC endpoint.', 'TCP_INTERNET' => 'Public endpoint.'], 'type' => 'string', 'enum' => ['TCP_INTERNET', 'TCP_VPC'], 'example' => 'TCP_INTERNET', ], 'endpointUrl' => ['title' => '', 'description' => 'The endpoint of the instance.', 'type' => 'string', 'example' => 'rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080'], 'ipWhitelist' => [ 'description' => 'The IP whitelist for public network access. Only public endpoints support IP whitelist configuration. VPC endpoints do not support this feature.'."\n" ."\n" .'- If no IP whitelist is configured, all IP address ranges are allowed to access the ApsaraMQ for RocketMQ server over the public network by default.'."\n" .'- If an IP whitelist is configured, only IP addresses in the whitelist are allowed to access the ApsaraMQ for RocketMQ server over the public network.'."\n" ."\n" .'This field is deprecated. Use the internetInfo.ipWhitelist field instead.', 'type' => 'array', 'items' => ['description' => 'The IP whitelist for public network access.', 'type' => 'string', 'example' => '192.168.x.x/24', 'title' => ''], 'example' => '192.168.x.x/24', 'title' => '', ], 'endpointId' => ['title' => '', 'description' => 'The associated PVL endpoint instance.', 'type' => 'string', 'example' => 'ep-bpxxx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'internetInfo' => [ 'title' => '', 'description' => 'The Internet information of the instance.', 'type' => 'object', 'properties' => [ 'internetSpec' => [ 'title' => '', 'description' => 'Specifies whether public network access is enabled.'."\n" ."\n" .'The instance supports VPC access by default. If public network access is enabled, ApsaraMQ for RocketMQ charges fees for public downstream bandwidth. For billing details, see [Public network access fees](~~427240~~).', 'enumValueTitles' => ['enable' => 'Public network access enabled.', 'disable' => 'Public network access disabled.'], 'type' => 'string', 'example' => 'enable', ], 'flowOutType' => [ 'title' => '', 'description' => 'The Internet billing type.', 'enumValueTitles' => ['payByBandwidth' => 'Fixed bandwidth billing. Set to this parameter value when public network access is enabled.', 'uninvolved' => 'Not applicable. Set to this parameter value when public network access is not enabled.'], 'type' => 'string', 'example' => 'payByBandwidth', ], 'flowOutBandwidth' => ['title' => '', 'description' => 'The Internet bandwidth specification. Unit: Mb/s.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'ipWhitelist' => [ 'title' => '', 'description' => 'The IP whitelist for public network access.'."\n" ."\n" .'- If no IP whitelist is configured, all IP address ranges are allowed to access the ApsaraMQ for RocketMQ server over the public network by default.'."\n" .'- If an IP whitelist is configured, only IP addresses in the whitelist are allowed to access the ApsaraMQ for RocketMQ server over the public network.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The IP whitelist for public network access.', 'type' => 'string', 'example' => '192.168.x.x/24'], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'accountInfo' => [ 'title' => '', 'description' => 'The account information.', 'type' => 'object', 'properties' => [ 'username' => ['title' => '', 'description' => 'The username of the instance. When accessing over the public network, you must configure the username and password of the instance in the SDK code for authentication.', 'type' => 'string', 'example' => '6W0xz2uPfiwp****'], ], 'example' => '', ], 'instanceQuotas' => [ 'title' => '', 'description' => 'The capacity information.', 'type' => 'array', 'items' => [ 'description' => 'The capacity information.', 'type' => 'object', 'properties' => [ 'quotaName' => [ 'title' => '', 'description' => 'The quota name of the instance.', 'enumValueTitles' => ['TOPIC_COUNT' => 'Topic creation quota of the instance.'], 'type' => 'string', 'example' => 'TOPIC_COUNT', ], 'usedCount' => ['title' => '', 'description' => 'The used count. Unit: count.', 'type' => 'number', 'format' => 'double', 'example' => '10'], 'freeCount' => ['title' => '', 'description' => 'The free quota. Unit: count.', 'type' => 'number', 'format' => 'double', 'example' => '20'], 'totalCount' => ['title' => '', 'description' => 'The total quota. Unit: count.', 'type' => 'number', 'format' => 'double', 'example' => '100'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'createTime' => ['title' => '', 'description' => 'The creation time of the instance.', 'type' => 'string', 'example' => '2022-08-01 00:00:00 '], 'updateTime' => ['title' => '', 'description' => 'The last update time of the instance.', 'type' => 'string', 'example' => '2022-08-02 00:00:00 '], 'extConfig' => [ 'title' => '', 'description' => 'The extended configuration. This field is deprecated. Use the productInfo, internetInfo, and aclInfo fields instead.', 'type' => 'object', 'properties' => [ 'aclType' => [ 'title' => '', 'description' => 'The authentication type of the instance.', 'enumValueTitles' => ['default' => 'Intelligent identity recognition.', 'apache_acl' => 'Apache RocketMQ ACL'], 'type' => 'string', 'enum' => ['default', 'aliyun_ram', 'apache_acl'], 'example' => 'default', ], 'sendReceiveRatio' => ['title' => '', 'description' => 'The ratio of message sending to receiving.', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], 'autoScaling' => [ 'title' => '', 'description' => 'Specifies whether burstable elastic capacity beyond the specification is enabled.'."\n" ."\n" .'This parameter takes effect only when the supportAutoScaling parameter is set to enable, which means the instance supports enabling elastic capacity.', 'enumValueTitles' => ['true' => 'Elastic capacity enabled.', 'false' => 'Elastic capacity disabled.'], 'type' => 'boolean', 'example' => 'true', ], 'messageRetentionTime' => ['title' => '', 'description' => 'The message retention period. Unit: hours.'."\n" ."\n" .'For the value range, see [Limits](~~440347~~) > Resource Quotas > Message retention period limits.'."\n" ."\n" .'The message storage of ApsaraMQ for RocketMQ is fully serverless and elastic, and fees are charged based on actual storage space. You can control the storage capacity by adjusting the message retention period. For more information, see [Storage fees](~~427238~~).', 'type' => 'integer', 'format' => 'int32', 'example' => '72'], 'supportAutoScaling' => [ 'title' => '', 'description' => 'Indicates whether the instance supports enabling burstable elastic capacity beyond the specification.'."\n" ."\n" .'After burstable elastic capacity is enabled, ApsaraMQ for RocketMQ allows the instance to exceed the base specification TPS limit within a certain range. Additional elastic specification fees are charged for the portion exceeding the base specification. For billing details, see [Computing fees](~~427237~~).'."\n" ."\n" .'> Only instances of certain specifications support enabling burstable elastic capacity. For supported instances, see [Instance specifications](~~444715~~).', 'enumValueTitles' => ['true' => 'Auto scaling supported.', 'false' => 'Auto scaling not supported.'], 'type' => 'boolean', 'example' => 'true', ], 'internetSpec' => [ 'title' => '', 'description' => 'Specifies whether public network access is enabled.'."\n" ."\n" .'The instance supports VPC access by default. If public network access is enabled, ApsaraMQ for RocketMQ charges fees for public downstream bandwidth. For billing details, see [Public network access fees](~~427240~~).', 'enumValueTitles' => ['enable' => 'Public network access enabled.', 'disable' => 'Public network access disabled.'], 'type' => 'string', 'enum' => ['enable', 'disable'], 'example' => 'enable', ], 'flowOutType' => [ 'title' => '', 'description' => 'The Internet billing type.', 'enumValueTitles' => ['payByTraffic' => 'Pay-by-traffic.', 'payByBandwidth' => 'Pay-by-bandwidth.', 'uninvolved' => 'Not applicable.'], 'type' => 'string', 'enum' => ['uninvolved', 'payByTraffic', 'payByBandwidth'], 'example' => 'payByBandwidth', ], 'flowOutBandwidth' => ['title' => '', 'description' => 'The Internet bandwidth specification. Unit: Mb/s.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'msgProcessSpec' => ['title' => '', 'description' => 'The message processing specification. For the specific TPS limits, see [Instance specifications](~~444715~~).', 'type' => 'string', 'example' => 'rmq.s2.2xlarge'], ], 'deprecated' => true, 'example' => '', ], 'resourceGroupId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfm3tmjruyribi'], 'productInfo' => [ 'title' => '', 'description' => 'The extended configuration of the instance.', 'type' => 'object', 'properties' => [ 'msgProcessSpec' => ['title' => '', 'description' => 'The message processing specification. For the specific TPS limits, see [Instance specifications](~~444715~~).', 'type' => 'string', 'example' => 'rmq.s2.2xlarge'], 'sendReceiveRatio' => ['title' => '', 'description' => 'The ratio of message sending to receiving.', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], 'autoScaling' => [ 'title' => '', 'description' => 'Specifies whether burstable elastic capacity beyond the specification is enabled.'."\n" ."\n" .'This parameter takes effect only when the supportAutoScaling parameter is set to enable, which means the instance supports enabling elastic capacity.', 'enumValueTitles' => ['true' => 'Elastic capacity enabled.', 'false' => 'Elastic capacity disabled.'], 'type' => 'boolean', 'example' => 'true', ], 'messageRetentionTime' => ['title' => '', 'description' => 'The message retention period. Unit: hours.'."\n" ."\n" .'For the value range, see [Limits](~~440347~~) > Resource Quotas > Message retention period limits.'."\n" ."\n" .'The message storage of ApsaraMQ for RocketMQ is fully serverless and elastic, and fees are charged based on actual storage space. You can control the storage capacity by adjusting the message retention period. For more information, see [Storage fees](~~427238~~).', 'type' => 'integer', 'format' => 'int32', 'example' => '72'], 'supportAutoScaling' => [ 'title' => '', 'description' => 'Indicates whether the instance supports enabling burstable elastic capacity beyond the specification.'."\n" ."\n" .'After burstable elastic capacity is enabled, ApsaraMQ for RocketMQ allows the instance to exceed the base specification TPS limit within a certain range. Additional elastic specification fees are charged for the portion exceeding the base specification. For billing details, see [Computing fees](~~427237~~).'."\n" ."\n" .'> Only instances of certain specifications support enabling burstable elastic capacity. For supported instances, see [Instance specifications](~~444715~~).', 'enumValueTitles' => ['true' => 'Auto scaling supported.', 'false' => 'Auto scaling not supported.'], 'type' => 'boolean', 'example' => 'true', ], 'traceOn' => ['description' => 'Specifies whether the message trace feature is enabled.'."\n" .'- true: The message trace feature is enabled.'."\n" .'- false: The message trace feature is disabled.'."\n" ."\n" .'This parameter does not take effect. Regardless of whether this parameter is enabled, the instance supports the message trace feature by default.'."\n" .'This parameter takes effect only for Serverless instances. If the message trace feature is enabled, message trace fees are incurred. For billing details, see [Serverless billing](~~2586280~~).'."\n" ."\n" .'For pay-as-you-go and subscription instances, this parameter does not take effect. The message trace feature is supported by default regardless of whether this parameter is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'storageEncryption' => ['title' => '', 'description' => 'Specifies whether storage encryption is enabled.', 'type' => 'boolean', 'example' => 'false'], 'storageSecretKey' => ['title' => '', 'description' => 'The storage encryption key.', 'type' => 'string', 'example' => 'xxxxx'], 'capacityType' => [ 'description' => 'The capacity mode.', 'enumValueTitles' => ['provisioned' => 'Provisioned + elastic.', 'ondemand' => 'Pay-as-you-go.'], 'type' => 'string', 'example' => 'provisioned', 'title' => '', ], 'provisionedCapacity' => ['description' => 'The provisioned capacity.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000', 'title' => ''], 'drReplicationMode' => ['title' => '', 'description' => 'The cross-region replication mode.', 'type' => 'string', 'example' => 'async_cross_az'], 'maxDelayTime' => ['description' => 'The maximum interval for scheduled messages. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '3456000', 'title' => ''], ], 'example' => '', ], 'aclInfo' => [ 'title' => '', 'description' => 'The access control information.', 'type' => 'object', 'properties' => [ 'aclTypes' => [ 'description' => 'The list of authentication types for the instance.', 'type' => 'array', 'items' => [ 'description' => 'The authentication type of the instance.', 'enumValueTitles' => ['default' => 'Intelligent identity recognition.', 'apache_acl' => 'ACL-based identity recognition.'], 'type' => 'string', 'example' => 'default', 'title' => '', ], 'title' => '', 'example' => '', ], 'defaultVpcAuthFree' => [ 'description' => 'The switch for VPC authentication-free access.', 'enumValueTitles' => ['true' => 'Enabled.', 'false' => 'Disabled.'], 'type' => 'boolean', 'example' => 'true', 'title' => '', ], 'aclType' => [ 'description' => 'The authentication type of the instance. This field is deprecated. Use the aclTypes field instead.', 'enumValueTitles' => ['default' => 'Intelligent identity recognition.', 'apache_acl' => 'ACL-based identity recognition.'], 'type' => 'string', 'deprecated' => true, 'example' => 'default', 'title' => '', ], ], 'example' => '', ], 'software' => [ 'title' => '', 'description' => 'The instance software information.', 'type' => 'object', 'properties' => [ 'softwareVersion' => ['title' => '', 'description' => 'The software version.', 'type' => 'string', 'example' => '5.0-rmq-20230619-1'], 'maintainTime' => ['title' => '', 'description' => 'The maintenance window for upgrades.', 'type' => 'string', 'deprecated' => true, 'example' => '02:00-06:00'], 'upgradeMethod' => [ 'title' => '', 'description' => 'The upgrade method.', 'enumValueTitles' => ['auto' => 'Automatic upgrade.', 'maunal' => 'Manual upgrade.'], 'type' => 'string', 'example' => 'auto', ], ], 'example' => '', ], 'topicCount' => ['title' => '', 'description' => 'The number of topics.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'groupCount' => ['title' => '', 'description' => 'The number of consumer groups.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'tags' => [ 'title' => '', 'description' => 'The list of resource tags.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The resource tag.', 'type' => 'object', 'properties' => [ 'key' => ['title' => '', 'description' => 'The tag key of the resource.', 'type' => 'string', 'example' => 'key'], 'value' => ['title' => '', 'description' => 'The tag value of the resource.', 'type' => 'string', 'example' => 'value'], ], 'example' => '', ], 'example' => '', ], 'autoRenew' => ['title' => '', 'description' => 'Indicates whether auto-renewal is enabled.', 'type' => 'boolean', 'example' => 'false'], 'autoRenewPeriod' => ['title' => '', 'description' => 'Indicates whether auto-renewal is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => 'false'], ], 'example' => '', ], 'code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'MissingInstanceId'], 'message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.', 'type' => 'string', 'example' => 'instanceId'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"05AB7FBD-F1D3-5D87-BF78-BD782249****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"instanceName\\": \\"test instance\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"startTime\\": \\"2022-08-01 00:00:00\\",\\n \\"expireTime\\": \\"2022-09-01 00:00:00\\",\\n \\"releaseTime\\": \\"2022-09-07 00:00:00\\",\\n \\"userId\\": \\"111111111111111\\",\\n \\"bid\\": \\"26842\\",\\n \\"commodityCode\\": \\"ons_rmqsub_public_cn\\",\\n \\"serviceCode\\": \\"rmq\\",\\n \\"seriesCode\\": \\"standard\\",\\n \\"subSeriesCode\\": \\"cluster_ha\\",\\n \\"paymentType\\": \\"Subscription\\",\\n \\"remark\\": \\"This is remark for instance.\\",\\n \\"networkInfo\\": {\\n \\"vpcInfo\\": {\\n \\"vpcId\\": \\"vpc-uf6of9452b2pba82c****\\",\\n \\"vSwitchId\\": \\"vsw-uf6gwtbn6etadpvz7****\\",\\n \\"vSwitches\\": [\\n {\\n \\"vSwitchId\\": \\"vsw-uf6gwtbn6etadpvz7****\\",\\n \\"zoneId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"securityGroupIds\\": \\"sg-hp35r2hc3a3sv8q2sb16\\"\\n },\\n \\"endpoints\\": [\\n {\\n \\"endpointType\\": \\"TCP_INTERNET\\",\\n \\"endpointUrl\\": \\"rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080\\",\\n \\"ipWhitelist\\": [\\n \\"192.168.x.x/24\\"\\n ],\\n \\"endpointId\\": \\"ep-bpxxx\\"\\n }\\n ],\\n \\"internetInfo\\": {\\n \\"internetSpec\\": \\"enable\\",\\n \\"flowOutType\\": \\"payByBandwidth\\",\\n \\"flowOutBandwidth\\": 1,\\n \\"ipWhitelist\\": [\\n \\"192.168.x.x/24\\"\\n ]\\n }\\n },\\n \\"accountInfo\\": {\\n \\"username\\": \\"6W0xz2uPfiwp****\\"\\n },\\n \\"instanceQuotas\\": [\\n {\\n \\"quotaName\\": \\"TOPIC_COUNT\\",\\n \\"usedCount\\": 10,\\n \\"freeCount\\": 20,\\n \\"totalCount\\": 100\\n }\\n ],\\n \\"createTime\\": \\"2022-08-01 00:00:00 \\",\\n \\"updateTime\\": \\"2022-08-02 00:00:00 \\",\\n \\"extConfig\\": {\\n \\"aclType\\": \\"default\\",\\n \\"sendReceiveRatio\\": 0.5,\\n \\"autoScaling\\": true,\\n \\"messageRetentionTime\\": 72,\\n \\"supportAutoScaling\\": true,\\n \\"internetSpec\\": \\"enable\\",\\n \\"flowOutType\\": \\"payByBandwidth\\",\\n \\"flowOutBandwidth\\": 10,\\n \\"msgProcessSpec\\": \\"rmq.s2.2xlarge\\"\\n },\\n \\"resourceGroupId\\": \\"rg-acfm3tmjruyribi\\",\\n \\"productInfo\\": {\\n \\"msgProcessSpec\\": \\"rmq.s2.2xlarge\\",\\n \\"sendReceiveRatio\\": 0.5,\\n \\"autoScaling\\": true,\\n \\"messageRetentionTime\\": 72,\\n \\"supportAutoScaling\\": true,\\n \\"traceOn\\": true,\\n \\"storageEncryption\\": false,\\n \\"storageSecretKey\\": \\"xxxxx\\",\\n \\"capacityType\\": \\"provisioned\\",\\n \\"provisionedCapacity\\": 3000,\\n \\"drReplicationMode\\": \\"async_cross_az\\",\\n \\"maxDelayTime\\": 3456000\\n },\\n \\"aclInfo\\": {\\n \\"aclTypes\\": [\\n \\"default\\"\\n ],\\n \\"defaultVpcAuthFree\\": true,\\n \\"aclType\\": \\"default\\"\\n },\\n \\"software\\": {\\n \\"softwareVersion\\": \\"5.0-rmq-20230619-1\\",\\n \\"maintainTime\\": \\"02:00-06:00\\",\\n \\"upgradeMethod\\": \\"auto\\"\\n },\\n \\"topicCount\\": 10,\\n \\"groupCount\\": 10,\\n \\"tags\\": [\\n {\\n \\"key\\": \\"key\\",\\n \\"value\\": \\"value\\"\\n }\\n ],\\n \\"autoRenew\\": false,\\n \\"autoRenewPeriod\\": 0\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'Get details of a specified instance', 'description' => '>The OpenAPI provided by Alibaba Cloud is a management and control API used to manage and query resources of Alibaba Cloud services. It is recommended only for integration in management and control paths. Using OpenAPI in the core data path for message sending and receiving is strictly prohibited, as it may introduce risks to the data link.>', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'GetInstanceAccount' => [ 'summary' => 'Retrieves the account details for a specified instance.', 'path' => '/instances/{instanceId}/account', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '150942', 'abilityTreeNodes' => ['FEATUREonsGA7IC4'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['title' => 'A short description of struct', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-20p36ja4m0y'], ], [ 'name' => 'username', 'in' => 'query', 'schema' => ['description' => 'The username.'."\n" ."\n" .'If you do not specify this parameter, the system returns details of the default account.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'B5C59E80-FCFC-5796-ABE4-D39EAAE578E4'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'username' => ['description' => 'The username.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'password' => ['description' => 'The account password.', 'type' => 'string', 'example' => '*************', 'title' => ''], 'accountStatus' => [ 'description' => 'The account status.', 'enumValueTitles' => ['DISABLE' => 'Disabled', 'ENABLE' => 'Enabled'], 'type' => 'string', 'example' => 'ENABLE', 'title' => '', ], 'remark' => ['description' => 'The remark.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MissingInstanceId', 'title' => ''], 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The instance cannot be found.', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'ConsumerGroupId', 'title' => ''], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'example' => 'instanceId', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B5C59E80-FCFC-5796-ABE4-D39EAAE578E4\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"username\\": \\"xxx\\",\\n \\"password\\": \\"*************\\",\\n \\"accountStatus\\": \\"ENABLE\\",\\n \\"remark\\": \\"test\\"\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"ConsumerGroupId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'GetInstanceAccount', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceAccount'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetInstanceAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'GetInstanceAcl' => [ 'path' => '/instances/{instanceId}/acl/account/{username}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '263406', 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'username', 'in' => 'path', 'schema' => ['description' => 'The username.'."\n", 'type' => 'string', 'required' => true, 'example' => 'abc', 'title' => ''], ], [ 'name' => 'resourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the resource on which you want to grant permissions.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Group'."\n" .'* Topic'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], 'example' => 'Topic', 'title' => '', ], ], [ 'name' => 'resourceName', 'in' => 'query', 'schema' => ['description' => 'The name of the resource on which you want to grant permissions.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID'."\n", 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'instanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rmq-cn-7e22ody****', 'title' => ''], 'aclType' => ['description' => 'The authentication type of the instance.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* apache_acl: open source access control list (ACL)'."\n" .'* default: the default account of the instance'."\n", 'type' => 'string', 'example' => 'apache_acl', 'title' => ''], 'username' => ['description' => 'The username.'."\n", 'type' => 'string', 'example' => 'abc', 'title' => ''], 'resourceType' => ['description' => 'The type of the resource on which the permissions are granted.'."\n", 'type' => 'string', 'example' => 'Topic', 'title' => ''], 'resourceName' => ['description' => 'The name of the resource on which the permissions are granted.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], 'decision' => ['description' => 'The decision result of the authorization.'."\n", 'type' => 'string', 'example' => 'Allow', 'title' => ''], 'actions' => [ 'description' => 'The type of operations that can be performed on the resource.'."\n", 'type' => 'array', 'items' => ['description' => 'The type of operation that can be performed on the resource.'."\n", 'type' => 'string', 'example' => 'Pub', 'title' => ''], 'title' => '', ], 'ipWhitelists' => [ 'description' => 'The IP address whitelists.'."\n", 'type' => 'array', 'items' => ['description' => 'The IP address whitelist. IP addresses and CIDR blocks are supported.'."\n", 'type' => 'string', 'example' => '0.0.0.0/0', 'title' => ''], 'title' => '', ], ], 'title' => '', ], 'code' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'MissingInstanceId', 'title' => ''], 'message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The instance cannot be found.', 'title' => ''], 'httpStatusCode' => ['description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'dynamicCode' => ['description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'dynamicMessage' => ['description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"aclType\\": \\"apache_acl\\",\\n \\"username\\": \\"abc\\",\\n \\"resourceType\\": \\"Topic\\",\\n \\"resourceName\\": \\"test\\",\\n \\"decision\\": \\"Allow\\",\\n \\"actions\\": [\\n \\"Pub\\"\\n ],\\n \\"ipWhitelists\\": [\\n \\"0.0.0.0/0\\"\\n ]\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"xxx\\",\\n \\"dynamicMessage\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'GetInstanceAcl', 'summary' => 'Queries information about the access control list (ACL) of an instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceAcl'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetInstanceAcl', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Acl', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'GetInstanceIpWhitelist' => [ 'path' => '/instances/{instanceId}/ip/whitelists', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '260123', 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'ipWhitelists', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'The filter IP address whitelists.', 'type' => 'array', 'items' => ['description' => 'The filter IP address whitelist.', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0', 'title' => ''], 'required' => false, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n" ."\n", 'type' => 'string', 'example' => '0B962390-D84B-5D44-8C11-79DF40299D41'], 'success' => ['description' => 'Indicates whether the call was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'instanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rmq-cn-7e22ody****', 'title' => ''], 'ipWhitelists' => [ 'description' => 'The IP address whitelists.', 'type' => 'array', 'items' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'example' => '0.0.0.0/0', 'title' => ''], 'title' => '', ], ], 'title' => '', ], 'code' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Instance.NotFound', 'title' => ''], 'message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'dynamicCode' => ['description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId', 'title' => ''], 'dynamicMessage' => ['description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId', 'title' => ''], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B962390-D84B-5D44-8C11-79DF40299D41\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"ipWhitelists\\": [\\n \\"0.0.0.0/0\\"\\n ]\\n },\\n \\"code\\": \\"Instance.NotFound\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'GetInstanceIpWhitelist', 'summary' => 'Queries the information about the IP address whitelist of an instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceIpWhitelist'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetInstanceIpWhitelist', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'IpWhitelist', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'GetMessageDetail' => [ 'summary' => 'Retrieves the details of a specific message.', 'path' => '/instances/{instanceId}/topics/{topicName}/messages/{messageId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREonsNPGYUW'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-lbj31fs790d', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'required' => true, 'example' => 'flink_test', 'title' => ''], ], [ 'name' => 'messageId', 'in' => 'path', 'schema' => ['description' => 'The ID of the message.', 'type' => 'string', 'required' => true, 'example' => '0A792FDB001F7591083D30ADB1DA11D5', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'FAEBD71F-E839-52F9-BD7B-8F1290525841'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The data that is returned.', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], 'instanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-7e22ody****'], 'topicName' => ['description' => 'The name of the topic.', 'type' => 'string', 'title' => '', 'example' => 'topic_test'], 'messageId' => ['description' => 'The ID of the message.', 'type' => 'string', 'title' => '', 'example' => '01BE87E485F0C7808C04543CAF00000001'], 'bornTime' => ['description' => 'The time when the message was generated.', 'type' => 'string', 'title' => '', 'example' => '2023-03-22 12:17:08'], 'storeTime' => ['description' => 'The time when the message was stored.', 'type' => 'string', 'title' => '', 'example' => '2023-03-22 12:17:08'], 'body' => ['description' => 'The body of the message.', 'type' => 'string', 'title' => '', 'example' => '{}'], 'bodySize' => ['description' => 'The size of the message body.', 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'title' => ''], 'bornHost' => ['description' => 'The host that generated the message.', 'type' => 'string', 'title' => '', 'example' => 'xxx.xx.xxx.xx'], 'storeHost' => ['description' => 'The host that stored the message.', 'type' => 'string', 'title' => '', 'example' => 'xxx.xx.xxx.xx'], 'messageType' => ['description' => 'The type of the message.', 'type' => 'string', 'title' => '', 'example' => 'NORMAL'], 'messageTag' => ['description' => 'The tags of the message.', 'type' => 'string', 'title' => '', 'example' => 'xx'], 'messageGroup' => ['description' => 'The sharding key. This parameter is returned only for ordered messages.', 'type' => 'string', 'title' => '', 'example' => 'xx'], 'messageKeys' => [ 'title' => '', 'description' => 'The business keys of the message.', 'type' => 'array', 'items' => ['description' => 'A business key.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], 'userProperties' => [ 'title' => '', 'description' => 'The user-defined properties of the message.', 'type' => 'object', 'additionalProperties' => ['description' => 'A user-defined property.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'example' => '', ], 'systemProperties' => [ 'description' => 'The default system properties of the message.', 'type' => 'object', 'additionalProperties' => ['description' => 'A default system property.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'liteTopicName' => ['description' => 'The name of the lightweight topic.', 'type' => 'string', 'example' => 'abc', 'title' => ''], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'Topic.NotFound'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FAEBD71F-E839-52F9-BD7B-8F1290525841\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageId\\": \\"01BE87E485F0C7808C04543CAF00000001\\",\\n \\"bornTime\\": \\"2023-03-22 12:17:08\\",\\n \\"storeTime\\": \\"2023-03-22 12:17:08\\",\\n \\"body\\": \\"{}\\",\\n \\"bodySize\\": 123,\\n \\"bornHost\\": \\"xxx.xx.xxx.xx\\",\\n \\"storeHost\\": \\"xxx.xx.xxx.xx\\",\\n \\"messageType\\": \\"NORMAL\\",\\n \\"messageTag\\": \\"xx\\",\\n \\"messageGroup\\": \\"xx\\",\\n \\"messageKeys\\": [\\n \\"xx\\"\\n ],\\n \\"userProperties\\": {\\n \\"key\\": \\"xxx\\"\\n },\\n \\"systemProperties\\": {\\n \\"key\\": \\"xx\\"\\n },\\n \\"liteTopicName\\": \\"abc\\"\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'GetMessageDetail', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMessageDetail'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetMessageDetail', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'GetTopic' => [ 'summary' => 'Retrieves the details of a specified topic.', 'path' => '/instances/{instanceId}/topics/{topicName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '144800', 'abilityTreeNodes' => ['FEATUREons8BETJT'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance to which the topic belongs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'topic_test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The ID of the request. This ID is unique to each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The ID of the region to which the instance belongs.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], 'instanceId' => ['description' => 'The ID of the instance to which the topic belongs.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-7e22ody****'], 'topicName' => ['description' => 'The name of the topic.', 'type' => 'string', 'title' => '', 'example' => 'topic_test'], 'messageType' => [ 'description' => 'The message type of the topic.', 'enumValueTitles' => ['TRANSACTION' => 'transactional message', 'FIFO' => 'ordered message', 'DELAY' => 'scheduled message or delayed message', 'NORMAL' => 'normal message'], 'type' => 'string', 'enum' => ['NORMAL', 'FIFO', 'DELAY', 'TRANSACTION'], 'title' => '', 'example' => 'NORMAL', ], 'status' => [ 'description' => 'The status of the topic.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- RUNNING: The topic is running.'."\n" ."\n" .'- CREATING: The topic is being created.', 'enumValueTitles' => ['RUNNING' => 'running', 'CREATING' => 'creating'], 'type' => 'string', 'enum' => ['CREATING', 'RUNNING'], 'title' => '', 'example' => 'RUNNING', ], 'remark' => ['description' => 'The remarks on the topic.', 'type' => 'string', 'title' => '', 'example' => 'This is the remark for test.'."\n"], 'createTime' => ['description' => 'The time when the topic was created.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 20:05:50'], 'updateTime' => ['description' => 'The time when the topic was last modified.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 20:05:50'], 'maxSendTps' => ['description' => 'The maximum transactions per second (TPS) for sending messages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'liteTopicExpiration' => ['description' => 'The expiration time of the lite topic. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'Topic.NotFound'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The topic cannot be found.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '400'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'TopicName'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'topicName'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageType\\": \\"NORMAL\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"remark\\": \\"This is the remark for test.\\\\n\\",\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\",\\n \\"maxSendTps\\": 1000,\\n \\"liteTopicExpiration\\": 60\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic cannot be found.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"TopicName\\",\\n \\"dynamicMessage\\": \\"topicName\\"\\n}","type":"json"}]', 'title' => 'GetTopic', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTopic'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetTopic', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'GetTrace' => [ 'summary' => 'Retrieves the trace of a specified message in a specified topic.', 'path' => '/instances/{instanceId}/topics/{topicName}/traces/{messageId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '172963', 'abilityTreeNodes' => ['FEATUREonsNKYZ9K'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance to query.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-zvp2vtypu05', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['description' => 'The name of the topic to query.', 'type' => 'string', 'required' => true, 'example' => 'linkedcare-image', 'title' => ''], ], [ 'name' => 'messageId', 'in' => 'path', 'schema' => ['description' => 'The message ID.', 'type' => 'string', 'required' => true, 'example' => '012A5AB0BBEC8A000104C6342B00001ECF', 'title' => ''], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '2023-05-10 10:42:11', 'title' => ''], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['description' => 'The end time.', 'type' => 'string', 'required' => false, 'example' => '2024-09-09 09:00:00', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Each request has a unique ID. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****', 'title' => ''], 'topicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'topic_test', 'title' => ''], 'messageInfo' => [ 'description' => 'The message information.', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rmq-cn-u0t2ygjq505', 'title' => ''], 'topicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'Topic_normal_inspector', 'title' => ''], 'messageId' => ['description' => 'The message ID.', 'type' => 'string', 'example' => '0A79275A00207A4F0F2916C92F9A0B94', 'title' => ''], 'bornTime' => ['description' => 'The time when the message was generated.', 'type' => 'string', 'example' => '2023-03-22 12:17:08', 'title' => ''], 'storeTime' => ['description' => 'The time when the message was stored.', 'type' => 'string', 'example' => '2023-03-22 12:17:08', 'title' => ''], 'body' => ['description' => 'The message body.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'bornHost' => ['description' => 'The source of the message.', 'type' => 'string', 'example' => 'x.x.x.x', 'title' => ''], 'storeHost' => ['description' => 'The location where the message is stored.', 'type' => 'string', 'example' => 'x.x.x.x', 'title' => ''], 'messageType' => ['description' => 'The message type.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], 'messageTag' => ['description' => 'The list of tags.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'messageGroup' => ['description' => 'The former sharding key. This parameter is specific to ordered messages.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'messageKeys' => [ 'description' => 'The business ID.', 'type' => 'array', 'items' => ['description' => 'The business ID.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'userProperties' => [ 'description' => 'The user-defined properties.', 'type' => 'object', 'additionalProperties' => ['description' => 'The user-defined properties.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'transactionId' => ['description' => 'The transaction ID.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'liteTopicName' => ['description' => 'The name of the lightweight topic.', 'type' => 'string', 'example' => 'abc', 'title' => ''], ], 'title' => '', 'example' => '', ], 'producerInfo' => [ 'description' => 'The trace information of the producer.', 'type' => 'object', 'properties' => [ 'records' => [ 'description' => 'The list of production records.', 'type' => 'array', 'items' => [ 'description' => 'The list of production records.', 'type' => 'object', 'properties' => [ 'userName' => ['description' => 'The producer name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'clientHost' => ['description' => 'The hostname.', 'type' => 'string', 'example' => 'xx.xx.xx.xx', 'title' => ''], 'produceTime' => ['description' => 'The time when the message was sent.', 'type' => 'string', 'example' => '2023-03-22 12:17:08', 'title' => ''], 'produceDuration' => ['description' => 'The time taken to send the message.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'produceStatus' => ['description' => 'The sending status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'arriveTime' => ['description' => 'The arrival time.', 'type' => 'string', 'example' => '2023-03-22 12:17:08', 'title' => ''], 'messageSource' => ['description' => 'The message source.', 'type' => 'string', 'example' => 'CONSOLE', 'title' => ''], 'dlqOriginTopic' => ['description' => 'The dead-letter queue topic.', 'type' => 'string', 'example' => 'test_topic', 'title' => ''], 'dlqOriginMessageId' => ['description' => 'The ID of the message in the dead-letter queue.', 'type' => 'string', 'example' => '0A79275A00207A4F0F2916C92F9A0B94', 'title' => ''], 'recallTime' => ['description' => 'The time when the revoke request was initiated. This field is not empty when \\`messageSource\\` is \\`recall\\`.', 'type' => 'string', 'example' => 'Empty | 2023-03-22 12:17:08', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'brokerInfo' => [ 'description' => 'The trace information of the broker.', 'type' => 'object', 'properties' => [ 'presetDelayTime' => ['description' => 'The preset delivery time.', 'type' => 'string', 'example' => '2023-03-22 12:17:08', 'title' => ''], 'delayStatus' => ['description' => 'The status of the scheduled message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'operations' => [ 'description' => 'The list of operations.', 'type' => 'array', 'items' => [ 'description' => 'The list of operations.', 'type' => 'object', 'properties' => [ 'operateType' => ['description' => 'The operation type.', 'type' => 'string', 'example' => 'ADD', 'title' => ''], 'operateTime' => ['description' => 'The operation time.', 'type' => 'string', 'example' => '2023-03-22 12:17:08', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'recallResult' => ['description' => 'The result of the revoke operation. This field is not empty when a revoke record exists.', 'type' => 'string', 'example' => 'Empty | RECALL_OK | RECALL_FAIL', 'title' => ''], ], 'title' => '', 'example' => '', ], 'consumerInfos' => [ 'description' => 'The trace information of the consumer.', 'type' => 'array', 'items' => [ 'description' => 'The trace information of the consumer.', 'type' => 'object', 'properties' => [ 'consumerGroupId' => ['description' => 'The consumer group ID.', 'type' => 'string', 'example' => 'GID_inspector_group', 'title' => ''], 'records' => [ 'description' => 'The list of consumption records.', 'type' => 'array', 'items' => [ 'description' => 'The list of consumption records.', 'type' => 'object', 'properties' => [ 'userName' => ['description' => 'The consumer name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'clientHost' => ['description' => 'The hostname.', 'type' => 'string', 'example' => 'xx.xx.xx.xx', 'title' => ''], 'fifoEnable' => ['description' => 'Indicates whether messages are consumed in order.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'consumeStatus' => ['description' => 'The consumption status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'operations' => [ 'description' => 'The list of operations.', 'type' => 'array', 'items' => [ 'description' => 'The list of operations.', 'type' => 'object', 'properties' => [ 'operateType' => ['description' => 'The operation type.', 'type' => 'string', 'example' => 'ADD', 'title' => ''], 'operateTime' => ['description' => 'The operation time.', 'type' => 'string', 'example' => '2023-03-22 12:17:08', 'title' => ''], 'invisibleTime' => ['description' => 'The invisibility duration, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'deadMessage' => ['description' => 'Indicates whether the message is a dead-letter message.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'popCk' => ['description' => 'The POP checkpoint.', 'type' => 'string', 'example' => '123', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'consumeStatus' => ['description' => 'The consumption status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'deadMessage' => ['description' => 'Indicates whether the message is a dead-letter message.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'deadLetterInfo' => [ 'description' => 'The information about the dead-letter message.', 'type' => 'object', 'properties' => [ 'topicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'Register_Sync', 'title' => ''], 'messageId' => ['description' => 'The message ID.', 'type' => 'string', 'example' => '7F000001001F7A4F0F29463F0376047D', 'title' => ''], 'toDlqTime' => ['description' => 'The time when the message arrived at the dead-letter queue.', 'type' => 'string', 'example' => '2023-03-22 12:17:08', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidConsumerGroupId', 'title' => ''], 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The instance cannot be found.', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'InstanceId', 'title' => ''], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'example' => 'instanceId', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageInfo\\": {\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"instanceId\\": \\"rmq-cn-u0t2ygjq505\\",\\n \\"topicName\\": \\"Topic_normal_inspector\\",\\n \\"messageId\\": \\"0A79275A00207A4F0F2916C92F9A0B94\\",\\n \\"bornTime\\": \\"2023-03-22 12:17:08\\",\\n \\"storeTime\\": \\"2023-03-22 12:17:08\\",\\n \\"body\\": \\"{}\\",\\n \\"bornHost\\": \\"x.x.x.x\\",\\n \\"storeHost\\": \\"x.x.x.x\\",\\n \\"messageType\\": \\"NORMAL\\",\\n \\"messageTag\\": \\"xx\\",\\n \\"messageGroup\\": \\"xx\\",\\n \\"messageKeys\\": [\\n \\"xx\\"\\n ],\\n \\"userProperties\\": {\\n \\"key\\": \\"xx\\"\\n },\\n \\"transactionId\\": \\"xx\\",\\n \\"liteTopicName\\": \\"abc\\"\\n },\\n \\"producerInfo\\": {\\n \\"records\\": [\\n {\\n \\"userName\\": \\"xxx\\",\\n \\"clientHost\\": \\"xx.xx.xx.xx\\",\\n \\"produceTime\\": \\"2023-03-22 12:17:08\\",\\n \\"produceDuration\\": 100,\\n \\"produceStatus\\": \\"SUCCESS\\",\\n \\"arriveTime\\": \\"2023-03-22 12:17:08\\",\\n \\"messageSource\\": \\"CONSOLE\\",\\n \\"dlqOriginTopic\\": \\"test_topic\\",\\n \\"dlqOriginMessageId\\": \\"0A79275A00207A4F0F2916C92F9A0B94\\",\\n \\"recallTime\\": \\"Empty | 2023-03-22 12:17:08\\"\\n }\\n ]\\n },\\n \\"brokerInfo\\": {\\n \\"presetDelayTime\\": \\"2023-03-22 12:17:08\\",\\n \\"delayStatus\\": \\"SUCCESS\\",\\n \\"operations\\": [\\n {\\n \\"operateType\\": \\"ADD\\",\\n \\"operateTime\\": \\"2023-03-22 12:17:08\\"\\n }\\n ],\\n \\"recallResult\\": \\"Empty | RECALL_OK | RECALL_FAIL\\"\\n },\\n \\"consumerInfos\\": [\\n {\\n \\"consumerGroupId\\": \\"GID_inspector_group\\",\\n \\"records\\": [\\n {\\n \\"userName\\": \\"test\\",\\n \\"clientHost\\": \\"xx.xx.xx.xx\\",\\n \\"fifoEnable\\": true,\\n \\"consumeStatus\\": \\"SUCCESS\\",\\n \\"operations\\": [\\n {\\n \\"operateType\\": \\"ADD\\",\\n \\"operateTime\\": \\"2023-03-22 12:17:08\\",\\n \\"invisibleTime\\": 100,\\n \\"deadMessage\\": true\\n }\\n ],\\n \\"popCk\\": \\"123\\"\\n }\\n ],\\n \\"consumeStatus\\": \\"SUCCESS\\",\\n \\"deadMessage\\": true,\\n \\"deadLetterInfo\\": {\\n \\"topicName\\": \\"Register_Sync\\",\\n \\"messageId\\": \\"7F000001001F7A4F0F29463F0376047D\\",\\n \\"toDlqTime\\": \\"2023-03-22 12:17:08\\"\\n }\\n }\\n ]\\n },\\n \\"code\\": \\"InvalidConsumerGroupId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'GetTrace', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrace'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetTrace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], 'translator' => 'manual', ], 'ListAvailableZones' => [ 'path' => '/zones', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'Result>', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['title' => '', 'description' => 'Indicates whether the call was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The result data that is returned.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'zoneId' => ['title' => '', 'description' => 'The ID of the current zone.'."\n", 'type' => 'string', 'example' => 'cn-qingdao-b'], 'zoneName' => ['title' => '', 'description' => 'The name of the current zone.', 'type' => 'string', 'example' => 'ha-cn-t9b30w902vm_qrs'], 'createTime' => ['title' => '', 'description' => 'The time when the zone was created.', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], 'updateTime' => ['title' => '', 'description' => 'The time when the zone was last updated.', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], ], 'title' => '', ], ], 'code' => ['title' => '', 'description' => 'The error code returned if the call failed.'."\n", 'type' => 'string', 'example' => 'Topic.NotFound'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'InstanceId'], ], ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": [\\n {\\n \\"zoneId\\": \\"cn-qingdao-b\\",\\n \\"zoneName\\": \\"ha-cn-t9b30w902vm_qrs\\",\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\"\\n }\\n ],\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\"\\n}","type":"json"}]', 'title' => 'ListAvailableZones', 'summary' => 'Queries the supported zones.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAvailableZones'], ], ], 'ramActions' => [], ], 'ListConsumerConnections' => [ 'summary' => 'Retrieves the connection information for clients in a specified consumer group.', 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/connections', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREons0MOUAZ'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-uax32mf9h1f', 'title' => ''], ], [ 'name' => 'consumerGroupId', 'in' => 'path', 'schema' => ['description' => 'The consumer group ID.', 'type' => 'string', 'required' => true, 'example' => 'GID_TEST_STOCK_OPEND_GW', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'query', 'schema' => ['description' => 'The name of the lite topic.', 'type' => 'string', 'example' => 'test1', 'title' => '', 'required' => false], ], [ 'name' => 'liteTopicName', 'in' => 'query', 'schema' => ['description' => 'The name of the Lite MSMQ topic.', 'type' => 'string', 'example' => 'abc', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-7e22ody****'], 'consumerGroupId' => ['description' => 'The consumer group ID.', 'type' => 'string', 'title' => '', 'example' => 'CID-TEST'], 'connections' => [ 'title' => '', 'description' => 'The list of client connections.', 'type' => 'array', 'items' => [ 'description' => 'The list of client connections.', 'type' => 'object', 'properties' => [ 'clientId' => ['description' => 'The client ID.', 'type' => 'string', 'title' => '', 'example' => '172.17.135.197@17392#1936705963#551717232#9873695589062458'], 'hostname' => ['description' => 'The client hostname.', 'type' => 'string', 'title' => '', 'example' => 'vos'], 'egressIp' => ['description' => 'The host IP address or Internet egress IP address.', 'type' => 'string', 'title' => '', 'example' => 'xx.xx.xx.xx'], 'language' => ['description' => 'The client language.', 'type' => 'string', 'title' => '', 'example' => 'java'], 'version' => ['description' => 'The client version.', 'type' => 'string', 'title' => '', 'example' => '1.0'], 'messageModel' => ['description' => 'The consumption mode of the consumer:'."\n" ."\n" .'- CLUSTERING'."\n" ."\n" .'- LITE\\_SELECTIVE'."\n" ."\n" .'- BROADCASTING', 'type' => 'string', 'title' => '', 'example' => 'BROADCASTING'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'MissingPageNumber'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The instance cannot be found.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"connections\\": [\\n {\\n \\"clientId\\": \\"172.17.135.197@17392#1936705963#551717232#9873695589062458\\",\\n \\"hostname\\": \\"vos\\",\\n \\"egressIp\\": \\"xx.xx.xx.xx\\",\\n \\"language\\": \\"java\\",\\n \\"version\\": \\"1.0\\",\\n \\"messageModel\\": \\"BROADCASTING\\"\\n }\\n ]\\n },\\n \\"code\\": \\"MissingPageNumber\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'ListConsumerConnections', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConsumerConnections'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListConsumerConnections', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], ], ], 'ListConsumerGroupSubscriptions' => [ 'summary' => 'Lists the subscription relationships for a consumer group.', 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '145821', 'abilityTreeNodes' => ['FEATUREons0MOUAZ'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the ApsaraMQ for RocketMQ instance.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-tl32wwz1r05', 'title' => ''], ], [ 'name' => 'consumerGroupId', 'in' => 'path', 'schema' => ['description' => 'The ID of the consumer group whose subscription relationships you want to query.', 'type' => 'string', 'required' => true, 'example' => 'PRINT_RETRY_CONSUMER', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'query', 'schema' => ['description' => 'The name of the topic. If you do not specify this parameter, all subscription relationships are queried.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'topic_test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'Result\\', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '5F4D9D5F-625B-59FF-BD4F-DA8284575DB4'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'array', 'items' => [ 'description' => 'The list of subscription relationships for the consumer group.', 'type' => 'object', 'properties' => [ 'consumerGroupId' => ['description' => 'The ID of the consumer group.', 'type' => 'string', 'title' => '', 'example' => 'CID-TEST'], 'topicName' => ['description' => 'The topic to which the consumer group subscribes.', 'type' => 'string', 'title' => '', 'example' => 'topic_test'], 'messageModel' => ['description' => 'The consumption mode of the consumer group.'."\n" ."\n" .'- BROADCASTING: The broadcast consumption mode.'."\n" ."\n" .'- CLUSTERING: The cluster consumption mode.', 'type' => 'string', 'title' => '', 'example' => 'CLUSTERING'], 'subscriptionStatus' => ['description' => 'The subscription status.'."\n" ."\n" .'- ONLINE: The consumer group is online. If a consumer group contains multiple consumers, the group is considered online as long as at least one consumer is online.'."\n" ."\n" .'- OFFLINE: The consumer group is offline. If a consumer group contains multiple consumers, the group is considered offline only when all consumers are offline.', 'type' => 'string', 'title' => '', 'example' => 'ONLINE'], 'filterExpression' => ['description' => 'The filter expression.', 'type' => 'string', 'title' => '', 'example' => '*'], 'filterExpressionType' => ['description' => 'The type of the filter expression.'."\n" ."\n" .'- SQL: SQL filtering.'."\n" ."\n" .'- TAG: Tag filtering.', 'type' => 'string', 'title' => '', 'example' => 'SQL'], 'topicCreated' => ['description' => 'Indicates whether the topic is created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'consistency' => ['description' => 'The consistency of the subscription relationship.'."\n" ."\n" .'- false: The subscription relationship is inconsistent.'."\n" ."\n" .'- true: The subscription relationship is consistent.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'MissingInstanceId'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], ], 'example' => '', ], ], ], 'title' => 'ListConsumerGroupSubscriptions', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConsumerGroupSubscriptions'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListConsumerGroupSubscriptions', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5F4D9D5F-625B-59FF-BD4F-DA8284575DB4\\",\\n \\"success\\": true,\\n \\"data\\": [\\n {\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageModel\\": \\"CLUSTERING\\",\\n \\"subscriptionStatus\\": \\"ONLINE\\",\\n \\"filterExpression\\": \\"*\\",\\n \\"filterExpressionType\\": \\"SQL\\",\\n \\"topicCreated\\": true,\\n \\"consistency\\": true\\n }\\n ],\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\"\\n}","type":"json"}]', ], 'ListConsumerGroups' => [ 'summary' => 'Lists the consumer groups in a specified instance.', 'path' => '/instances/{instanceId}/consumerGroups', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '144685', 'abilityTreeNodes' => ['FEATUREonsYVMMCL'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'filter', 'in' => 'query', 'schema' => ['description' => 'The filter condition. If you do not specify this parameter, all consumer groups in the instance are returned.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'CID-TEST'], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number of the results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.'."\n" ."\n" .'Valid values: 10 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'title' => '', 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'Result\\>', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID. Each request has a unique ID. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '5503A460-98ED-5543-92CF-4853DE28****'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'pageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'pageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'totalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'list' => [ 'title' => '', 'description' => 'The data returned on the current page.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-7e22ody****'], 'consumerGroupId' => ['description' => 'The consumer group ID.', 'type' => 'string', 'title' => '', 'example' => 'GID-TEST'], 'status' => [ 'description' => 'The status of the consumer group.', 'enumValueTitles' => ['RUNNING' => 'The consumer group is running.', 'CREATING' => 'The consumer group is being created.'], 'type' => 'string', 'enum' => ['CREATING', 'RUNNING'], 'title' => '', 'example' => 'RUNNING', ], 'remark' => ['description' => 'The remarks on the consumer group.', 'type' => 'string', 'title' => '', 'example' => 'This is the remark for test.'], 'createTime' => ['description' => 'The time when the consumer group was created.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 20:05:50'], 'updateTime' => ['description' => 'The time when the consumer group was last updated.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 20:05:50'], 'maxReceiveTps' => ['description' => 'The maximum transactions per second (TPS) for message consumption.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'messageModel' => ['description' => 'The consumption mode.', 'type' => 'string', 'example' => 'LITE_SELECTIVE', 'title' => ''], 'topicName' => ['description' => 'The name of the topic for a lite consumer group.', 'type' => 'string', 'example' => 'test1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'MissingInstanceId'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Parameter InstanceId is mandatory for this action .'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '400'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5503A460-98ED-5543-92CF-4853DE28****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"consumerGroupId\\": \\"GID-TEST\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"remark\\": \\"This is the remark for test.\\",\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\",\\n \\"maxReceiveTps\\": 1000,\\n \\"messageModel\\": \\"LITE_SELECTIVE\\",\\n \\"topicName\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter InstanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'ListConsumerGroups', 'description' => '>'."\n" ."\n" .'The Alibaba Cloud OpenAPI is a management API. You can use this API to manage and query resources for Alibaba Cloud services. Integrate this API only into your management link. Do not use this API in the core data link for sending and receiving messages. This helps prevent potential threats to your data link.'."\n" ."\n" .'>', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConsumerGroups'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListConsumerGroups', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/*'], ], ], ], ], ], 'ListDisasterRecoveryCheckpoints' => [ 'path' => '/disaster_recovery/{planId}/items/{itemId}/checkpoints', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '251690', 'abilityTreeNodes' => ['FEATUREonsOVRH1R'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', 'schema' => ['title' => '备份计划ID', 'description' => 'Backup Plan ID', 'type' => 'string', 'required' => true, 'example' => '1300000016'], ], [ 'name' => 'itemId', 'in' => 'path', 'schema' => ['title' => '备份映射ID', 'description' => 'Backup Mapping ID', 'type' => 'string', 'required' => true, 'example' => '100070284'], ], [ 'name' => 'instanceId', 'in' => 'query', 'schema' => ['title' => '源实例ID', 'description' => 'Source Instance ID', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'filter', 'in' => 'query', 'schema' => ['title' => '过滤条件', 'description' => 'Filter Condition', 'type' => 'string', 'required' => false, 'example' => 'topic_test'], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'Current page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, the maximum number of results returned per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['description' => 'Whether the operation was successful', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'data' => [ 'description' => 'Response Data', 'type' => 'object', 'properties' => [ 'pageNumber' => ['description' => 'Current page number', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'pageSize' => ['description' => 'Page size', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'totalCount' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'list' => [ 'description' => 'Paged data', 'type' => 'array', 'items' => [ 'description' => 'Paged data', 'type' => 'object', 'properties' => [ 'planId' => ['description' => 'Backup Plan ID', 'type' => 'integer', 'format' => 'int64', 'example' => '13000000xx', 'title' => ''], 'itemId' => ['description' => 'Backup Mapping ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000xx', 'title' => ''], 'checkpointId' => ['description' => 'Consumption Progress ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000xx', 'title' => ''], 'lastSyncTime' => ['description' => 'Last synchronization time', 'type' => 'integer', 'format' => 'int64', 'example' => '1740724080343', 'title' => ''], 'sourceProgress' => [ 'description' => 'Source consumption progress', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'Region ID', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'instanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => 'rmq-cn-3mp3vblzxxx', 'title' => ''], 'instanceType' => ['description' => 'Instance type'."\n" .' - ALIYUN_ROCKETMQ: Alibaba Cloud instance'."\n" .' - EXTERNAL_ROCKETMQ: External instance, open-source instance, open-source cluster', 'type' => 'string', 'example' => 'ALIYUN_ROCKETMQ', 'title' => ''], 'consumerGroupId' => ['description' => 'Consumer Group ID', 'type' => 'string', 'example' => 'GID_TEST', 'title' => ''], 'topicName' => ['description' => 'The topic name.'."\n", 'type' => 'string', 'example' => 'TOPIC_TEST', 'title' => ''], 'lastFetchTime' => ['description' => 'Last fetch time', 'type' => 'integer', 'format' => 'int64', 'example' => '1740724080343', 'title' => ''], 'progressData' => [ 'description' => 'Consumption progress data', 'type' => 'object', 'properties' => [ 'consumeTimestamp' => ['description' => 'Latest consumption time', 'type' => 'integer', 'format' => 'int64', 'example' => '1740724080343', 'title' => ''], ], 'title' => '', ], ], 'title' => '', ], 'targetProgress' => [ 'description' => 'Target consumption progress', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'Region ID', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'instanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => 'rmq-cn-nwy3i065xxx', 'title' => ''], 'instanceType' => ['description' => 'Instance type'."\n" .' - ALIYUN_ROCKETMQ: Alibaba Cloud instance'."\n" .' - EXTERNAL_ROCKETMQ: External instance, open-source instance, open-source cluster', 'type' => 'string', 'example' => 'ALIYUN_ROCKETMQ', 'title' => ''], 'consumerGroupId' => ['description' => 'Consumer group ID', 'type' => 'string', 'example' => 'GID_TEST', 'title' => ''], 'topicName' => ['description' => 'Topic name', 'type' => 'string', 'example' => 'TOPIC_TEST', 'title' => ''], 'lastFetchTime' => ['description' => 'Latest fetch time', 'type' => 'integer', 'format' => 'int64', 'example' => '1740724080343', 'title' => ''], 'progressData' => [ 'description' => 'Consumption progress data', 'type' => 'object', 'properties' => [ 'consumeTimestamp' => ['description' => 'Latest consumption time', 'type' => 'integer', 'format' => 'int64', 'example' => '1740724080343', 'title' => ''], ], 'title' => '', ], ], 'title' => '', ], ], 'title' => '', ], 'title' => '', ], ], 'title' => '', ], 'code' => ['description' => 'Error code', 'type' => 'string', 'example' => '200', 'title' => ''], 'message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'The instance cannot be found.', 'title' => ''], 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'dynamicCode' => ['description' => 'Dynamic error code', 'type' => 'string', 'example' => 'InstanceId', 'title' => ''], 'dynamicMessage' => ['description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId', 'title' => ''], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"planId\\": 0,\\n \\"itemId\\": 0,\\n \\"checkpointId\\": 0,\\n \\"lastSyncTime\\": 1740724080343,\\n \\"sourceProgress\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-3mp3vblzxxx\\",\\n \\"instanceType\\": \\"ALIYUN_ROCKETMQ\\",\\n \\"consumerGroupId\\": \\"GID_TEST\\",\\n \\"topicName\\": \\"TOPIC_TEST\\",\\n \\"lastFetchTime\\": 1740724080343,\\n \\"progressData\\": {\\n \\"consumeTimestamp\\": 1740724080343\\n }\\n },\\n \\"targetProgress\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-nwy3i065xxx\\",\\n \\"instanceType\\": \\"ALIYUN_ROCKETMQ\\",\\n \\"consumerGroupId\\": \\"GID_TEST\\",\\n \\"topicName\\": \\"TOPIC_TEST\\",\\n \\"lastFetchTime\\": 1740724080343,\\n \\"progressData\\": {\\n \\"consumeTimestamp\\": 1740724080343\\n }\\n }\\n }\\n ]\\n },\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'ListDisasterRecoveryCheckpoints', 'summary' => 'Queries consumer progress synchronization tasks.', 'translator' => 'machine', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDisasterRecoveryCheckpoints'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListDisasterRecoveryCheckpoints', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListDisasterRecoveryItems' => [ 'path' => '/disaster_recovery/{planId}/items', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225046', 'abilityTreeNodes' => ['FEATUREonsOVRH1R', 'FEATUREonsU22PJL'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', 'schema' => ['description' => 'The ID of the Global Replicator task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The topic name.'."\n", 'example' => 'topic-test920', 'title' => ''], ], [ 'name' => 'filter', 'in' => 'query', 'schema' => ['description' => 'The filter condition. Topics are filtered by topic name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'topic_test', 'title' => ''], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '10', 'default' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C115601B-8736-5BBF-AC99-7FEAE12xxxx'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'scrollId' => ['title' => '', 'description' => 'The scroll ID of the request. The ID is automatically generated by the system. The result can be paginated only if this parameter is included in the pagination request.'."\n", 'type' => 'string', 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00'."\n"], 'pageNumber' => ['title' => '', 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'pageSize' => ['title' => '', 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'totalCount' => ['title' => '', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '49'], 'list' => [ 'title' => '', 'description' => 'The Global Replicator tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The Global Replicator task.'."\n", 'type' => 'object', 'properties' => [ 'itemId' => ['description' => 'The ID of the Global Replicator task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100070284', 'title' => ''], 'planId' => ['title' => '', 'description' => 'The ID of the topic mapping.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1300000016'], 'itemStatus' => ['title' => '', 'description' => 'The status of the topic mapping. Valid values:'."\n" ."\n" .'* CREATING'."\n" .'* CHANGING'."\n" .'* RUNNING'."\n" .'* MANUAL_STOPPED'."\n" .'* OVERDUE_STOPPED'."\n", 'type' => 'string', 'example' => 'RUNNING'], 'topics' => [ 'title' => '', 'description' => 'The topics involved in the topic mapping.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The topic involved in the topic mapping.'."\n", 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'regionId'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'instanceType' => ['title' => '', 'description' => 'The instance type.'."\n", 'type' => 'string', 'example' => 'ALIYUN_ROCKETMQ'], 'instanceId' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rmq-cn-kh43w0olz0c'], 'topicName' => ['title' => '', 'description' => 'The topic name.'."\n", 'type' => 'string', 'example' => 'topic-test'], 'consumerGroupId' => ['title' => '', 'description' => 'The ID of the consumer group.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'group-test'], 'deliveryOrderType' => [ 'description' => 'The method used to deliver messages to the destination instance.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Concurrently: concurrent delivery'."\n" .'* Orderly: ordered delivery'."\n", 'type' => 'string', 'enumValueTitles' => ['Concurrently' => '并发投递', 'Orderly' => '顺序投递'], 'example' => 'Concurrently', 'title' => '', ], ], 'title' => '', ], ], 'extInfo' => [ 'title' => '', 'description' => 'The extended information.'."\n", 'type' => 'object', 'additionalProperties' => ['type' => 'string', 'description' => 'The extended information.'."\n", 'example' => '{}', 'title' => ''], ], 'createTime' => ['title' => '', 'description' => 'The time when the query task was created.'."\n", 'type' => 'string', 'example' => '2024-09-20 03:38:28'], 'updateTime' => ['title' => '', 'description' => 'The time when the query task was last modified.'."\n", 'type' => 'string', 'example' => '2024-10-04 02:19:44'], ], 'title' => '', ], ], ], ], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => '200'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'xxx'], 'httpStatusCode' => ['title' => '', 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C115601B-8736-5BBF-AC99-7FEAE12xxxx\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"scrollId\\": \\"B13D0B07-F24B-4790-88D8-D47A38063D00\\\\n\\",\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 49,\\n \\"list\\": [\\n {\\n \\"itemId\\": 100070284,\\n \\"planId\\": 1300000016,\\n \\"itemStatus\\": \\"RUNNING\\",\\n \\"topics\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceType\\": \\"ALIYUN_ROCKETMQ\\",\\n \\"instanceId\\": \\"rmq-cn-kh43w0olz0c\\",\\n \\"topicName\\": \\"topic-test\\",\\n \\"consumerGroupId\\": \\"group-test\\",\\n \\"deliveryOrderType\\": \\"Concurrently\\"\\n }\\n ],\\n \\"extInfo\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"createTime\\": \\"2024-09-20 03:38:28\\",\\n \\"updateTime\\": \\"2024-10-04 02:19:44\\"\\n }\\n ]\\n },\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'ListDisasterRecoveryItems', 'summary' => 'Queries the Global Replicator tasks of an instance.', 'translator' => 'machine', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDisasterRecoveryItems'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:ListDisasterRecoveryItems', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'ListDisasterRecoveryPlans' => [ 'path' => '/disaster_recovery', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225050', 'abilityTreeNodes' => ['FEATUREonsOVRH1R'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-778xxx', 'title' => ''], ], [ 'name' => 'filter', 'in' => 'query', 'schema' => ['description' => 'The filter condition. Global Replicator tasks are filtered by task name or description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '10', 'default' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '855EF8E6-9C1D-5DE2-9E84-924E13Exxxx'], 'success' => ['title' => '', 'description' => 'Indicates whether the information about the service was queried.'."\n", 'type' => 'boolean', 'example' => 'True'], 'data' => [ 'title' => '', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'scrollId' => ['title' => '', 'description' => 'The scroll ID of the request. The ID is automatically generated by the system. The result can be paginated only if this parameter is included in the pagination request.'."\n", 'type' => 'string', 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00'."\n"], 'pageNumber' => ['title' => '', 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'pageSize' => ['title' => '', 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'totalCount' => ['title' => '', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '28'], 'list' => [ 'title' => '', 'description' => 'The Global Replicator tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The Global Replicator task.'."\n", 'type' => 'object', 'properties' => [ 'planId' => ['title' => '', 'description' => 'The ID of the Global Replicator task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1300000016'], 'planName' => ['title' => '', 'description' => 'The name of the Global Replicator task.'."\n", 'type' => 'string', 'example' => 'xxx'], 'planDesc' => ['title' => '', 'description' => 'The description of the Global Replicator task.'."\n", 'type' => 'string', 'example' => 'xxx'], 'planType' => ['title' => '', 'description' => 'The type of the Global Replicator task. Valid values:'."\n" ."\n" .'* ACTIVE_PASSIVE: one-way backup'."\n" .'* ACTIVE_ACTIVE: two-way backup'."\n", 'type' => 'string', 'example' => 'ACTIVE_PASSIVE'], 'planStatus' => ['title' => '', 'description' => 'The status of the Global Replicator task. Valid values:'."\n" ."\n" .'* CREATED'."\n" .'* RUNNING'."\n" .'* DELETED'."\n", 'type' => 'string', 'example' => 'RUNNING'], 'extInfo' => [ 'title' => '', 'description' => 'The extended information.'."\n", 'type' => 'object', 'additionalProperties' => ['type' => 'string', 'description' => 'The extended information.'."\n", 'example' => 'xxx', 'title' => ''], ], 'instances' => [ 'title' => '', 'description' => 'The instances involved in the Global Replicator task.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance involved the Global Replicator task.'."\n", 'type' => 'object', 'properties' => [ 'instanceType' => ['title' => '', 'description' => 'The instance type.'."\n", 'type' => 'string', 'example' => 'ALIYUN_ROCKETMQ'], 'regionId' => ['title' => '', 'description' => 'The ID of the region where the instance resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou'], 'instanceId' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rmq-cn-ot93rbxxx'], 'instanceRole' => ['title' => '', 'description' => 'The instance role.'."\n", 'type' => 'string', 'example' => 'ACTIVE'], 'authType' => ['title' => '', 'description' => 'The authentication type.'."\n", 'type' => 'string', 'example' => 'NO_AUTH'], 'username' => ['title' => '', 'description' => 'The username used for authentication.'."\n", 'type' => 'string', 'example' => 'xxx'], 'password' => ['title' => '', 'description' => 'The password used for authentication.'."\n", 'type' => 'string', 'example' => 'xxx'], 'endpointUrl' => ['title' => '', 'description' => 'The endpoint.'."\n", 'type' => 'string', 'example' => 'xxx'], 'networkType' => ['title' => '', 'description' => 'The network type.'."\n", 'type' => 'string', 'example' => 'TCP_INTERNET'], 'vpcId' => ['title' => 'VPC ID', 'description' => 'The virtual private cloud (VPC) ID.'."\n", 'type' => 'string', 'example' => 'vpc-bp13docqysrgxtbxxxx'], 'vSwitchId' => ['title' => '', 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-uf6gwtbn6etadpv******'."\n"], 'messageProperty' => [ 'description' => 'The message attribute.'."\n", 'type' => 'object', 'properties' => [ 'propertyKey' => ['description' => 'The attribute key.'."\n", 'type' => 'string', 'example' => 'aaa', 'title' => ''], 'propertyValue' => ['description' => 'The attribute value.'."\n", 'type' => 'string', 'example' => 'bbb', 'title' => ''], ], 'title' => '', ], 'securityGroupId' => ['description' => 'The security group ID.'."\n", 'type' => 'string', 'example' => 'sg-bp17hpmgz9******'."\n", 'title' => ''], 'consumerGroupId' => ['description' => 'The ID of the consumer group.'."\n", 'type' => 'string', 'example' => 'GID_ui_xxx', 'title' => ''], ], 'title' => '', ], ], 'syncCheckpointEnabled' => ['title' => '', 'description' => 'Indicates whether consumer progress synchronization is enabled.'."\n", 'type' => 'boolean', 'example' => 'true'], 'autoSyncCheckpoint' => ['title' => '', 'description' => 'Indicates whether automatic consumer progress synchronization is enabled.'."\n", 'type' => 'boolean', 'example' => 'true'], 'createTime' => ['title' => '', 'description' => 'The time when the query task was created.'."\n", 'type' => 'string', 'example' => '2022-08-01 20:05:50'], 'updateTime' => ['title' => '', 'description' => 'The time when the query task was last modified.'."\n", 'type' => 'string', 'example' => '2022-08-01 20:05:50'], ], 'title' => '', ], ], ], ], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => '200'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'xxx'], 'httpStatusCode' => ['title' => '', 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The returned dynamic error message.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"855EF8E6-9C1D-5DE2-9E84-924E13Exxxx\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"scrollId\\": \\"B13D0B07-F24B-4790-88D8-D47A38063D00\\\\n\\",\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 28,\\n \\"list\\": [\\n {\\n \\"planId\\": 1300000016,\\n \\"planName\\": \\"xxx\\",\\n \\"planDesc\\": \\"xxx\\",\\n \\"planType\\": \\"ACTIVE_PASSIVE\\",\\n \\"planStatus\\": \\"RUNNING\\",\\n \\"extInfo\\": {\\n \\"key\\": \\"xxx\\"\\n },\\n \\"instances\\": [\\n {\\n \\"instanceType\\": \\"ALIYUN_ROCKETMQ\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-ot93rbxxx\\",\\n \\"instanceRole\\": \\"ACTIVE\\",\\n \\"authType\\": \\"NO_AUTH\\",\\n \\"username\\": \\"xxx\\",\\n \\"password\\": \\"xxx\\",\\n \\"endpointUrl\\": \\"xxx\\",\\n \\"networkType\\": \\"TCP_INTERNET\\",\\n \\"vpcId\\": \\"vpc-bp13docqysrgxtbxxxx\\",\\n \\"vSwitchId\\": \\"vsw-uf6gwtbn6etadpv******\\\\n\\",\\n \\"messageProperty\\": {\\n \\"propertyKey\\": \\"aaa\\",\\n \\"propertyValue\\": \\"bbb\\"\\n },\\n \\"securityGroupId\\": \\"sg-bp17hpmgz9******\\\\n\\",\\n \\"consumerGroupId\\": \\"GID_ui_xxx\\"\\n }\\n ],\\n \\"syncCheckpointEnabled\\": true,\\n \\"autoSyncCheckpoint\\": true,\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\"\\n }\\n ]\\n },\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'ListDisasterRecoveryPlans', 'summary' => 'Queries Global Replicator tasks.', 'translator' => 'machine', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:ListDisasterRecoveryPlans', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListInstanceAccount' => [ 'summary' => 'Retrieves the access accounts for a specified instance.', 'path' => '/instances/{instanceId}/accounts', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '209888', 'abilityTreeNodes' => ['FEATUREonsGA7IC4'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the RocketMQ instance.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The first page is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'username', 'in' => 'query', 'schema' => ['description' => 'The username of the account.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'accountType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the account.', 'enumValueTitles' => ['CUSTOMER' => 'custom account', 'DEFAULT' => 'default account'], 'type' => 'string', 'required' => false, 'example' => 'CUSTOMER', 'title' => '', ], ], [ 'name' => 'accountStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the account.', 'enumValueTitles' => ['DISABLE' => 'Disabled', 'ENABLE' => 'Enabled'], 'type' => 'string', 'required' => false, 'example' => 'ENABLE', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80'], 'success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'pageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'pageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'totalCount' => ['description' => 'The total count of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '24'], 'list' => [ 'title' => '', 'description' => 'A list of entries on the current page.', 'type' => 'array', 'items' => [ 'description' => 'The account information.', 'type' => 'object', 'properties' => [ 'regionId' => ['title' => 'regionId', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-7e22ody****'], 'username' => ['description' => 'The username.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'accountType' => [ 'description' => 'The account type.', 'enumValueTitles' => ['CUSTOMER' => 'Custom account', 'DEFAULT' => 'Default account'], 'type' => 'string', 'title' => '', 'example' => 'CUSTOMER', ], 'accountStatus' => [ 'description' => 'The account status.', 'enumValueTitles' => ['DISABLE' => 'Disabled', 'ENABLE' => 'Enabled'], 'type' => 'string', 'title' => '', 'example' => 'ENABLE', ], 'remark' => ['description' => 'The remark.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'MissingInstanceId'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], 'accessDeniedDetail' => ['description' => 'The details of the access denial. This parameter is returned only if the request is denied due to insufficient RAM permissions.', 'type' => 'string', 'title' => '', 'example' => 'xxx'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C115601B-8736-5BBF-AC99-7FEAE1245A80\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 24,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"username\\": \\"test\\",\\n \\"accountType\\": \\"CUSTOMER\\",\\n \\"accountStatus\\": \\"ENABLE\\",\\n \\"remark\\": \\"test\\"\\n }\\n ]\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'ListInstanceAccount', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceAccount'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListInstanceAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'ListInstanceAcl' => [ 'path' => '/instances/{instanceId}/acl', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '209895', 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'filter', 'in' => 'query', 'schema' => ['description' => 'The condition that you specify to filter the ACLs. If you do not specify this parameter, all ACLs are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CID-TEST', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DA4D2F89-E2C8-5F04-936B-60D55B055FA7'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'pageNumber' => ['title' => '', 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'pageSize' => ['title' => '', 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'totalCount' => ['title' => '', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '24'], 'list' => [ 'title' => '', 'description' => 'The pagination information.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ACL.'."\n", 'type' => 'object', 'properties' => [ 'regionId' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou'], 'instanceId' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], 'aclType' => [ 'title' => '', 'description' => 'The ACL type.'."\n" ."\n" .'Valid value:'."\n" ."\n" .'* APACHE: open source ACL.'."\n", 'type' => 'string', 'enumValueTitles' => ['APACHE' => '开源ACL'], 'example' => 'APACHE', ], 'username' => ['title' => '', 'description' => 'The username.'."\n", 'type' => 'string', 'example' => 'test'], 'resourceType' => [ 'title' => '', 'description' => 'The resource type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Group'."\n" .'* Topic'."\n", 'type' => 'string', 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], 'example' => 'Topic', ], 'resourceName' => ['title' => '', 'description' => 'The resource name.'."\n", 'type' => 'string', 'example' => 'test'], 'decision' => [ 'title' => '', 'description' => 'The decision result.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Deny: Access is denied.'."\n" .'* Allow: Access is allowed.'."\n", 'type' => 'string', 'enumValueTitles' => ['Deny' => '拒绝访问', 'Allow' => '允许访问'], 'example' => 'Allow', ], 'actions' => [ 'description' => 'The types of the operations that are allowed by the ACL.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The type of the operation that is allowed by the ACL.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* SUB: message subscription.'."\n" .'* Pub: message sending.'."\n", 'type' => 'string', 'enumValueTitles' => ['Sub' => '订阅', 'Pub' => '发送'], 'example' => 'Pub', 'title' => '', ], 'title' => '', ], 'ipWhitelists' => [ 'title' => '', 'description' => 'The IP address whitelists.'."\n", 'type' => 'array', 'items' => ['description' => 'The IP address whitelist.'."\n", 'type' => 'string', 'example' => '0.0.0.0/0', 'title' => ''], ], ], 'title' => '', ], ], ], ], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'MissingInstanceId'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The instance cannot be found.'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied due to the reason that the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DA4D2F89-E2C8-5F04-936B-60D55B055FA7\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 24,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"aclType\\": \\"APACHE\\",\\n \\"username\\": \\"test\\",\\n \\"resourceType\\": \\"Topic\\",\\n \\"resourceName\\": \\"test\\",\\n \\"decision\\": \\"Allow\\",\\n \\"actions\\": [\\n \\"Pub\\"\\n ],\\n \\"ipWhitelists\\": [\\n \\"0.0.0.0/0\\"\\n ]\\n }\\n ]\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'ListInstanceAcl', 'summary' => 'Queries the access control lists (ACLs) of an instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceAcl'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListInstanceAcl', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'ListInstanceIpWhitelist' => [ 'path' => '/instances/{instanceId}/ip/whitelist', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '209879', 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'ipWhitelist', 'in' => 'query', 'schema' => ['description' => 'IP whitelist.', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '7358418D-83BD-507A-8079-611C63E05674'], 'success' => ['title' => '', 'description' => 'Indicates whether the call was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'pageNumber' => ['title' => '', 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'pageSize' => ['title' => '', 'description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'totalCount' => ['title' => '', 'description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5'], 'list' => [ 'title' => '', 'description' => 'The pagination information.'."\n", 'type' => 'array', 'items' => ['description' => 'The IP address whitelist.'."\n", 'type' => 'string', 'example' => '0.0.0.0/0', 'title' => ''], ], ], ], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Instance.NotFound'."\n"], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.', 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7358418D-83BD-507A-8079-611C63E05674\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 5,\\n \\"list\\": [\\n \\"0.0.0.0/0\\"\\n ]\\n },\\n \\"code\\": \\"Instance.NotFound\\\\n\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'ListInstanceIpWhitelist', 'summary' => 'Queries the IP address whitelists of an instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceIpWhitelist'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListInstanceIpWhitelist', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'ListInstances' => [ 'summary' => 'Queries the ApsaraMQ for RocketMQ instances in a specified region.', 'path' => '/instances', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '144675', 'abilityTreeNodes' => ['FEATUREonsICR0M4'], ], 'parameters' => [ [ 'name' => 'filter', 'in' => 'query', 'schema' => ['description' => 'The filter condition. If you do not specify this parameter, all instances are queried.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.'."\n" ."\n" .'Valid values: 1 to 100,000,000.'."\n" ."\n" .'If you specify a value less than 1, the system uses 1. If you specify a value greater than 100,000,000, the system uses 100,000,000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.'."\n" ."\n" .'Valid values: 10 to 200.'."\n" ."\n" .'If you specify a value less than 10, the system uses 10. If you specify a value greater than 200, the system uses 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '10', 'title' => '', 'example' => '10'], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-acfmx7caj******'], ], [ 'name' => 'tags', 'in' => 'query', 'schema' => ['description' => 'A list of resource tags used to filter instances.', 'type' => 'string', 'required' => false, 'example' => '[{"key": "rmq-test", "value": "test"}]', 'title' => ''], ], [ 'name' => 'seriesCodes', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'The primary series codes of the instances.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- standard: Standard Edition'."\n" ."\n" .'- ultimate: Platinum Edition'."\n" ."\n" .'- professional: Professional Edition'."\n" ."\n" .'- dedicated: Exclusive Edition'."\n" ."\n" .'- shared: Shared Edition', 'type' => 'array', 'items' => ['description' => 'The primary series code of the instance.', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'storageSecretKey', 'in' => 'query', 'schema' => ['description' => 'The storage encryption key.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'Result\\>', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID. This ID is unique to each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '84445A20-2B50-5306-A3C0-AF99FC1833C6'], 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'pageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], 'list' => [ 'title' => '', 'description' => 'The paginated data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-7e22ody****'], 'instanceName' => ['description' => 'The instance name.', 'type' => 'string', 'title' => '', 'example' => 'test instance'], 'status' => [ 'description' => 'The instance status.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- RELEASED'."\n" ."\n" .'- RUNNING'."\n" ."\n" .'- STOPPED'."\n" ."\n" .'- CHANGING'."\n" ."\n" .'- CREATING', 'enumValueTitles' => ['RELEASED' => 'Released', 'RUNNING' => 'Running', 'STOPPED' => 'Stopped', 'CHANGING' => 'Changing', 'CREATING' => 'Creating'], 'type' => 'string', 'enum' => ['CREATING', 'CHANGING', 'RUNNING', 'STOPPED', 'RELEASED'], 'title' => '', 'example' => 'RUNNING', ], 'startTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 00:00:00'], 'expireTime' => ['description' => 'The time when the instance expires.', 'type' => 'string', 'title' => '', 'example' => '2022-09-01 00:00:00'], 'releaseTime' => ['description' => 'The time when the instance was released.', 'type' => 'string', 'title' => '', 'example' => '2022-09-07 00:00:00'], 'userId' => ['description' => 'The ID of the user to which the instance belongs.', 'type' => 'string', 'title' => '', 'example' => '6W0xz2uPfiwp****'], 'commodityCode' => ['description' => 'The commodity code of the ApsaraMQ for RocketMQ 5.x series instance, such as ons\\_rmqsub\\_public\\_cn.', 'type' => 'string', 'title' => '', 'example' => 'ons_rmqsub_public_cn'], 'serviceCode' => ['description' => 'The service code of the instance. The service code for ApsaraMQ for RocketMQ is rmq.', 'type' => 'string', 'title' => '', 'example' => 'rmq'], 'seriesCode' => [ 'description' => 'The primary series code of the instance.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- standard: Standard Edition'."\n" ."\n" .'- Ultimate: Enterprise Platinum Edition'."\n" ."\n" .'- professional: Professional Edition'."\n" ."\n" .'- shared: Shared Edition'."\n" ."\n" .'- dedicated: Exclusive Edition', 'enumValueTitles' => ['standard' => 'Standard Edition', 'ultimate' => 'Platinum Edition', 'professional' => 'Professional Edition'], 'type' => 'string', 'title' => '', 'example' => 'standard', ], 'subSeriesCode' => [ 'description' => 'The sub-series code of the instance.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- cluster\\_ha: High-availability Cluster Edition'."\n" ."\n" .'- single\\_node: Single Node Edition'."\n" ."\n" .'- serverless: Serverless Edition', 'enumValueTitles' => ['cluster_ha' => 'High-availability Edition', 'single_node' => 'Single Node Edition'], 'type' => 'string', 'title' => '', 'example' => 'cluster_ha', ], 'paymentType' => [ 'description' => 'The billing method of the instance.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- PayAsYouGo: Pay-as-you-go'."\n" ."\n" .'- Subscription: Subscription', 'enumValueTitles' => ['PayAsYouGo' => 'Pay-as-you-go (postpaid)', 'Subscription' => 'Subscription (prepaid)'], 'type' => 'string', 'enum' => ['Subscription', 'PayAsYouGo'], 'title' => '', 'example' => 'Subscription', ], 'remark' => ['description' => 'The remarks on the instance.', 'type' => 'string', 'title' => '', 'example' => 'This is remark for instance.'], 'topicCount' => ['description' => 'The number of topics created in the instance.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20'], 'groupCount' => ['description' => 'The number of consumer groups created in the instance.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'createTime' => ['description' => 'The update time of the instance version.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 00:00:00'], 'updateTime' => ['description' => 'The time when the instance was last modified.', 'type' => 'string', 'title' => '', 'example' => '2022-08-02 00:00:00'], 'resourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'title' => '', 'example' => 'rg-acfmx7caj******'], 'tags' => [ 'title' => '', 'description' => 'The list of resource tags.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The resource tag.', 'type' => 'object', 'properties' => [ 'key' => ['description' => 'The key of the resource tag.', 'type' => 'string', 'title' => '', 'example' => 'key'], 'value' => ['description' => 'The value of the resource tag.', 'type' => 'string', 'title' => '', 'example' => 'value'], ], 'example' => '', ], 'example' => '', ], 'productInfo' => [ 'description' => 'The product information.', 'type' => 'object', 'properties' => [ 'traceOn' => ['description' => 'Indicates whether the message trace feature is enabled.'."\n" ."\n" .'- true: enabled'."\n" ."\n" .'- false: disabled'."\n" ."\n" .'This parameter is not yet in effect. The message trace feature is supported by default regardless of whether this parameter is enabled.'."\n" .'This parameter takes effect only for Serverless instances. If you enable the message trace feature for a Serverless instance, you are charged for message traces. For more information, see [Serverless billing rules](~~2586280~~).'."\n" ."\n" .''."\n" ."\n" .'For pay-as-you-go and subscription instances, this parameter does not take effect. The message trace feature is supported by default for these instances.'."\n" ."\n" .'', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'capacityType' => ['description' => 'The capacity mode:'."\n" ."\n" .'- provisioned: reserved and elastic'."\n" ."\n" .'- ondemand: pay-as-you-go', 'type' => 'string', 'example' => 'provisioned', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'MissingPageNumber'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Parameter pageNumber is mandatory for this action .'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '400'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'PageNumber'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'pageNumber'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"84445A20-2B50-5306-A3C0-AF99FC1833C6\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 100,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"instanceName\\": \\"test instance\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"startTime\\": \\"2022-08-01 00:00:00\\",\\n \\"expireTime\\": \\"2022-09-01 00:00:00\\",\\n \\"releaseTime\\": \\"2022-09-07 00:00:00\\",\\n \\"userId\\": \\"6W0xz2uPfiwp****\\",\\n \\"commodityCode\\": \\"ons_rmqsub_public_cn\\",\\n \\"serviceCode\\": \\"rmq\\",\\n \\"seriesCode\\": \\"standard\\",\\n \\"subSeriesCode\\": \\"cluster_ha\\",\\n \\"paymentType\\": \\"Subscription\\",\\n \\"remark\\": \\"This is remark for instance.\\",\\n \\"topicCount\\": 20,\\n \\"groupCount\\": 10,\\n \\"createTime\\": \\"2022-08-01 00:00:00\\",\\n \\"updateTime\\": \\"2022-08-02 00:00:00\\",\\n \\"resourceGroupId\\": \\"rg-acfmx7caj******\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"key\\",\\n \\"value\\": \\"value\\"\\n }\\n ],\\n \\"productInfo\\": {\\n \\"traceOn\\": true,\\n \\"capacityType\\": \\"provisioned\\"\\n }\\n }\\n ]\\n },\\n \\"code\\": \\"MissingPageNumber\\",\\n \\"message\\": \\"Parameter pageNumber is mandatory for this action .\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"PageNumber\\",\\n \\"dynamicMessage\\": \\"pageNumber\\"\\n}","type":"json"}]', 'title' => 'ListInstances', 'description' => '>'."\n" ."\n" .'Alibaba Cloud OpenAPI is a management API that you can use to manage and query Alibaba Cloud service resources. Integrate OpenAPI only on the control plane. Do not use OpenAPI on the core data plane for sending or receiving messages. This prevents potential risks to your data links.'."\n" ."\n" .'>', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListInstances', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/*'], ], ], ], ], ], 'ListMessages' => [ 'summary' => 'Queries a list of messages.', 'path' => '/instances/{instanceId}/topics/{topicName}/messages', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREonsNPGYUW', 'FEATUREonsKQSI06'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-zvp2vtypu05', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'example' => 'test_delay_queue', 'title' => ''], ], [ 'name' => 'messageId', 'in' => 'query', 'schema' => ['description' => 'The message ID.', 'type' => 'string', 'required' => false, 'example' => '7F00000100207A4F0F294A938F7807AE', 'title' => ''], ], [ 'name' => 'messageKey', 'in' => 'query', 'schema' => ['description' => 'The message key.', 'type' => 'string', 'required' => false, 'example' => 'XSCBillResult', 'title' => ''], ], [ 'name' => 'startTime', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The beginning of the time range to query.', 'type' => 'string', 'required' => false, 'example' => '2024-09-09 08:00:00', 'title' => ''], ], [ 'name' => 'endTime', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The end of the time range to query.', 'type' => 'string', 'required' => false, 'example' => '2024-09-09 09:00:00', 'title' => ''], ], [ 'name' => 'pageNumber', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The page number. Pages start from 1.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100000000', 'minimum' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '20', 'minimum' => '1', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'scrollId', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The scroll ID.'."\n" ."\n" .'Do not specify this parameter for the first request. For subsequent paged queries, set this parameter to the scroll ID returned in the previous response.', 'type' => 'string', 'required' => false, 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00', 'title' => ''], ], [ 'name' => 'liteTopicName', 'in' => 'query', 'schema' => ['description' => 'The name of the lightweight topic.', 'type' => 'string', 'example' => 'abc', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'pageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'pageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '50'], 'totalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'list' => [ 'title' => '', 'description' => 'The paged data.', 'type' => 'array', 'items' => [ 'description' => 'The message information.', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-7e22ody****'], 'topicName' => ['description' => 'The topic name.', 'type' => 'string', 'title' => '', 'example' => 'topic_test'], 'messageId' => ['description' => 'The message ID.', 'type' => 'string', 'title' => '', 'example' => '7F000001000114B4340C5ABF94500079'], 'bornTime' => ['description' => 'The time when the message was created.', 'type' => 'string', 'title' => '', 'example' => '2023-03-22 12:17:08'], 'storeTime' => ['description' => 'The time when the message was stored.', 'type' => 'string', 'title' => '', 'example' => '2023-03-22 12:17:08'], 'body' => ['description' => 'The message body.', 'type' => 'string', 'title' => '', 'example' => '{}'], 'bodySize' => ['description' => 'The size of the message body.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'bornHost' => ['description' => 'The client that produced the message.', 'type' => 'string', 'title' => '', 'example' => 'xx.xx.xx.xx'], 'storeHost' => ['description' => 'The server that stored the message.', 'type' => 'string', 'title' => '', 'example' => 'xx.xx.xx.xx'], 'messageType' => ['description' => 'The message type.', 'type' => 'string', 'title' => '', 'example' => 'NORMAL'], 'messageTag' => ['description' => 'The message tag.', 'type' => 'string', 'title' => '', 'example' => 'xx'], 'messageGroup' => ['description' => 'The message group. This parameter is specific to ordered messages.', 'type' => 'string', 'title' => '', 'example' => 'xx'], 'messageKeys' => [ 'title' => '', 'description' => 'The business keys.', 'type' => 'array', 'items' => ['description' => 'The business key.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], 'userProperties' => [ 'title' => '', 'description' => 'The user properties.', 'type' => 'object', 'additionalProperties' => ['description' => 'The user property.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], 'liteTopicName' => ['description' => 'The name of the lightweight topic.', 'type' => 'string', 'example' => 'abc', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'scrollId' => ['description' => 'The scroll ID.'."\n" ."\n" .'The system generates this ID automatically. To retrieve the next page of results, include this ID in the subsequent request.', 'type' => 'string', 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00', 'title' => ''], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'MissingInstanceId'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 50,\\n \\"totalCount\\": 0,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageId\\": \\"7F000001000114B4340C5ABF94500079\\",\\n \\"bornTime\\": \\"2023-03-22 12:17:08\\",\\n \\"storeTime\\": \\"2023-03-22 12:17:08\\",\\n \\"body\\": \\"{}\\",\\n \\"bodySize\\": 100,\\n \\"bornHost\\": \\"xx.xx.xx.xx\\",\\n \\"storeHost\\": \\"xx.xx.xx.xx\\",\\n \\"messageType\\": \\"NORMAL\\",\\n \\"messageTag\\": \\"xx\\",\\n \\"messageGroup\\": \\"xx\\",\\n \\"messageKeys\\": [\\n \\"xx\\"\\n ],\\n \\"userProperties\\": {\\n \\"key\\": \\"xx\\"\\n },\\n \\"liteTopicName\\": \\"abc\\"\\n }\\n ],\\n \\"scrollId\\": \\"B13D0B07-F24B-4790-88D8-D47A38063D00\\"\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'ListMessages', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMessages'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListMessages', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'ListMetricMeta' => [ 'path' => '/monitor/metrics/meta', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, indicating which page of the results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, indicating the maximum number of results per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'Result>', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '请求ID', 'description' => 'Request ID', 'type' => 'string', 'example' => '8B459455-4A35-5796-BA9D-98EF1AB9A931'], 'success' => ['title' => '是否成功', 'description' => 'Whether the operation was successful', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => 'Return result', 'type' => 'object', 'properties' => [ 'pageNumber' => ['title' => '当前页码', 'description' => 'Current page number', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'pageSize' => ['title' => '分页大小', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'totalCount' => ['title' => '总记录数', 'description' => 'Total record count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'list' => [ 'title' => '分页数据', 'description' => 'Paged data', 'type' => 'array', 'items' => [ 'description' => 'List of monitoring items.', 'type' => 'object', 'properties' => [ 'metricName' => ['title' => '监控项名称', 'description' => 'Monitoring item name', 'type' => 'string', 'example' => 'SendMessageCountPerInstance'], 'description' => ['title' => '监控项描述', 'description' => 'Monitoring item description', 'type' => 'string', 'example' => 'Using Serverless Devs to deploy the infrastructure of project:get-userinfo-v1-infrastructure-as-template-project'], 'category' => ['title' => '监控项标签', 'description' => 'Monitoring item tag', 'type' => 'string', 'example' => 'Bug'], ], 'title' => '', ], ], ], ], 'code' => ['title' => '错误码', 'description' => 'Error code', 'type' => 'string', 'example' => 'Topic.NotFound'], 'message' => ['title' => '错误信息', 'description' => 'Error message', 'type' => 'string', 'example' => 'The topic already exists.'], 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '动态错误码', 'description' => 'Dynamic error code', 'type' => 'string', 'example' => 'xxx'], 'dynamicMessage' => ['title' => '动态错误信息', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B459455-4A35-5796-BA9D-98EF1AB9A931\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"metricName\\": \\"SendMessageCountPerInstance\\",\\n \\"description\\": \\"Using Serverless Devs to deploy the infrastructure of project:get-userinfo-v1-infrastructure-as-template-project\\",\\n \\"category\\": \\"Bug\\"\\n }\\n ]\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic already exists.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"xxx\\",\\n \\"dynamicMessage\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'ListMetricMeta', 'summary' => 'Query Monitoring Items List', 'translator' => 'machine', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMetricMeta'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListMetricMeta', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListMigrationOperations' => [ 'summary' => 'Lists migration operations.', 'path' => '/migrations/{migrationId}/stages/{stageType}/operations', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'migrationId', 'in' => 'path', 'schema' => ['description' => 'The ID of the migration.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '135', 'title' => ''], ], [ 'name' => 'stageType', 'in' => 'path', 'schema' => [ 'description' => 'The type of the migration stage.', 'enumValueTitles' => ['MIGRATE_MESSAGE' => 'message migration'], 'type' => 'string', 'required' => true, 'example' => 'MIGRATE_MESSAGE', 'title' => '', ], ], [ 'name' => 'operationType', 'in' => 'query', 'schema' => [ 'description' => 'The operation type.', 'enumValueTitles' => ['MIGRATE_MESSAGE' => 'message migration'], 'type' => 'string', 'required' => true, 'example' => 'MIGRATE_MESSAGE', 'title' => '', ], ], [ 'name' => 'filter', 'in' => 'query', 'schema' => ['description' => 'The filter condition.'."\n" ."\n" .'> - You can filter the results by operationKey, which is the topic name.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], ], [ 'name' => 'instanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-zxu37eiqq0x', 'title' => ''], ], [ 'name' => 'operationStatus', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The operation status.', 'type' => 'string', 'required' => false, 'example' => 'DOING', 'title' => ''], 'title' => '', 'description' => 'The operation statuses.', 'required' => false, 'example' => '', ], ], [ 'name' => 'businessStatus', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The business status.', 'type' => 'string', 'required' => false, 'example' => 'DOUBLE_READ', 'title' => ''], 'title' => '', 'description' => 'The business statuses.', 'required' => false, 'example' => '', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '10000', 'minimum' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'Result\\', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5F88833'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'pageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'list' => [ 'title' => '', 'description' => 'The list of entries.', 'type' => 'array', 'items' => [ 'description' => 'The list of migration operations.', 'type' => 'object', 'properties' => [ 'operationId' => ['description' => 'The migration operation ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '183'], 'migrationId' => ['description' => 'The migration ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'stageType' => [ 'description' => 'The migration stage.', 'enumValueTitles' => ['MIGRATE_MESSAGE' => 'Message migration'], 'type' => 'string', 'title' => '', 'example' => 'MIGRATE_MESSAGE', ], 'operationType' => [ 'description' => 'The operation type.', 'enumValueTitles' => ['MIGRATE_MESSAGE' => 'Message migration'], 'type' => 'string', 'title' => '', 'example' => 'MIGRATE_MESSAGE', ], 'operationStatus' => [ 'description' => 'The operation status.', 'enumValueTitles' => ['INIT' => 'Not started', 'DONE' => 'Completed', 'DOING' => 'In progress', 'FAIL' => 'Failed'], 'type' => 'string', 'title' => '', 'example' => 'DOING', ], 'operationKey' => ['description' => 'The primary key of the operation object.'."\n" ."\n" .'> - During message migration, the operation object is the topic name.', 'type' => 'string', 'title' => '', 'example' => 'normal-topic-1'], 'businessStatus' => [ 'description' => 'The business status of the operation.', 'enumValueTitles' => ['MIGRATE_WAIT' => 'Reads from and writes to the source cluster.', 'SWITCH_WRITE' => 'Writes to the target cluster and redundantly reads from the source cluster.', 'MIGRATE_FINISH' => 'Reads from and writes to the target cluster.', 'DOUBLE_READ' => 'Writes to the source cluster and redundantly reads from the target cluster.', 'ALREADY_MIGRATED' => 'Migrated'], 'type' => 'string', 'title' => '', 'example' => 'DOUBLE_READ', ], 'operationParam' => [ 'title' => '', 'description' => 'The operation parameters.', 'type' => 'object', 'properties' => [ 'paramData' => ['description' => 'The parameter data.', 'type' => 'any', 'title' => '', 'example' => '{'."\n" .' "action": "MIGRATE_FORWARD",'."\n" .' "targetStage": "MIGRATE_FINISH"'."\n" .'}'], ], 'example' => '', ], 'operationResult' => [ 'title' => '', 'description' => 'The operation result.', 'type' => 'object', 'properties' => [ 'resultData' => ['description' => 'The operation result.', 'type' => 'any', 'title' => '', 'example' => '{'."\n" .' "checkStatus": "WAIT_CHECK",'."\n" .' "sourceTopicStatus": "PERM_6",'."\n" .' "targetTopicStatus": "PERM_4",'."\n" .' "checkResult": {},'."\n" .' "migrateStage": "DOUBLE_READ"'."\n" .'}'], ], 'example' => '', ], 'createTime' => ['description' => 'The time when the operation was created.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 00:00:00'], 'updateTime' => ['description' => 'The time when the operation was last updated.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 20:05:50'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'Instance.NotFound'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The topic already exists.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'consumerGroupId'], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7E8AE3A-219B-52EE-BE32-4036F5F88833\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"operationId\\": 183,\\n \\"migrationId\\": 1,\\n \\"stageType\\": \\"MIGRATE_MESSAGE\\",\\n \\"operationType\\": \\"MIGRATE_MESSAGE\\",\\n \\"operationStatus\\": \\"DOING\\",\\n \\"operationKey\\": \\"normal-topic-1\\",\\n \\"businessStatus\\": \\"DOUBLE_READ\\",\\n \\"operationParam\\": {\\n \\"paramData\\": \\"{\\\\n \\\\\\"action\\\\\\": \\\\\\"MIGRATE_FORWARD\\\\\\",\\\\n \\\\\\"targetStage\\\\\\": \\\\\\"MIGRATE_FINISH\\\\\\"\\\\n}\\"\\n },\\n \\"operationResult\\": {\\n \\"resultData\\": \\"{\\\\n \\\\\\"checkStatus\\\\\\": \\\\\\"WAIT_CHECK\\\\\\",\\\\n \\\\\\"sourceTopicStatus\\\\\\": \\\\\\"PERM_6\\\\\\",\\\\n \\\\\\"targetTopicStatus\\\\\\": \\\\\\"PERM_4\\\\\\",\\\\n \\\\\\"checkResult\\\\\\": {},\\\\n \\\\\\"migrateStage\\\\\\": \\\\\\"DOUBLE_READ\\\\\\"\\\\n}\\"\\n },\\n \\"createTime\\": \\"2022-08-01 00:00:00\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\"\\n }\\n ]\\n },\\n \\"code\\": \\"Instance.NotFound\\",\\n \\"message\\": \\"The topic already exists.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"consumerGroupId\\"\\n}","type":"json"}]', 'title' => 'ListMigrationOperations', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListMigrationOperations', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'ListMigrations' => [ 'summary' => 'Queries migration tasks.', 'path' => '/migrations', 'methods' => ['get'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'filter', 'in' => 'query', 'schema' => ['description' => 'The filter condition for the query.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], ], [ 'name' => 'migrationType', 'in' => 'query', 'schema' => [ 'description' => 'The migration type:'."\n" ."\n" .'- INSTANCE\\_MIGRATION: instance migration', 'enumValueTitles' => ['INSTANCE_MIGRATION' => 'Instance migration'], 'type' => 'string', 'required' => true, 'example' => 'INSTANCE_MIGRATION', 'title' => '', ], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number of the results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '10000', 'minimum' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm4goe2ckfiva', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'Result\\', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E5897B2E-C3AC-56DC-A482-F0E9E53F48D5'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'pageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '3'], 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'list' => [ 'title' => '', 'description' => 'The data on the current page.', 'type' => 'array', 'items' => [ 'description' => 'The list of migration tasks.', 'type' => 'object', 'properties' => [ 'migrationId' => ['description' => 'The migration ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '21'], 'migrationName' => ['description' => 'The migration name.', 'type' => 'string', 'title' => '', 'example' => 'xxx'], 'migrationType' => ['description' => 'The migration type:'."\n" ."\n" .'- INSTANCE\\_MIGRATION: instance migration', 'type' => 'string', 'title' => '', 'example' => 'INSTANCE_MIGRATION'], 'migrationStatus' => [ 'description' => 'The migration status:'."\n" ."\n" .'- CREATED: Created'."\n" ."\n" .'- MIGRATING: In progress'."\n" ."\n" .'- COMPLETED: Complete'."\n" ."\n" .'- CANCELLED: Canceled', 'enumValueTitles' => ['CANCELLED' => 'Canceled', 'CREATED' => 'Created', 'COMPLETED' => 'Complete', 'MIGRATING' => 'In progress'], 'type' => 'string', 'title' => '', 'example' => 'MIGRATING', ], 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => '111'], 'currentStage' => [ 'title' => '', 'description' => 'The current migration stage.', 'type' => 'object', 'properties' => [ 'stageType' => [ 'description' => 'The stage type.'."\n" ."\n" .'- CONNECT\\_NETWORK: Network connection'."\n" ."\n" .'- MIGRATE\\_METADATA: Metadata migration'."\n" ."\n" .'- REPLACE\\_ENDPOINT: Endpoint replacement'."\n" ."\n" .'- MIGRATE\\_MESSAGE: Message migration', 'enumValueTitles' => ['REPLACE_ENDPOINT' => 'Endpoint replacement', 'MIGRATE_METADATA' => 'Metadata migration', 'CONNECT_NETWOR' => 'Network connection', 'MIGRATE_MESSAGE' => 'Message migration'], 'type' => 'string', 'title' => '', 'example' => 'MIGRATE_METADATA', ], 'stageStatus' => [ 'description' => 'The stage status:'."\n" ."\n" .'- INIT: Not started'."\n" ."\n" .'- DOING: In progress'."\n" ."\n" .'- DONE: Complete', 'enumValueTitles' => ['INIT' => 'Not started', 'DONE' => 'Complete', 'DOING' => 'In progress'], 'type' => 'string', 'title' => '', 'example' => 'DOING', ], 'stageData' => ['description' => 'The stage data.', 'type' => 'any', 'title' => '', 'example' => '[]'], ], 'example' => '', ], 'migrationSource' => [ 'title' => '', 'description' => 'The migration source.', 'type' => 'object', 'properties' => [ 'sourceType' => [ 'description' => 'The migration source type:'."\n" ."\n" .'- EXTERNAL\\_INSTANCE: External instance'."\n" ."\n" .'- INTERNAL\\_INSTANCE: Alibaba Cloud V5.0 instance', 'enumValueTitles' => ['EXTERNAL_INSTANCE' => 'External instance', 'INTERNAL_INSTANCE' => 'Alibaba Cloud V5.0 instance'], 'type' => 'string', 'title' => '', 'example' => 'EXTERNAL_INSTANCE', ], 'sourceData' => ['description' => 'The source data.', 'type' => 'any', 'title' => '', 'example' => '{'."\n" .'"clusterType":"INTERNET_NETWORK",'."\n" .'"aclType":"NONE",'."\n" .'"clusterName":"test",'."\n" .'"namesrvAddrList":"47.110.248.xxx:9876"],'."\n" .'"brokerObtainMethod":"AUTO_OBTAIN"'."\n" .'}'], ], 'example' => '', ], 'migrationTarget' => [ 'title' => '', 'description' => 'The migration target.', 'type' => 'object', 'properties' => [ 'targetType' => [ 'description' => 'The migration target type:'."\n" ."\n" .'- INTERNAL\\_INSTANCE: Alibaba Cloud V5.0 instance', 'enumValueTitles' => ['INTERNAL_INSTANCE' => 'Alibaba Cloud V5.0 instance'], 'type' => 'string', 'title' => '', 'example' => 'INTERNAL_INSTANCE', ], 'targetData' => ['description' => 'The target data.', 'type' => 'any', 'title' => '', 'example' => '{'."\n" .'"clusterType":"ROCKETMQ_V5",'."\n" .'"instanceId":"rmq-cn-778429mp301",'."\n" .'"regionId":"cn-hangzhou"'."\n" .'}'], ], 'example' => '', ], 'createTime' => ['description' => 'The time when the task was created.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 00:00:00'], 'updateTime' => ['description' => 'The time when the task was last updated.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 20:05:50'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'MissingInstanceId'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The instance cannot be found.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5897B2E-C3AC-56DC-A482-F0E9E53F48D5\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 3,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"migrationId\\": 21,\\n \\"migrationName\\": \\"xxx\\",\\n \\"migrationType\\": \\"INSTANCE_MIGRATION\\",\\n \\"migrationStatus\\": \\"MIGRATING\\",\\n \\"userId\\": \\"111\\",\\n \\"currentStage\\": {\\n \\"stageType\\": \\"MIGRATE_METADATA\\",\\n \\"stageStatus\\": \\"DOING\\",\\n \\"stageData\\": \\"[]\\"\\n },\\n \\"migrationSource\\": {\\n \\"sourceType\\": \\"EXTERNAL_INSTANCE\\",\\n \\"sourceData\\": \\"{\\\\n\\\\\\"clusterType\\\\\\":\\\\\\"INTERNET_NETWORK\\\\\\",\\\\n\\\\\\"aclType\\\\\\":\\\\\\"NONE\\\\\\",\\\\n\\\\\\"clusterName\\\\\\":\\\\\\"test\\\\\\",\\\\n\\\\\\"namesrvAddrList\\\\\\":\\\\\\"47.110.248.xxx:9876\\\\\\"],\\\\n\\\\\\"brokerObtainMethod\\\\\\":\\\\\\"AUTO_OBTAIN\\\\\\"\\\\n}\\"\\n },\\n \\"migrationTarget\\": {\\n \\"targetType\\": \\"INTERNAL_INSTANCE\\",\\n \\"targetData\\": \\"{\\\\n\\\\\\"clusterType\\\\\\":\\\\\\"ROCKETMQ_V5\\\\\\",\\\\n\\\\\\"instanceId\\\\\\":\\\\\\"rmq-cn-778429mp301\\\\\\",\\\\n\\\\\\"regionId\\\\\\":\\\\\\"cn-hangzhou\\\\\\"\\\\n}\\"\\n },\\n \\"createTime\\": \\"2022-08-01 00:00:00\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\"\\n }\\n ]\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'ListMigrations', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListMigrations', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListRegions' => [ 'path' => '/regions', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'Result\\'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0B962390-D84B-5D44-8C11-79DF40299D41'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The regions.'."\n", 'type' => 'object', 'properties' => [ 'regionId' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou'], 'regionName' => ['title' => '', 'description' => 'The region name.'."\n", 'type' => 'string', 'example' => 'hangzhou'], 'supportRocketmqV5' => ['title' => '', 'description' => 'Indicates whether ApsaraMQ for RocketMQ V5 is activated.'."\n", 'type' => 'boolean', 'example' => 'true'], 'supportRocketmqV4' => ['title' => '', 'description' => 'Indicates whether ApsaraMQ for RocketMQ V4 is activated.'."\n", 'type' => 'boolean', 'example' => 'true'], 'createTime' => ['title' => '', 'description' => 'The time when the ApsaraMQ for RocketMQ instance was created.'."\n", 'type' => 'string', 'example' => '2022-08-01 20:05:50'], 'updateTime' => ['title' => '', 'description' => 'The time when the ApsaraMQ for RocketMQ instance was last modified.'."\n", 'type' => 'string', 'example' => '2022-08-01 20:05:50'], 'tags' => [ 'description' => 'The region tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The region tag.'."\n", 'type' => 'object', 'properties' => [ 'tagCode' => ['description' => 'The tag code.'."\n", 'type' => 'string', 'example' => 'xx', 'title' => ''], 'tagValue' => ['description' => 'The tag value.'."\n", 'type' => 'any', 'example' => 'xx', 'title' => ''], ], 'title' => '', ], 'title' => '', ], ], 'title' => '', ], ], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'MissingPageNumber'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'ConsumerGroupId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B962390-D84B-5D44-8C11-79DF40299D41\\",\\n \\"success\\": true,\\n \\"data\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"regionName\\": \\"hangzhou\\",\\n \\"supportRocketmqV5\\": true,\\n \\"supportRocketmqV4\\": true,\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\",\\n \\"tags\\": [\\n {\\n \\"tagCode\\": \\"xx\\",\\n \\"tagValue\\": \\"xx\\"\\n }\\n ]\\n }\\n ],\\n \\"code\\": \\"MissingPageNumber\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"ConsumerGroupId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'ListRegions', 'summary' => 'Queries regions in which ApsaraMQ for RocketMQ is available.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'], ], ], 'ramActions' => [], ], 'ListTagResources' => [ 'path' => '/resourceTag/list', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'regionId', 'in' => 'query', 'schema' => ['title' => '地域ID。', 'description' => 'Region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'resourceType', 'in' => 'query', 'schema' => ['title' => '资源类型。', 'description' => 'Resource type.', 'type' => 'string', 'required' => true, 'example' => 'instance'], ], [ 'name' => 'resourceId', 'in' => 'query', 'schema' => ['title' => '资源ID列表，JSON格式。', 'description' => 'List of resource IDs, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '["rmq-cn-pe334n08h08"]'], ], [ 'name' => 'tag', 'in' => 'query', 'schema' => ['title' => '标签列表，JSON格式。', 'description' => 'List of tags, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '[{"key": "rmq-test", "value": "test"}]'], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['title' => '下一个查询开始的位置。', 'description' => 'The position from which the next query starts.', 'type' => 'string', 'required' => false, 'example' => 'd09e2b63e1b12d905b7080ff70'], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => ['description' => 'Resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmx7caj******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '请求ID', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F00C6A70-C782-5DD6-9D11-0CFC710100C7'], 'success' => ['title' => '是否成功', 'description' => 'Whether the operation was successful', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => 'Return result', 'type' => 'object', 'properties' => [ 'nextToken' => ['description' => 'The position from which the next query starts.', 'type' => 'string', 'example' => 'd09e2b63e1b12d905b7080ff70', 'title' => ''], 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'F00C6A70-C782-5DD6-9D11-0CFC710100C7', 'title' => ''], 'tagResources' => [ 'description' => 'Resource tag relationships.', 'type' => 'array', 'items' => [ 'description' => 'Resource tag relationships.', 'type' => 'object', 'properties' => [ 'resourceType' => ['description' => 'Resource type.', 'type' => 'string', 'example' => 'instance', 'title' => ''], 'tagValue' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'value', 'title' => ''], 'resourceId' => ['description' => 'Resource ID.', 'type' => 'string', 'example' => 'rmq-cn-pe334n08h08', 'title' => ''], 'tagKey' => ['description' => 'Tag key.', 'type' => 'string', 'example' => 'key', 'title' => ''], 'category' => ['description' => 'Tag category.', 'type' => 'string', 'example' => 'custom', 'title' => ''], 'scope' => ['description' => 'Visibility scope.', 'type' => 'string', 'example' => 'public', 'title' => ''], 'aliUid' => ['description' => 'UID of the resource owner.', 'type' => 'integer', 'format' => 'int64', 'example' => '1876441048322426', 'title' => ''], ], 'title' => '', ], 'title' => '', ], ], ], 'code' => ['title' => '错误码', 'description' => 'Error code', 'type' => 'string', 'example' => 'Topic.NotFound'], 'message' => ['title' => '错误信息', 'description' => 'Error message', 'type' => 'string', 'example' => 'The topic already exists.'], 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '动态错误码', 'description' => 'Dynamic error code', 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '动态错误信息', 'description' => 'Dynamic error message', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F00C6A70-C782-5DD6-9D11-0CFC710100C7\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"nextToken\\": \\"d09e2b63e1b12d905b7080ff70\\",\\n \\"requestId\\": \\"F00C6A70-C782-5DD6-9D11-0CFC710100C7\\",\\n \\"tagResources\\": [\\n {\\n \\"resourceType\\": \\"instance\\",\\n \\"tagValue\\": \\"value\\",\\n \\"resourceId\\": \\"rmq-cn-pe334n08h08\\",\\n \\"tagKey\\": \\"key\\",\\n \\"category\\": \\"custom\\",\\n \\"scope\\": \\"public\\",\\n \\"aliUid\\": 1876441048322426\\n }\\n ]\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic already exists.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'ListTagResources', 'summary' => 'Queries the tags that are added to resources.', 'translator' => 'machine', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListTagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListTopicSubscriptions' => [ 'path' => '/instances/{instanceId}/topics/{topicName}/subscriptions', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the ApsaraMQ for RocketMQ instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-zpr34udri0w', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['description' => 'The name of the topic on the ApsaraMQ for RocketMQ instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'dev4-HMH_INSURANCE_NOMAL_TOPIC', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'Result\\'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '92A9BE4E-B794-50C8-979C-0456E4D32943'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The subscriptions of the topic.'."\n", 'type' => 'object', 'properties' => [ 'consumerGroupId' => ['title' => '', 'description' => 'The consumer group ID.'."\n", 'type' => 'string', 'example' => 'CID-TEST'], 'topicName' => ['title' => '', 'description' => 'The topic name.'."\n", 'type' => 'string', 'example' => 'topic_test'], 'messageModel' => ['title' => '', 'description' => 'The consumption mode. Valid values: BROADCASTING and CLUSTERING.'."\n", 'type' => 'string', 'example' => 'BROADCASTING'], 'subscriptionStatus' => ['title' => '', 'description' => 'The subscription status. Valid values: ONLINE and OFFLINE.'."\n", 'type' => 'string', 'example' => 'ONLINE'], 'filterExpression' => ['title' => '', 'description' => 'The filter expression.'."\n", 'type' => 'string', 'example' => '*'], 'filterExpressionType' => ['title' => '', 'description' => 'The type of the filter expression. Valid values: SQL, TAG, and UNSPECIFIED. The value SQL indicates that messages are filtered by using SQL expressions. The value TAG indicates that messages are filtered by using tags. The value UNSPECIFIED indicates that no filter expression type is specified.'."\n", 'type' => 'string', 'example' => 'SQL'], 'consistency' => ['description' => 'Indicates whether message consumption is consistent. Valid values:'."\n" ."\n" .'* false: Unconsumed messages exist in the consumer group.'."\n" .'* true: No unconsumed message exists in the consumer group.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', ], ], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'MissingInstanceId'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The instance cannot be found.'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'Topic'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"92A9BE4E-B794-50C8-979C-0456E4D32943\\",\\n \\"success\\": true,\\n \\"data\\": [\\n {\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageModel\\": \\"BROADCASTING\\",\\n \\"subscriptionStatus\\": \\"ONLINE\\",\\n \\"filterExpression\\": \\"*\\",\\n \\"filterExpressionType\\": \\"SQL\\",\\n \\"consistency\\": \\"true\\"\\n }\\n ],\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"Topic\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'ListTopicSubscriptions', 'summary' => 'Queries the subscriptions of a specific topic.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTopicSubscriptions'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListTopicSubscriptions', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'ListTopics' => [ 'summary' => 'Queries the topics in a specified instance.', 'path' => '/instances/{instanceId}/topics', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '144680', 'abilityTreeNodes' => ['FEATUREonsXSOU1Y'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance whose topics you want to query.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'filter', 'in' => 'query', 'schema' => ['description' => 'The filter condition. If you leave this parameter empty, all topics in the instance are queried.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'topic_test'], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '10', 'title' => '', 'example' => '3'], ], [ 'name' => 'messageTypes', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'The message types of the topics.', 'type' => 'array', 'items' => [ 'description' => 'The message type of the topics to query. If you leave this parameter empty, topics of all message types are queried.'."\n" .'Valid values:'."\n" ."\n" .'- TRANSACTION: transactional message'."\n" ."\n" .'- FIFO: ordered message'."\n" ."\n" .'- DELAY: scheduled or delayed message'."\n" ."\n" .'- NORMAL: normal message'."\n" ."\n" .'- LITE: lightweight topic', 'enumValueTitles' => ['TRANSACTION' => 'Transactional message', 'FIFO' => 'Ordered message', 'DELAY' => 'Scheduled and delayed message', 'NORMAL' => 'Normal message'], 'type' => 'string', 'required' => false, 'example' => 'NORMAL', 'title' => '', ], 'required' => false, 'enumValueTitles' => [], 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result>', 'description' => 'Result\\', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID. This ID is unique to each request and can be used to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'pageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'pageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '3'], 'totalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'list' => [ 'title' => '', 'description' => 'The paginated data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-7e22ody****'], 'topicName' => ['description' => 'The topic name.', 'type' => 'string', 'title' => '', 'example' => 'topic_test'], 'messageType' => [ 'description' => 'The message type of the topic.', 'enumValueTitles' => ['TRANSACTION' => 'Transactional message', 'FIFO' => 'Ordered message', 'DELAY' => 'Scheduled and delayed messages', 'NORMAL' => 'Normal message'], 'type' => 'string', 'enum' => ['NORMAL', 'FIFO', 'DELAY', 'TRANSACTION'], 'title' => '', 'example' => 'NORMAL', ], 'status' => [ 'description' => 'The status of the topic.', 'enumValueTitles' => ['RUNNING' => 'Running', 'CREATING' => 'Creating'], 'type' => 'string', 'enum' => ['CREATING', 'RUNNING'], 'title' => '', 'example' => 'RUNNING', ], 'remark' => ['description' => 'The remarks on the topic.', 'type' => 'string', 'title' => '', 'example' => 'This is the remark for test.'], 'createTime' => ['description' => 'The time when the topic was created.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 20:05:50'], 'updateTime' => ['description' => 'The time when the topic was last modified.', 'type' => 'string', 'title' => '', 'example' => '2022-08-01 20:05:50'], 'maxSendTps' => ['description' => 'The maximum number of messages that can be sent per second.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'liteTopicExpiration' => ['description' => 'The expiration time of the lightweight topic. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'Topic.NotFound'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The topic cannot be found.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '400'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'TopicName'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'topicName'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 3,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageType\\": \\"NORMAL\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"remark\\": \\"This is the remark for test.\\",\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\",\\n \\"maxSendTps\\": 1000,\\n \\"liteTopicExpiration\\": 20\\n }\\n ]\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic cannot be found.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"TopicName\\",\\n \\"dynamicMessage\\": \\"topicName\\"\\n}","type":"json"}]', 'title' => 'ListTopics', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTopics'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListTopics', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/*'], ], ], ], ], ], 'ListTraces' => [ 'summary' => 'Queries the message traces for a specified topic.', 'path' => '/instances/{instanceId}/topics/{topicName}/traces', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREonsNKYZ9K', 'FEATUREonsJEU5XG', 'FEATUREonsYT2OK3'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-tl32upjeb08', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => true, 'example' => 'topic_hpms_product_price_change', 'title' => ''], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => true, 'example' => '2023-05-10 10:42:11', 'title' => ''], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['description' => 'The end time.', 'type' => 'string', 'required' => true, 'example' => '2023-05-19 10:10:09', 'title' => ''], ], [ 'name' => 'pageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number of the results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ 'name' => 'queryType', 'in' => 'query', 'schema' => [ 'description' => 'The query type.', 'enumValueTitles' => ['MESSAGE_ID' => 'MESSAGE\\_ID', 'MESSAGE_KEY' => 'MESSAGE\\_KEY', 'TOPIC' => 'TOPIC'], 'type' => 'string', 'required' => true, 'example' => 'MESSAGE_ID', 'title' => '', ], ], [ 'name' => 'messageId', 'in' => 'query', 'schema' => ['description' => 'The message ID.'."\n" ."\n" .'This parameter is required if \\`queryType\\` is set to \\`MESSAGE\\_ID\\`.', 'type' => 'string', 'required' => false, 'example' => '0100163E0EC1F1965C04C7906700000000', 'title' => ''], ], [ 'name' => 'messageKey', 'in' => 'query', 'schema' => ['description' => 'The message key.'."\n" ."\n" .'This parameter is required if \\`queryType\\` is set to \\`MESSAGE\\_KEY\\`.', 'type' => 'string', 'required' => false, 'example' => 'order_ceating', 'title' => ''], ], [ 'name' => 'liteTopicName', 'in' => 'query', 'schema' => ['description' => 'The name of the lightweight topic.', 'type' => 'string', 'example' => 'abc', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'EDFF77E1-1ED1-5389-B6A8-651D9433BBE5'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Topic.NotFound', 'title' => ''], 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .', 'title' => ''], 'data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'pageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'pageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'totalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'list' => [ 'description' => 'The paginated data.', 'type' => 'array', 'items' => [ 'description' => 'The paginated data.', 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****', 'title' => ''], 'topicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'topic_test', 'title' => ''], 'messageId' => ['description' => 'The message ID.', 'type' => 'string', 'example' => '7F00000100207A4F0F294A938F7807AE', 'title' => ''], 'bornTime' => ['description' => 'The time when the message was created.', 'type' => 'string', 'example' => '2023-03-22 12:17:08', 'title' => ''], 'messageTag' => ['description' => 'The message tag.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'messageKeys' => [ 'description' => 'The business keys.', 'type' => 'array', 'items' => ['description' => 'A business key.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'InstanceId', 'title' => ''], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'example' => 'InstanceId', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"EDFF77E1-1ED1-5389-B6A8-651D9433BBE5\\",\\n \\"success\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageId\\": \\"7F00000100207A4F0F294A938F7807AE\\",\\n \\"bornTime\\": \\"2023-03-22 12:17:08\\",\\n \\"messageTag\\": \\"xx\\",\\n \\"messageKeys\\": [\\n \\"xx\\"\\n ]\\n }\\n ]\\n },\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\"\\n}","type":"json"}]', 'title' => 'ListTraces', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTraces'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:ListTraces', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'ResetConsumeOffset' => [ 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeOffsets/{topicName}', 'methods' => ['patch'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-tl32ue44x0g', 'title' => ''], ], [ 'name' => 'consumerGroupId', 'in' => 'path', 'schema' => ['description' => 'The consumer group ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'dolphin_status', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['description' => 'The topic name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'AMZN_REPORT_TOPIC', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ 'resetType' => [ 'title' => '', 'description' => 'The method that is used to reset the consumer offset. Valid values: LATEST_OFFSET and SPECIFIED_TIME.'."\n", 'type' => 'string', 'required' => false, 'example' => 'LATEST_OFFSET', 'enumValueTitles' => ['SPECIFIED_TIME' => '从指定时间的位点开始消费', 'LATEST_OFFSET' => '从最新位点开始消费'], ], 'resetTime' => ['title' => '', 'description' => 'The time when the consumer offset is reset.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-03-22 12:17:08'], ], 'required' => false, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F9A95891-EAD4-5A2B-8A30-676CD18921AF'], 'success' => ['title' => '', 'description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The returned error code.'."\n", 'type' => 'string', 'example' => 'MissingInstanceId'], 'message' => ['title' => '', 'description' => 'The returned error message.'."\n", 'type' => 'string', 'example' => 'The instance cannot be found.'], 'httpStatusCode' => ['title' => '', 'description' => 'The returned HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The returned dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The returned dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F9A95891-EAD4-5A2B-8A30-676CD18921AF\\",\\n \\"success\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'ResetConsumeOffset', 'summary' => 'Resets the consumer offset of a consumer group. If you reset a consumer offset, the offset from which a consumer starts to consume messages is changed. If faults occur or wrong messages are consumed during message consumption, you can reset the consumer offset to roll back the consumption to a specific offset for reconsumption. You can also reset the consumer offset to the latest offset and temporarily leave the accumulated messages unhandled.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetConsumeOffset'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:ResetConsumeOffset', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], ], ], 'StartDisasterRecoveryItem' => [ 'path' => '/disaster_recovery/{planId}/items/{itemId}/start', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', 'schema' => ['description' => 'Backup plan ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016', 'title' => ''], ], [ 'name' => 'itemId', 'in' => 'path', 'schema' => ['description' => 'Mapping task ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100000704', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '请求ID', 'description' => 'Request ID', 'type' => 'string', 'example' => 'C7E8AE3A-219B-52EE-BE32-4036Fxxxxx'], 'success' => ['title' => '是否成功', 'description' => 'Whether the operation was successful', 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '返回结果', 'description' => 'Return result', 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '错误码', 'description' => 'Error code', 'type' => 'string', 'example' => 'DisasterRecoveryItemStatus.Error'], 'message' => ['title' => '错误信息', 'description' => 'Error message', 'type' => 'string', 'example' => 'The current status of the disaster recovery item does not support this operation.'], 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '动态错误码', 'description' => 'Dynamic error code', 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '动态错误信息', 'description' => 'Dynamic error message', 'type' => 'string', 'example' => 'InstanceId'], 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied due to the reason that the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7E8AE3A-219B-52EE-BE32-4036Fxxxxx\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"DisasterRecoveryItemStatus.Error\\",\\n \\"message\\": \\"The current status of the disaster recovery item does not support this operation.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'StartDisasterRecoveryItem', 'summary' => 'Starts a topic mapping of a Global Replicator task.', 'translator' => 'machine', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDisasterRecoveryItem'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:StartDisasterRecoveryItem', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'StopDisasterRecoveryItem' => [ 'path' => '/disaster_recovery/{planId}/items/{itemId}/stop', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', 'schema' => ['description' => 'Backup plan ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016', 'title' => ''], ], [ 'name' => 'itemId', 'in' => 'path', 'schema' => ['description' => 'Mapping task ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100070284', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '请求ID', 'description' => 'Request ID', 'type' => 'string', 'example' => 'A07B41BD-6DD3-5349-9E76-00303xxxx'], 'success' => ['title' => '是否成功', 'description' => 'Whether the operation was successful', 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '返回结果', 'description' => 'Return result', 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '错误码', 'description' => 'Error code', 'type' => 'string', 'example' => 'DisasterRecoveryItemStatus.Error'], 'message' => ['title' => '错误信息', 'description' => 'Error message', 'type' => 'string', 'example' => 'The current status of the disaster recovery item does not support this operation.'], 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '动态错误码', 'description' => 'Dynamic error code', 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '动态错误信息', 'description' => 'Dynamic error message', 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.', 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A07B41BD-6DD3-5349-9E76-00303xxxx\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"DisasterRecoveryItemStatus.Error\\",\\n \\"message\\": \\"The current status of the disaster recovery item does not support this operation.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'StopDisasterRecoveryItem', 'summary' => 'Stops a topic mapping of a Global Replicator task.', 'translator' => 'machine', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDisasterRecoveryItem'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:StopDisasterRecoveryItem', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'SyncDisasterRecoveryCheckpoint' => [ 'path' => '/disaster_recovery/{planId}/items/{itemId}/checkpoints/{checkpointId}', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '251695', 'abilityTreeNodes' => ['FEATUREonsOVRH1R'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', 'schema' => ['description' => 'Backup Plan ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13000000xx', 'title' => ''], ], [ 'name' => 'itemId', 'in' => 'path', 'schema' => ['description' => 'Mapping ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13000000xx', 'title' => ''], ], [ 'name' => 'checkpointId', 'in' => 'path', 'schema' => ['description' => 'Consumption Progress ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13000000xx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '7358418D-83BD-507A-8079-611C63E05674'], 'success' => ['description' => 'Success or Not', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'data' => ['description' => 'Result Data', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'code' => ['description' => 'Error Code', 'type' => 'string', 'example' => 'Topic.NotFound', 'title' => ''], 'message' => ['description' => 'Error Message', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .', 'title' => ''], 'httpStatusCode' => ['description' => 'HTTP Status Code', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'dynamicCode' => ['description' => 'Dynamic Error Code', 'type' => 'string', 'example' => 'InstanceId', 'title' => ''], 'dynamicMessage' => ['description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId', 'title' => ''], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7358418D-83BD-507A-8079-611C63E05674\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'SyncDisasterRecoveryCheckpoint', 'summary' => 'Synchronize Disaster Recovery Plan Consumption Progress', 'translator' => 'machine', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncDisasterRecoveryCheckpoint'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:SyncDisasterRecoveryCheckpoint', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'TagResources' => [ 'path' => '/resourceTag/create', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'regionId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'resourceType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The type of resource.'."\n" ."\n" .'Set this parameter to **instance**. The value of this parameter cannot be changed.'."\n", 'type' => 'string', 'required' => true, 'example' => 'instance'], ], [ 'name' => 'resourceId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The resource IDs, in the JSON format.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-pe3355cs707'], ], [ 'name' => 'tag', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'tag, in JSON format.', 'type' => 'string', 'required' => true, 'example' => '[{"key": "rmq-test", "value": "test"}]'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0B962390-D84B-5D44-8C11-79DF40299D41'], 'success' => ['title' => '', 'description' => 'Indicates whether the call was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The returned result.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Topic.NotFound'], 'message' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'The instance cannot be found.'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B962390-D84B-5D44-8C11-79DF40299D41\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'TagResources', 'summary' => 'Creates resource tags.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:TagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UntagResources' => [ 'path' => '/resourceTag/delete', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'regionId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'resourceType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The type of resource.'."\n" ."\n" .'Set this parameter to **instance**. The value of this parameter cannot be changed.'."\n", 'type' => 'string', 'required' => true, 'example' => 'instance'], ], [ 'name' => 'resourceId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The resource IDs, in the JSON format.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-pe3355cs707'], ], [ 'name' => 'tagKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The keys of tags.', 'type' => 'string', 'required' => false, 'example' => '["key1", "key2"]'], ], [ 'name' => 'all', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Whether to delete all tags.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'A07B41BD-6DD3-5349-9E76-00303DF04BBE'], 'success' => ['title' => '', 'description' => 'Indicates whether the call was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The returned data.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Topic.NotFound'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Parameter deliveryOrderType is invalid.'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A07B41BD-6DD3-5349-9E76-00303DF04BBE\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter deliveryOrderType is invalid.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'UntagResources', 'summary' => 'Removes tags from resources.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UntagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateConsumerGroup' => [ 'summary' => 'Updates the basic information and the consumption retry policy for a consumer group.', 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', 'methods' => ['patch'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '144683', 'abilityTreeNodes' => ['FEATUREonsTBTXFL'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance to which the consumer group belongs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rmq-cn-7e22on9****'], ], [ 'name' => 'consumerGroupId', 'in' => 'path', 'schema' => ['description' => 'The ID of the consumer group to update.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'CID-TEST'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'remark' => ['description' => 'The updated remarks for the consumer group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'This is the remark for test.'], 'deliveryOrderType' => [ 'description' => 'This parameter cannot be modified.', 'enumValueTitles' => ['Concurrently' => 'Concurrent', 'Orderly' => 'Orderly'], 'type' => 'string', 'deprecated' => true, 'required' => false, 'enum' => ['Concurrently', 'Orderly'], 'title' => '', 'example' => 'Concurrently', ], 'consumeRetryPolicy' => [ 'title' => '', 'description' => 'The updated consumption retry policy for the consumer group. For more information, see'."\n" .'[Consumption retry](~~440356~~).', 'type' => 'object', 'properties' => [ 'retryPolicy' => [ 'description' => 'The retry policy. For more information, see [Message retry](~~440356~~).'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- FixedRetryPolicy: fixed interval retry. This policy applies only to orderly messages.'."\n" ."\n" .'- DefaultRetryPolicy: backoff retry. This policy applies only to concurrent messages.', 'enumValueTitles' => ['FixedRetryPolicy' => 'Fixed interval retry', 'DefaultRetryPolicy' => 'Backoff retry'], 'type' => 'string', 'required' => true, 'enum' => ['DefaultRetryPolicy', 'FixedRetryPolicy'], 'title' => '', 'example' => 'DefaultRetryPolicy', ], 'maxRetryTimes' => ['description' => 'The maximum number of retries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '16'], 'deadLetterTargetTopic' => ['description' => 'The dead-letter topic.'."\n" ."\n" .'If a message fails to be consumed after the maximum number of retries, the message is sent to a dead-letter topic. You can then perform business recovery or trace the message. For more information, see [Consumption retry and dead-letter messages](~~440356~~).', 'type' => 'string', 'required' => false, 'example' => 'DLQ_mqtest', 'title' => ''], 'fixedIntervalRetryTime' => ['description' => 'The fixed retry interval. Unit: seconds. This parameter is valid only if you set the retryPolicy parameter to FixedRetryPolicy.'."\n" .'Value range:'."\n" ."\n" .'- Concurrent delivery: 10 to 1800'."\n" ."\n" .'- Orderly delivery: 1 to 600', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => true, 'example' => '', ], 'maxReceiveTps' => ['description' => 'The maximum transactions per second (TPS) for message consumption.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result\\', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID. Each request has a unique ID. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'C7F94090-3358-506A-97DC-34BC803C****'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => ['description' => 'The returned result.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'InvalidDeliveryOrderType'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Parameter deliveryOrderType is invalid.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '400'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'DeliveryOrderType'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'deliveryOrderType'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7F94090-3358-506A-97DC-34BC803C****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"InvalidDeliveryOrderType\\",\\n \\"message\\": \\"Parameter deliveryOrderType is invalid.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"DeliveryOrderType\\",\\n \\"dynamicMessage\\": \\"deliveryOrderType\\"\\n}","type":"json"}]', 'title' => 'UpdateConsumerGroup', 'description' => '>'."\n" ."\n" .'Alibaba Cloud OpenAPI is a management API. You can use it to manage and query Alibaba Cloud service resources. This API is intended for management purposes only. Do not use this API for core data links that send and receive messages because this may introduce potential threats to your data links.'."\n" ."\n" .'>', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConsumerGroup'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], ], ], 'UpdateDisasterRecoveryItem' => [ 'path' => '/disaster_recovery/{planId}/items/{itemId}', 'methods' => ['patch'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '263691', 'abilityTreeNodes' => ['FEATUREonsOVRH1R', 'FEATUREonsU22PJL'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', 'schema' => ['description' => 'The ID of the global message backup plan.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016', 'title' => ''], ], [ 'name' => 'itemId', 'in' => 'path', 'schema' => ['description' => 'The ID of the topic mapping.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100070284', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ 'topics' => [ 'description' => 'The topics involved in the topic mapping.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The topic involved in the topic mapping.'."\n", 'type' => 'object', 'properties' => [ 'regionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], 'instanceType' => [ 'description' => 'The instance type. Valid values:'."\n" ."\n" .'* ALIYUN_ROCKETMQ: ApsaraMQ for RocketMQ instance'."\n" .'* EXTERNAL_ROCKETMQ: open source RocketMQ cluster'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALIYUN_ROCKETMQ' => '阿里云实例', 'EXTERNAL_ROCKETMQ' => '外部实例'], 'example' => 'ALIYUN_ROCKETMQ'."\n", 'title' => '', ], 'instanceId' => ['description' => 'The instance ID. If you set instanceType to EXTERNAL_ROCKETMQ, the system automatically generates an ID for the instance. You can obtain the ID by querying the global message backup plan.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-em93y94xxx', 'title' => ''], 'topicName' => ['description' => 'The topic name. You must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Topic_xxx', 'title' => ''], 'consumerGroupId' => ['description' => 'The ID of the consumer group. If you use the two-way backup mode, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'GID_xxx', 'deprecated' => true, 'title' => ''], 'deliveryOrderType' => [ 'description' => 'The method used to deliver messages to the destination instance.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Concurrently: concurrent delivery'."\n" .'* Orderly: ordered delivery'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['Concurrently' => '并发投递', 'Orderly' => '顺序投递'], 'example' => 'Concurrently', 'title' => '', ], ], 'required' => false, 'title' => '', ], 'required' => false, 'title' => '', ], ], 'required' => false, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0C32BED2-FA9F-50AD-9DA7-8B70E26C9D0D'], 'success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'data' => ['description' => 'The returned data.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'code' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Topic.NotFound', 'title' => ''], 'message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The instance cannot be found.', 'title' => ''], 'httpStatusCode' => ['description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'dynamicCode' => ['description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId', 'title' => ''], 'dynamicMessage' => ['description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId', 'title' => ''], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0C32BED2-FA9F-50AD-9DA7-8B70E26C9D0D\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'UpdateDisasterRecoveryItem', 'summary' => 'Updates a topic mapping in a global message backup plan.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDisasterRecoveryItem'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateDisasterRecoveryItem', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'DisasterRecoveryItem', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'UpdateDisasterRecoveryPlan' => [ 'path' => '/disaster_recovery/{planId}', 'methods' => ['patch'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225048', 'abilityTreeNodes' => ['FEATUREonsU22PJL'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', 'schema' => ['description' => 'The ID of the global message backup plan.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ 'planName' => ['title' => '', 'description' => 'The name of the Global Replicator task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'planDesc' => ['title' => '', 'description' => 'The description of the Global Replicator task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'planType' => [ 'title' => '', 'description' => 'The type of the Global Replicator task. After you create a Global Replicator task, you cannot change the type of the task. Valid values:'."\n" ."\n" .'* ACTIVE_PASSIVE: one-way backup'."\n" .'* ACTIVE_ACTIVE: two-way backup'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ACTIVE_ACTIVE' => '单向备份', 'ACTIVE_PASSIVE' => '双向备份'], 'example' => 'ACTIVE_PASSIVE', ], 'instances' => [ 'title' => '', 'description' => 'The instances involved in the Global Replicator task. After you create a Global Replicator task, you cannot change the instances involved in the task. You can change only the message attribute and authentication type of the task.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance involved in the Global Replicator task.'."\n", 'type' => 'object', 'properties' => [ 'instanceType' => [ 'title' => '', 'description' => 'The instance type. Valid values:'."\n" ."\n" .'* ALIYUN_ROCKETMQ: ApsaraMQ for RocketMQ instance'."\n" .'* EXTERNAL_ROCKETMQ: open source RocketMQ cluster'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALIYUN_ROCKETMQ' => '阿里云实例', 'EXTERNAL_ROCKETMQ' => '外部实例'], 'example' => 'ALIYUN_ROCKETMQ', ], 'regionId' => ['title' => '', 'description' => 'The ID of the region where the instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], 'instanceId' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-83l3r0xxxx'], 'instanceRole' => [ 'title' => '', 'description' => 'The instance role. Valid values:'."\n" ."\n" .'* ACTIVE: primary instance'."\n" .'* Passive: secondary instance'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['PASSIVE' => '备', 'ACTIVE' => '主'], 'example' => 'ACTIVE', ], 'authType' => [ 'title' => '', 'description' => 'The authentication type. Valid values:'."\n" ."\n" .'* NO_AUTH: no authentication'."\n" .'* ACL_AUTH: access control list (ACL)-based authentication'."\n" ."\n" .''."\n" ."\n" .'*'."\n" .'*'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['NO_AUTH' => '无须认证', 'ACL_AUTH' => 'acl认证'], 'example' => 'NO_AUTH', ], 'username' => ['title' => '', 'description' => 'The username used for authentication. This parameter is required only if you set authType to ACL_AUTH.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'password' => ['title' => '', 'description' => 'The password used for authentication. This parameter is required only if you set authType to ACL_AUTH.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'endpointUrl' => ['title' => '', 'description' => 'The instance endpoint. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'networkType' => [ 'title' => '', 'description' => 'The network type. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ. Valid values:'."\n" ."\n" .'* TCP_INTERNET: Internet over TCP'."\n" .'* TCP_VPC: virtual private cloud (VPC) over TCP.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['TCP_VPC' => 'tcp专有网络', 'TCP_INTERNET' => 'tcp公网'], 'example' => 'TCP_INTERNET', ], 'vpcId' => ['title' => 'VPC ID', 'description' => 'The ID of the VPC with which the instance is associated. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-wz9qt50xhtj9krb******'."\n"], 'vSwitchId' => ['title' => '', 'description' => 'The ID of the vSwitch with which the instance is associated. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6gwtbn6etadpv******'."\n"], 'messageProperty' => [ 'description' => 'The message attribute. When you synchronize a message to the destination cluster, the system automatically adds the attribute to the message for SQL-based filtering.'."\n", 'type' => 'object', 'properties' => [ 'propertyKey' => ['description' => 'The attribute key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aaa', 'title' => ''], 'propertyValue' => ['description' => 'The attribute value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'bbb', 'title' => ''], ], 'required' => false, 'title' => '', ], 'securityGroupId' => ['description' => 'The ID of the security group to which the instance belongs. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-bp17hpmgz9******'."\n", 'title' => ''], 'consumerGroupId' => ['description' => 'The consumer group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'GID_DS_XXX_YYY', 'title' => ''], ], 'required' => false, 'title' => '', ], 'required' => false, ], 'autoSyncCheckpoint' => [ 'title' => '', 'description' => 'Specifies whether to enable automatic consumer progress synchronization.'."\n" ."\n" .'> This parameter takes effect only when you set `syncCheckpointEnabled` to true.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'required' => false, 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], 'example' => 'true', ], 'syncCheckpointEnabled' => [ 'description' => 'Specifies whether to enable consumer progress synchronization.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'required' => false, 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], 'example' => 'true', 'title' => '', ], ], 'required' => false, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A07B41BD-6DD3-5349-9E76-00303Dxxxx'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The data returned.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'DisasterRecoveryPlanStatus.Error'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The current status of the disaster recovery plan does not support this operation.'], 'httpStatusCode' => ['title' => '', 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A07B41BD-6DD3-5349-9E76-00303Dxxxx\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"DisasterRecoveryPlanStatus.Error\\",\\n \\"message\\": \\"The current status of the disaster recovery plan does not support this operation.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'UpdateDisasterRecoveryPlan', 'summary' => 'Modifies a global message backup plan.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDisasterRecoveryPlan'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateDisasterRecoveryPlan', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'UpdateInstance' => [ 'summary' => 'Updating the basic information and specifications of a Message Queue for Apache RocketMQ instance.', 'path' => '/instances/{instanceId}', 'methods' => ['patch'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance to update.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'instanceName' => ['description' => 'The updated instance name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test_instance'], 'remark' => ['description' => 'The updated remark for the instance.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'This is the remark for test.'], 'networkInfo' => [ 'title' => '', 'description' => 'The updated network information for the instance.', 'type' => 'object', 'properties' => [ 'internetInfo' => [ 'title' => '', 'description' => 'The internet information. This parameter is valid only if public access is enabled for the instance.', 'type' => 'object', 'properties' => [ 'ipWhitelist' => [ 'title' => '', 'description' => 'The IP address whitelist for public access.'."\n" ."\n" .'- If you do not configure an IP address whitelist, the instance allows access from any public IP address by default.'."\n" ."\n" .'- If you configure an IP address whitelist, only IP addresses in the whitelist can access the instance over the internet.', 'type' => 'array', 'items' => ['description' => 'An IP address or CIDR block in the public IP address whitelist.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '192.168.x.x/24'], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'productInfo' => [ 'title' => '', 'description' => 'The extended configuration of the instance.', 'type' => 'object', 'properties' => [ 'sendReceiveRatio' => ['description' => 'The message send/receive ratio.'."\n" ."\n" .'Valid values: \\[0.25, 1].', 'type' => 'number', 'format' => 'float', 'title' => '', 'required' => false, 'example' => '0.5'], 'autoScaling' => [ 'description' => 'Specifies whether to enable burstable performance for the instance.'."\n" ."\n" .'If you enable burstable performance, the instance can exceed its baseline transactions per second (TPS) within a specific range. You are charged for the TPS that exceeds the baseline. For more information about billing, see [Computing power fees](~~427237~~).'."\n" ."\n" .'> Burstable performance is supported only by specific instance editions. For more information about the supported instance editions, see [Instance editions](~~444715~~).', 'enumValueTitles' => ['true' => 'Enable burstable performance.', 'false' => 'Disable burstable performance.'], 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true', ], 'messageRetentionTime' => ['description' => 'The message retention period. Unit: hours.'."\n" ."\n" .'For information about the value range, see the "Message retention period" section in the [Limits](~~440347~~) topic.'."\n" ."\n" .'Message storage in Message Queue for Apache RocketMQ is serverless and elastic. You are charged for your actual storage usage. You can change the message retention period to adjust your storage capacity. For more information, see [Storage fees](~~427238~~).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '72'], 'traceOn' => [ 'description' => 'Specifies whether to enable the message trace feature.'."\n" ."\n" .'This parameter is not yet in effect. Message tracing is enabled by default for all instances.'."\n" .'This parameter is valid only for serverless instances. If you enable the message trace feature, you are charged for message traces. For more information about billing, see [Serverless instances](~~2586280~~).'."\n" .'This parameter does not apply to pay-as-you-go and subscription instances. The message trace feature is enabled by default for these instances.', 'enumValueTitles' => ['false' => 'Disables the message trace feature.', 'true' => 'Enables the message trace feature.'], 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => '', ], ], 'required' => false, 'example' => '', ], 'aclInfo' => [ 'description' => 'The access control information.', 'type' => 'object', 'properties' => [ 'aclTypes' => [ 'description' => 'The authentication mechanisms for the instance.', 'type' => 'array', 'items' => [ 'description' => 'The authentication mechanism for the instance.', 'enumValueTitles' => ['default' => 'intelligent authentication', 'apache_acl' => 'Apache RocketMQ ACL'], 'type' => 'string', 'required' => false, 'example' => 'apache_acl', 'title' => '', ], 'required' => false, 'title' => '', 'example' => '', ], 'defaultVpcAuthFree' => [ 'description' => 'Specifies whether to enable password-free access over VPCs when intelligent authentication is used.', 'enumValueTitles' => ['true' => 'Enables password-free access.', 'false' => 'Disables password-free access.'], 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The unique ID of the request, used to troubleshoot and trace issues.', 'type' => 'string', 'title' => '', 'example' => 'AA87DE09-DA44-52F4-9515-78B1B607****'], 'success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => ['description' => 'The result of the operation.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'MissingInstanceId'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '400'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AA87DE09-DA44-52F4-9515-78B1B607****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'UpdateInstance', 'description' => '>'."\n" ."\n" .'Alibaba Cloud\'s OpenAPI is a control plane API for managing and querying cloud resources. Use it on the control path only. Do not use this API on the core data path for message transport, as this can compromise service reliability.'."\n" ."\n" .'>', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'UpdateInstanceAccount' => [ 'summary' => 'Updates information for a specified account in a specified instance.', 'path' => '/instances/{instanceId}/accounts/{username}', 'methods' => ['patch'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '209887', 'abilityTreeNodes' => ['FEATUREonsGA7IC4'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'username', 'in' => 'path', 'schema' => ['description' => 'The name of the account.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'accountStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the account.', 'enumValueTitles' => ['DISABLE' => 'Disables the account.', 'ENABLE' => 'Enables the account.'], 'type' => 'string', 'required' => false, 'example' => 'ENABLE', 'title' => '', ], ], [ 'name' => 'password', 'in' => 'query', 'schema' => ['description' => 'The password for the account.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'remark', 'in' => 'query', 'schema' => ['description' => 'The remark for the account.', 'type' => 'string', 'example' => 'test', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => ['description' => 'Indicates whether the update was successful. The value is `true` if the update succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'code' => ['description' => 'The error code that is returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'Instance.NotFound'], 'message' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'The instance cannot be found.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'InstanceId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], 'accessDeniedDetail' => ['description' => 'Details about the access denial. This parameter is returned only when a request is denied due to insufficient RAM permissions.', 'type' => 'string', 'title' => '', 'example' => 'xxx'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Instance.NotFound\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', 'title' => 'UpdateInstanceAccount', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceAccount'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateInstanceAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'UpdateInstanceAcl' => [ 'summary' => 'Updates the permissions on the resources of a specific instance for a specific user.', 'path' => '/instances/{instanceId}/acl/account/{username}', 'methods' => ['patch'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '209892', 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ 'name' => 'username', 'in' => 'path', 'schema' => ['description' => 'The username.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ 'resourceType' => [ 'title' => '', 'description' => 'The type of the resource on which you want to grant permissions.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Group'."\n" .'* Topic'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], 'example' => 'Topic', ], 'resourceName' => ['title' => '', 'description' => 'The name of the resource on which you want to grant permissions.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test'], 'actions' => [ 'description' => 'The following types of operations are supported based on the resource type:'."\n" ."\n" .'* Topic: Pub, Sub, and Pub|Sub'."\n" .'* Group: Sub'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Sub: subscribe'."\n" .'* Pub|Sub: publish and subscribe'."\n" .'* Pub: publish'."\n", 'type' => 'array', 'items' => ['description' => 'The following types of operations are supported based on the resource type:'."\n" ."\n" .'* Topic: Pub, Sub, and Pub|Sub'."\n" .'* Group: Sub'."\n", 'type' => 'string', 'required' => false, 'example' => 'Pub', 'title' => ''], 'required' => false, 'enumValueTitles' => ['Sub' => '订阅', 'Pub|Sub' => '发送订阅', 'Pub' => '发送'], 'example' => 'Pub', 'title' => '', ], 'decision' => [ 'title' => '', 'description' => 'The decision result of the authorization.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Deny'."\n" .'* Allow'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['Deny' => '拒绝访问', 'Allow' => '允许访问'], 'example' => 'Allow', ], 'ipWhitelists' => [ 'title' => '', 'description' => 'The IP addresses in the whitelist.'."\n", 'type' => 'array', 'items' => ['description' => 'The IP address in the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0', 'title' => ''], 'required' => false, ], ], 'required' => false, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The returned data.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'MissingInstanceId'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], 'accessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", 'type' => 'string', 'example' => 'xxx'], ], ], ], ], 'title' => 'UpdateInstanceAcl', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceAcl'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateInstanceAcl', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C115601B-8736-5BBF-AC99-7FEAE1245A80\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', ], 'UpdateTopic' => [ 'summary' => 'Updates the remarks for a topic.', 'path' => '/instances/{instanceId}/topics/{topicName}', 'methods' => ['patch'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '144678', 'abilityTreeNodes' => ['FEATUREonsCON1A8'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['title' => '实例ID', 'description' => 'The ID of the instance that contains the topic.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['title' => '主题名称', 'description' => 'The name of the topic.', 'type' => 'string', 'required' => true, 'example' => 'topic_test'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'remark' => ['title' => '备注', 'description' => 'The updated remarks for the topic.', 'type' => 'string', 'required' => false, 'example' => 'This is the remark for test.'], 'maxSendTps' => ['description' => 'The maximum number of transactions per second (TPS) for sending messages.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], 'liteTopicExpiration' => ['description' => 'The expiration time of a lite topic, in minutes. Valid values: 15 to 720. The default value is -1, which indicates that the topic never expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => '', 'required' => false], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '请求ID', 'description' => 'The ID of the request. This ID is unique to each request and can be used to troubleshoot issues.', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], 'success' => ['title' => '是否成功', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '返回结果', 'description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '错误码', 'description' => 'The error code.', 'type' => 'string', 'example' => 'Topic.NotFound'], 'message' => ['title' => '错误信息', 'description' => 'The error message.', 'type' => 'string', 'example' => 'The topic cannot be found.'], 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'dynamicCode' => ['title' => '动态错误码', 'description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'TopicName'], 'dynamicMessage' => ['title' => '动态错误信息', 'description' => 'The dynamic error message.', 'type' => 'string', 'example' => 'topicName'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic cannot be found.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"TopicName\\",\\n \\"dynamicMessage\\": \\"topicName\\"\\n}","type":"json"}]', 'title' => 'UpdateTopic', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTopic'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateTopic', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'VerifyConsumeMessage' => [ 'path' => '/instances/{instanceId}/topics/{topicName}/messages/{messageId}/action/verifyConsume', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-i7m2vc1vx01', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['description' => 'The topic name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'delay_topic', 'title' => ''], ], [ 'name' => 'messageId', 'in' => 'path', 'schema' => ['description' => 'The message ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'A9FE190A59AA421ED014743DFDBF017D', 'title' => ''], ], [ 'name' => 'consumerGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the consumer group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'TEST_FINANCE_STOCK_OUT_GROUP', 'title' => ''], ], [ 'name' => 'clientId', 'in' => 'query', 'schema' => ['description' => 'The client ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'zeekr-settlement-server-dc555456f-v2lcg@1@1@qfvorazqns', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5304143F-AB0E-5AB4-A227-7C5489216FD5'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'data' => ['title' => '', 'description' => 'The returned data.'."\n", 'type' => 'boolean', 'example' => 'true'], 'code' => ['title' => '', 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Topic.NotFound'], 'message' => ['title' => '', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'dynamicCode' => ['title' => '', 'description' => 'The dynamic error code.'."\n", 'type' => 'string', 'example' => 'InstanceId'], 'dynamicMessage' => ['title' => '', 'description' => 'The dynamic error message.'."\n", 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5304143F-AB0E-5AB4-A227-7C5489216FD5\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', 'title' => 'VerifyConsumeMessage', 'summary' => 'Verifies the consumption status of a message in a specific topic on a specific instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyConsumeMessage'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:VerifyConsumeMessage', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], 'VerifySendMessage' => [ 'summary' => 'Tests whether messages can be sent to a specified topic in an instance.', 'path' => '/instances/{instanceId}/topics/{topicName}/messages', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREonsB0E8FD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-wwo32kqfm10', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'path', 'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'required' => true, 'example' => 'card_status_topic', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'message' => ['description' => 'The message content.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'successful'], 'messageTag' => ['description' => 'The message tag.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xx'], 'messageKey' => ['description' => 'The business key.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xx'], 'liteTopicName' => ['description' => 'The name of the Lite Message Queue topic.', 'type' => 'string', 'example' => 'abc', 'title' => '', 'required' => false], 'messageGroup' => ['description' => 'The ID of the message group. This parameter applies only to ordered messages. Messages with the same group ID are consumed in the order they are sent.', 'type' => 'string', 'example' => 'testMessageGroup', 'title' => '', 'required' => false], 'deliveryTimeStamp' => ['description' => 'The delivery time for a delayed message, specified as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1773718320000', 'title' => '', 'required' => false], 'userProperties' => ['description' => 'The user-defined properties of the message.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{"test":"test"}'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3BD2C19B-66DE-59C7-B2F6-FD1BE21DC8C1'], 'success' => ['description' => 'Indicates if the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'data' => ['description' => 'The data returned by the operation. If the verification succeeds, this field contains the message ID.', 'type' => 'string', 'title' => '', 'example' => '0A64228900207A4F0F2931A4E0D40BE5'], 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'InvalidConsumerGroupId'], 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The instance cannot be found.'], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'dynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'title' => '', 'example' => 'ConsumerGroupId'], 'dynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'title' => '', 'example' => 'consumerGroupId'], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3BD2C19B-66DE-59C7-B2F6-FD1BE21DC8C1\\",\\n \\"success\\": true,\\n \\"data\\": \\"0A64228900207A4F0F2931A4E0D40BE5\\",\\n \\"code\\": \\"InvalidConsumerGroupId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"ConsumerGroupId\\",\\n \\"dynamicMessage\\": \\"consumerGroupId\\"\\n}","type":"json"}]', 'title' => 'VerifySendMessage', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifySendMessage'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:VerifySendMessage', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], ], ], ], 'endpoints' => [ ['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-nanjing.aliyuncs.com', 'endpoint' => 'rocketmq.cn-nanjing.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'rocketmq.cn-wulanchabu.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-wulanchabu.aliyuncs.com'], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-beijing.aliyuncs.com', 'endpoint' => 'rocketmq.cn-beijing.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-beijing.aliyuncs.com'], ['regionId' => 'cn-zhengzhou-jva', 'regionName' => 'Zhengzhou (China Unicom Joint Venture)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-zhengzhou-jva.aliyuncs.com', 'endpoint' => 'rocketmq.cn-zhengzhou-jva.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-zhengzhou-jva.aliyuncs.com'], ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-qingdao.aliyuncs.com', 'endpoint' => 'rocketmq.cn-qingdao.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-qingdao.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-shanghai.aliyuncs.com', 'endpoint' => 'rocketmq.cn-shanghai.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-shanghai.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-hongkong.aliyuncs.com', 'endpoint' => 'rocketmq.cn-hongkong.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-hongkong.aliyuncs.com'], ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-heyuan.aliyuncs.com', 'endpoint' => 'rocketmq.cn-heyuan.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-heyuan.aliyuncs.com'], ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'rocketmq.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-zhangjiakou.aliyuncs.com'], ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-shenzhen.aliyuncs.com', 'endpoint' => 'rocketmq.cn-shenzhen.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-shenzhen.aliyuncs.com'], ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.ap-northeast-2.aliyuncs.com', 'endpoint' => 'rocketmq.ap-northeast-2.aliyuncs.com', 'vpc' => 'rocketmq-vpc.ap-northeast-2.aliyuncs.com'], ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.ap-northeast-1.aliyuncs.com', 'endpoint' => 'rocketmq.ap-northeast-1.aliyuncs.com', 'vpc' => 'rocketmq-vpc.ap-northeast-1.aliyuncs.com'], ['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-fuzhou.aliyuncs.com', 'endpoint' => 'rocketmq.cn-fuzhou.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-fuzhou.aliyuncs.com'], ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-chengdu.aliyuncs.com', 'endpoint' => 'rocketmq.cn-chengdu.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-chengdu.aliyuncs.com'], ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-guangzhou.aliyuncs.com ', 'endpoint' => 'rocketmq.cn-guangzhou.aliyuncs.com ', 'vpc' => 'rocketmq-vpc.cn-guangzhou.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.ap-southeast-1.aliyuncs.com', 'endpoint' => 'rocketmq.ap-southeast-1.aliyuncs.com', 'vpc' => 'rocketmq-vpc.ap-southeast-1.aliyuncs.com'], ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.ap-southeast-2.aliyuncs.com', 'endpoint' => 'rocketmq.ap-southeast-2.aliyuncs.com', 'vpc' => 'rocketmq-vpc.ap-southeast-2.aliyuncs.com'], ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.ap-southeast-3.aliyuncs.com', 'endpoint' => 'rocketmq.ap-southeast-3.aliyuncs.com', 'vpc' => 'rocketmq-vpc.ap-southeast-3.aliyuncs.com'], ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-huhehaote.aliyuncs.com', 'endpoint' => 'rocketmq.cn-huhehaote.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-huhehaote.aliyuncs.com'], ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.ap-southeast-5.aliyuncs.com', 'endpoint' => 'rocketmq.ap-southeast-5.aliyuncs.com', 'vpc' => 'rocketmq-vpc.ap-southeast-5.aliyuncs.com'], ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.ap-southeast-6.aliyuncs.com', 'endpoint' => 'rocketmq.ap-southeast-6.aliyuncs.com', 'vpc' => 'rocketmq-vpc.ap-southeast-6.aliyuncs.com'], ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.ap-southeast-7.aliyuncs.com', 'endpoint' => 'rocketmq.ap-southeast-7.aliyuncs.com', 'vpc' => 'rocketmq-vpc.ap-southeast-7.aliyuncs.com'], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rocketmq.cn-hangzhou.aliyuncs.com', 'endpoint' => 'rocketmq.cn-hangzhou.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-hangzhou.aliyuncs.com'], ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'rocketmq.us-east-1.aliyuncs.com', 'endpoint' => 'rocketmq.us-east-1.aliyuncs.com', 'vpc' => 'rocketmq-vpc.us-east-1.aliyuncs.com'], ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'rocketmq.eu-west-1.aliyuncs.com', 'endpoint' => 'rocketmq.eu-west-1.aliyuncs.com', 'vpc' => 'rocketmq-vpc.eu-west-1.aliyuncs.com'], ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'rocketmq.us-west-1.aliyuncs.com', 'endpoint' => 'rocketmq.us-west-1.aliyuncs.com', 'vpc' => 'rocketmq-vpc.us-west-1.aliyuncs.com'], ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'rocketmq.eu-central-1.aliyuncs.com', 'endpoint' => 'rocketmq.eu-central-1.aliyuncs.com', 'vpc' => 'rocketmq-vpc.eu-central-1.aliyuncs.com'], ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'rocketmq.me-east-1.aliyuncs.com', 'endpoint' => 'rocketmq.me-east-1.aliyuncs.com', 'vpc' => 'rocketmq-vpc.me-east-1.aliyuncs.com'], ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'rocketmq.me-central-1.aliyuncs.com', 'endpoint' => 'rocketmq.me-central-1.aliyuncs.com', 'vpc' => 'rocketmq-vpc.me-central-1.aliyuncs.com'], ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'rocketmq.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'rocketmq.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-hangzhou-finance.aliyuncs.com'], ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'rocketmq.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'rocketmq.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-shenzhen-finance-1.aliyuncs.com'], ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'rocketmq.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'rocketmq.cn-beijing-finance-1.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-beijing-finance-1.aliyuncs.com'], ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'rocketmq.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'rocketmq.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-shanghai-finance-1.aliyuncs.com'], ], 'errorCodes' => [ ['code' => 'Ability.Existed', 'message' => 'The ability already exsits.', 'http_code' => 400, 'description' => 'The ability already exists.'], ['code' => 'Ability.NotFound', 'message' => 'The ability cannot be found.', 'http_code' => 404, 'description' => 'The ability does not exist.'], ['code' => 'AbilityStatus.NotPending', 'message' => 'The ability has yet to take effect.', 'http_code' => 400, 'description' => 'The ability is not in the pending state.'], ['code' => 'AsyncTask.Ignored', 'message' => 'The asynchronous task ignored.', 'http_code' => 400, 'description' => 'Execution of the asynchronous task is ignored.'], ['code' => 'AsyncTask.InOrder', 'message' => 'The asynchronous task appending.', 'http_code' => 400, 'description' => 'The asynchronous task is in queue.'], ['code' => 'AsyncTask.NotCompleted', 'message' => 'The asynchronous task not complete yet.', 'http_code' => 400, 'description' => 'The asynchronous task is not completed.'], ['code' => 'AsyncTask.NotFound', 'message' => 'The asynchronous task does not exist.', 'http_code' => 404, 'description' => 'The asynchronous task does not exist.'], ['code' => 'AsyncTaskGroup.NotFound', 'message' => 'The asynchronous task group does not exist.', 'http_code' => 404, 'description' => 'The group of the asynchronous task does not exist.'], ['code' => 'AsyncTaskHandler.NotFound', 'message' => 'The asynchronous task executor does not exist.', 'http_code' => 404, 'description' => 'The executor of the asynchronous task does not exist.'], ['code' => 'AsyncTaskSlave.NotCompleted', 'message' => 'The asynchronous sub task not complete yet.', 'http_code' => 400, 'description' => 'The subtask of the asynchronous task is not completed.'], ['code' => 'AsyncTaskType.NotFound', 'message' => 'The asynchronous task type does not exist.', 'http_code' => 404, 'description' => 'The type of the asynchronous task does not exist.'], ['code' => 'Commodity.Existed', 'message' => 'The commodity already exists.', 'http_code' => 400, 'description' => 'The product already exists.'], ['code' => 'Commodity.NotFound', 'message' => 'The commodity cannot be found.', 'http_code' => 404, 'description' => 'The product does not exist.'], ['code' => 'CommodityStatus.NotPending', 'message' => 'The commodity is not pending.', 'http_code' => 400, 'description' => 'The product is not in the pending state.'], ['code' => 'CommodityStatus.NotValid', 'message' => 'The commodity has yet to take effect.', 'http_code' => 400, 'description' => 'The product is not in effect.'], ['code' => 'ConsumerGroup.Existed', 'message' => 'The consumerGroup already exists.', 'http_code' => 400, 'description' => 'The group is already created.'], ['code' => 'ConsumerGroup.NotFound', 'message' => 'The consumerGroup cannot be found.', 'http_code' => 404, 'description' => 'The group does not exist.'], ['code' => 'ConsumerGroupCount.Limited', 'message' => 'The group quantity over limit', 'http_code' => 400, 'description' => 'The number of groups exceeds the capacity.'], ['code' => 'ConsumerGroupStatus.NotRunning', 'message' => 'The consumerGroup is not running.', 'http_code' => 400, 'description' => 'The group is not running.'], ['code' => 'DateFormatError', 'message' => 'The date format error.', 'http_code' => 400, 'description' => 'An exception occurred during time conversion.'], ['code' => 'DisasterRecoveryActiveTopic.Duplicated', 'message' => 'In the disaster recovery plan items, the topics in the source cluster cannot be duplicated.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryCrossBorder.NotSupport', 'message' => 'The disaster recovery plan does not support cross-border synchronization.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryInstance.NotEmpty', 'message' => 'The instance information in the disaster recovery plan cannot be empty.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryInstance.NotSupportChange', 'message' => 'The instances in the disaster recovery plan do not support to change.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryInstanceAliyun.AtLeastOne', 'message' => 'The disaster recovery plan instance information must include at least one Alibaba Cloud instance.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryInstancePrivateIp.NotSupport', 'message' => 'In the disaster recovery instance information, if the network is set to public, private IP addresses are not supported.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryInstanceSeriesType.NotSupport', 'message' => 'The primary family of the instance in the backup plan does not support.', 'http_code' => 400, 'description' => 'The primary family of the instance in the backup plan does not support'], ['code' => 'DisasterRecoveryInstanceSize.Error', 'message' => 'The disaster recovery plan must include exactly two instances.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryItem.Duplicated', 'message' => 'In the disaster recovery plan items, the Topic cannot be duplicated.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryItem.InstanceError', 'message' => 'The instance information transmitted in the disaster recovery item is incorrect.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryItem.NotAllDeleted', 'message' => 'The disaster recovery plan items have not been completely deleted.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryItem.NotFound', 'message' => 'The disaster recovery plan item does not exist.', 'http_code' => 404, 'description' => ''], ['code' => 'DisasterRecoveryItemStatus.Error', 'message' => 'The current status of the disaster recovery item does not support this operation.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryMessagePropertyKey.MustSame', 'message' => 'In different disaster recovery plans, the message property key for the same instance must remain consistent.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryMessagePropertyKey.NotMatch', 'message' => 'In the disaster recovery plan, the message property key for different instances must be consistent.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryMessagePropertyValue.NOT_SAME', 'message' => 'The filter value cannot be consistent between instances in the backup plan.', 'http_code' => 400, 'description' => 'The filter value cannot be consistent between instances in the backup plan.'], ['code' => 'DisasterRecoveryPlan.Duplicate', 'message' => 'The disaster recovery task cannot contain two identical instances.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryPlan.NotFound', 'message' => 'The disaster recovery plan does not exist.', 'http_code' => 404, 'description' => ''], ['code' => 'DisasterRecoveryPlanName.Repeat', 'message' => 'The disaster recovery plan name already exists.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryPlanSameDirection.NotSupport', 'message' => 'The synchronization of disaster recovery plan instances in the same direction does not support duplication.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryPlanStatus.Error', 'message' => 'The current status of the disaster recovery plan does not support this operation.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryPlanType.UpdateNotSupport', 'message' => 'The disaster recovery plan does not support updating the plan type.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryPlanUser.NotBelong', 'message' => 'The disaster recovery plan does not belong to the current user.', 'http_code' => 403, 'description' => ''], ['code' => 'DisasterRecoveryRegion.NotSupport', 'message' => 'The region of the instance in the disaster recovery plan is not supported.', 'http_code' => 400, 'description' => 'The region of the instance in the disaster recovery plan is not supported.'], ['code' => 'DisasterRecoveryRegion.NotSupportOperate', 'message' => 'The current region does not support operations for this disaster recovery plan.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryTopic.SizeError', 'message' => 'The number of Topics in the disaster recovery item is exactly two.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryTopicConsumerGroup.IsUsed', 'message' => 'The consumer group used in this disaster recovery item has already been utilized.', 'http_code' => 400, 'description' => ''], ['code' => 'DisasterRecoveryTopicConsumerGroup.TooLong', 'message' => 'The consumer group generated based on the topic name is too long, and creating a disaster recovery task is not supported.', 'http_code' => 400, 'description' => ''], ['code' => 'EntityNotExist.Role', 'message' => 'The role does not exist.', 'http_code' => 400, 'description' => 'The role does not exist'], ['code' => 'GroupName.canSystemReserved', 'message' => 'The group name has been reserved by the system.', 'http_code' => 400, 'description' => 'The group name is occupied in the system.'], ['code' => 'Instance.Existed', 'message' => 'The instance already exists.', 'http_code' => 400, 'description' => 'The instance already exists.'], ['code' => 'Instance.NotFound', 'message' => 'The instance cannot be found.', 'http_code' => 404, 'description' => 'The instance does not exist.'], ['code' => 'InstanceApacheAcl.NotSupport', 'message' => 'instance does not support acl identification.', 'http_code' => 400, 'description' => 'instance does not support acl identification'], ['code' => 'InstanceEndpoint.NotExist', 'message' => 'The instanceEndpoint does not exist.', 'http_code' => 404, 'description' => 'The instanceEndpoint does not exist.'], ['code' => 'InstanceId.NotNull', 'message' => 'The instanceId is mandatory for this action.', 'http_code' => 400, 'description' => 'The instance ID cannot be empty.'], ['code' => 'InstanceRelease.NotSupport', 'message' => 'The current instance type does not support the release operation', 'http_code' => 400, 'description' => 'The instance cannot be released.'], ['code' => 'InstanceStatus.NotAllowed', 'message' => 'The operation is forbidden for current instance states.', 'http_code' => 400, 'description' => 'You cannot modify the current status of the instance.'], ['code' => 'InstanceStatus.NotRunning', 'message' => 'The instance is not running.', 'http_code' => 400, 'description' => 'The instance is not running.'], ['code' => 'InstanceStatus.Released', 'message' => 'The instance already released.', 'http_code' => 400, 'description' => 'The instance is released.'], ['code' => 'InstanceStatus.Stopped', 'message' => 'The instance already stopped.', 'http_code' => 400, 'description' => 'The instance is terminated.'], ['code' => 'InstanceUser.NotBelong', 'message' => 'The instance does not belong to the current user', 'http_code' => 403, 'description' => 'The instance does not belong to the current user.'], ['code' => 'InternalError', 'message' => 'An error occurred while processing your request. Please submit the work order.', 'http_code' => 500, 'description' => 'A system exception occurred. Please submit a ticket.'], ['code' => 'Invalid%s', 'message' => 'Parameter %s is invalid.', 'http_code' => 400, 'description' => 'The %s parameter is invalid.'], ['code' => 'Invalid%s.Format', 'message' => 'Parameter format %s is invalid.', 'http_code' => 400, 'description' => 'The format of the %s parameter is invalid.'], ['code' => 'Invalid%s.Length', 'message' => 'Parameter length %s is invalid.', 'http_code' => 400, 'description' => 'The length of the %s parameter is invalid.'], ['code' => 'Invalid%s.Range', 'message' => 'Parameter range %s is invalid.', 'http_code' => 400, 'description' => 'The range of the parameter %s is invalid.'], ['code' => 'MessageSendTopic.NotSupport', 'message' => 'The current messageType is not supported.', 'http_code' => 400, 'description' => 'Messages of this topic cannot be sent.'], ['code' => 'MeterRecord.Existed', 'message' => 'The meterRecord already exists.', 'http_code' => 400, 'description' => 'The metering record already exists.'], ['code' => 'MigrationRegion.NotSupport', 'message' => 'The region does not support migration.', 'http_code' => 400, 'description' => 'The region does not support migration.'], ['code' => 'MigrationStatus.Error', 'message' => 'Migration status is abnormal.', 'http_code' => 400, 'description' => 'Migration status is abnormal'], ['code' => 'Missing%s', 'message' => 'Parameter %s is mandatory for this action .', 'http_code' => 400, 'description' => 'The %s parameter is missing.'], ['code' => 'NoPermission', 'message' => 'Permission denied', 'http_code' => 403, 'description' => 'You do not have the permissions.'], ['code' => 'Order.Existed', 'message' => 'The order already exists.', 'http_code' => 400, 'description' => 'The order already exists.'], ['code' => 'Order.NotFound', 'message' => 'The order cannot be found.', 'http_code' => 404, 'description' => 'The order cannot be found.'], ['code' => 'OrderType.NotSupport', 'message' => 'The order type not supported.', 'http_code' => 400, 'description' => 'The order type is not supported.'], ['code' => 'ProxyAccount.NotSupport', 'message' => 'Proxy account not supported.', 'http_code' => 400, 'description' => 'Proxy account not supported'], ['code' => 'RamResourceError', 'message' => 'The ram resource error.', 'http_code' => 400, 'description' => 'An RAM resource exception occurred.'], ['code' => 'RemoteCallError', 'message' => 'An internal service invocation error occurred while processing your request. Please try again later.', 'http_code' => 500, 'description' => 'An internal service invocation error occurred. Please try again later.'], ['code' => 'RequestConflict', 'message' => 'Request conflict: The current resource is undergoing concurrent modifications by another request or system task, please try again later.', 'http_code' => 423, 'description' => 'Request conflict: The current resource is undergoing concurrent modifications by another request or system task, please try again later.'], ['code' => 'Resource.NotFound', 'message' => 'The resource is not found.', 'http_code' => 404, 'description' => 'The resource is not found.'], ['code' => 'ResourceGroup.CheckFailed', 'message' => 'Failed to check the resource group.', 'http_code' => 400, 'description' => 'Failed to check the resource group.'], ['code' => 'ResourceGroup.UpdateError', 'message' => 'Failed to update the resource group.', 'http_code' => 400, 'description' => 'Failed to update the resource group.'], ['code' => 'ResourceTagService.Error', 'message' => 'Failed to manipulate the resource tag.', 'http_code' => 400, 'description' => 'Failed to manipulate resource tag'], ['code' => 'Service.Existed', 'message' => 'The service already exists.', 'http_code' => 400, 'description' => 'The service already exists.'], ['code' => 'Service.NotFound', 'message' => 'The service cannot be found.', 'http_code' => 404, 'description' => 'The service does not exist.'], ['code' => 'ServiceMsgProcessSpec.NotFound', 'message' => 'The message process spec cannot be found.', 'http_code' => 404, 'description' => 'The computing specification for messaging does not exist.'], ['code' => 'ServiceSeries.Existed', 'message' => 'The serviceSeries already exists.', 'http_code' => 400, 'description' => 'The service series already exists.'], ['code' => 'ServiceSeries.NotFound', 'message' => 'The serviceSeries cannot be found.', 'http_code' => 404, 'description' => 'The service series does not exist.'], ['code' => 'ServiceSeries.NotNull', 'message' => 'The serviceSeries is mandatory for this action.', 'http_code' => 400, 'description' => 'The service series cannot be empty.'], ['code' => 'ServiceSeriesStatus.NotPending', 'message' => 'The serviceSeries is not pending.', 'http_code' => 400, 'description' => 'The service series is not in the pending state.'], ['code' => 'ServiceSeriesStatus.NotValid', 'message' => 'The serviceSeries does not take effect.', 'http_code' => 400, 'description' => 'The service series is not in effect.'], ['code' => 'StsCertificate.NotNull', 'message' => 'The sts certificate is mandatory for this action.', 'http_code' => 400, 'description' => 'The STS certificate cannot be empty.'], ['code' => 'Topic.Existed', 'message' => 'The topic already exists.', 'http_code' => 400, 'description' => 'The topic is already created.'], ['code' => 'Topic.NotFound', 'message' => 'The topic cannot be found.', 'http_code' => 404, 'description' => 'The topic does not exist.'], ['code' => 'TopicCount.Limited', 'message' => 'The topic quantity over limit', 'http_code' => 400, 'description' => 'The number of topics exceeds the capacity.'], ['code' => 'TopicName.NotStandard', 'message' => 'The topic name is invalid.', 'http_code' => 400, 'description' => 'The topic name is non-standard.'], ['code' => 'TopicName.System', 'message' => 'The topic name has been reserved by the system.', 'http_code' => 400, 'description' => 'The topic name is occupied in the system.'], ['code' => 'TopicStatus.notRunning', 'message' => 'The topic is not running.', 'http_code' => 400, 'description' => 'The topic is not running.'], ['code' => 'TraceRecord.Existed', 'message' => 'The trace record already exists.', 'http_code' => 400, 'description' => 'The trace record is already created.'], ['code' => 'TraceRecord.NotFound', 'message' => 'The trace record cannot be found.', 'http_code' => 404, 'description' => 'The trace record does not exist.'], ['code' => 'TraceResult.Existed', 'message' => 'The trace result is already created.', 'http_code' => 400, 'description' => 'The trace result is already created.'], ['code' => 'TraceResult.notFound', 'message' => 'The trace result cannot be found.', 'http_code' => 404, 'description' => 'The trace result cannot be found.'], ['code' => 'Unauthorized', 'message' => 'not authorized.', 'http_code' => 400, 'description' => 'Unauthorized'], ], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceAcl'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTopics'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceAcl'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTraces'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncDisasterRecoveryCheckpoint'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDisasterRecoveryItem'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConsumerGroupSubscription'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConsumerGroupSubscriptions'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifySendMessage'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTopic'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDisasterRecoveryItem'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDisasterRecoveryItem'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceAccount'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConsumerGroup'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTopic'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDisasterRecoveryItem'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDisasterRecoveryItem'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceAccount'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstanceIpWhitelist'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstanceIpWhitelist'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrace'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceAccount'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAvailableZones'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDisasterRecoveryItem'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDisasterRecoveryPlan'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstance'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConsumerGroup'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceIpWhitelist'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConsumerGroupLag'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstanceAccount'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConsumerGroup'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDisasterRecoveryPlan'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstanceAcl'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetConsumeOffset'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConsumerGroups'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTopic'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMessageDetail'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyConsumeMessage'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceAcl'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConsumerConnections'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTopic'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceIpWhitelist'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMetricMeta'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTopicSubscriptions'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstanceAcl'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDisasterRecoveryPlan'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConsumerGroup'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDisasterRecoveryPlans'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDisasterRecoveryCheckpoints'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDisasterRecoveryItems'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMessages'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConsumerGroupSubscription'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConsumerStack'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstanceAccount'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDisasterRecoveryPlan'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'], ], ], 'ram' => [ 'productCode' => 'RocketMQ', 'productName' => 'ApsaraMQ for RocketMQ', 'ramCodes' => ['rocketmq'], 'ramLevel' => 'RESOURCE', 'ramConditions' => [ [ 'name' => 'rocketmq:InternetSpec', 'schema' => [ 'type' => 'String', 'description' => 'whether to enable the Internet access feature', 'enums' => ['enable', 'disable'], ], ], ], 'ramActions' => [ [ 'apiName' => 'DeleteTopic', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteTopic', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'ListDisasterRecoveryItems', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:ListDisasterRecoveryItems', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'DeleteDisasterRecoveryPlan', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:DeleteDisasterRecoveryPlan', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'DeleteInstance', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'GetDisasterRecoveryPlan', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetDisasterRecoveryPlan', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'ListMessages', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListMessages', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'UpdateDisasterRecoveryPlan', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateDisasterRecoveryPlan', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'StopDisasterRecoveryItem', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:StopDisasterRecoveryItem', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'UpdateInstanceAcl', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateInstanceAcl', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'CreateDisasterRecoveryPlan', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:CreateDisasterRecoveryPlan', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'CreateInstanceIpWhitelist', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'rocketmq:CreateInstanceIpWhitelist', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'CreateInstanceAcl', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'rocketmq:CreateInstanceAcl', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'GetTopic', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetTopic', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'ListDisasterRecoveryCheckpoints', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListDisasterRecoveryCheckpoints', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetInstance', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'ListTopics', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListTopics', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/*'], ], ], ], [ 'apiName' => 'GetConsumeTimespan', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetConsumeTimespan', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}/consumergroup/{#ConsumerGroupId}'], ], ], ], [ 'apiName' => 'VerifySendMessage', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:VerifySendMessage', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'TagResources', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:TagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'CreateInstanceAccount', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'rocketmq:CreateInstanceAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'ListConsumerConnections', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListConsumerConnections', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], [ 'apiName' => 'VerifyConsumeMessage', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:VerifyConsumeMessage', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'ResetConsumeOffset', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:ResetConsumeOffset', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], [ 'apiName' => 'UpdateDisasterRecoveryItem', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateDisasterRecoveryItem', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'DisasterRecoveryItem', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'ListTagResources', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListTagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetMessageDetail', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetMessageDetail', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'GetTrace', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetTrace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'GetInstanceIpWhitelist', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetInstanceIpWhitelist', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'IpWhitelist', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'ListTraces', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:ListTraces', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'SyncDisasterRecoveryCheckpoint', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:SyncDisasterRecoveryCheckpoint', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListInstanceAcl', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListInstanceAcl', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'ListConsumerGroupSubscriptions', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListConsumerGroupSubscriptions', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], [ 'apiName' => 'ListInstances', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListInstances', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/*'], ], ], ], [ 'apiName' => 'ListMigrations', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListMigrations', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDisasterRecoveryItem', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:DeleteDisasterRecoveryItem', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'ExecuteMigrationOperation', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:ExecuteMigrationOperation', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'DeleteConsumerGroupSubscription', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteConsumerGroupSubscription', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], [ 'apiName' => 'GetDisasterRecoveryItem', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetDisasterRecoveryItem', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'ListTopicSubscriptions', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListTopicSubscriptions', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'GetInstanceAccount', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetInstanceAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'UpdateInstanceAccount', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateInstanceAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'FinishMigrationStage', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:FinishMigrationStage', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'GetInstanceAcl', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetInstanceAcl', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Acl', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'GetConsumerGroup', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], [ 'apiName' => 'GetConsumerGroupLag', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetConsumerGroupLag', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], [ 'apiName' => 'AddDisasterRecoveryItem', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:AddDisasterRecoveryItem', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'DeleteConsumerGroup', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], [ 'apiName' => 'ListDisasterRecoveryPlans', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:ListDisasterRecoveryPlans', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListInstanceIpWhitelist', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListInstanceIpWhitelist', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'CreateInstance', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'rocketmq:CreateInstance', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'rocketmq:InternetSpec', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:Instance/*'], ], ], ], [ 'apiName' => 'UpdateTopic', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateTopic', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'CreateTopic', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'rocketmq:CreateTopic', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'UpdateConsumerGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UpdateConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], [ 'apiName' => 'ListInstanceAccount', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListInstanceAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'ListMigrationOperations', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListMigrationOperations', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'CreateConsumerGroup', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'rocketmq:CreateConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], [ 'apiName' => 'StartDisasterRecoveryItem', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:StartDisasterRecoveryItem', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ], ], ], [ 'apiName' => 'UntagResources', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:UntagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteInstanceAccount', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteInstanceAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'GetConsumerStack', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetConsumerStack', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], [ 'apiName' => 'ListConsumerGroups', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListConsumerGroups', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/*'], ], ], ], [ 'apiName' => 'GetConsumerGroupSubscription', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'rocketmq:GetConsumerGroupSubscription', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ], ], ], [ 'apiName' => 'DeleteInstanceAcl', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteInstanceAcl', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'ListMetricMeta', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'rocketmq:ListMetricMeta', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteInstanceIpWhitelist', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'rocketmq:DeleteInstanceIpWhitelist', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'ChangeResourceGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'rocketmq:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'resourceTypes' => [ ['validationType' => 'always', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ['validationType' => 'always', 'resourceType' => 'Topic', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/*'], ['validationType' => 'always', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}/consumergroup/{#ConsumerGroupId}'], ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/*'], ['validationType' => 'always', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}'], ['validationType' => 'always', 'resourceType' => 'DisasterRecoveryItem', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}'], ['validationType' => 'always', 'resourceType' => 'IpWhitelist', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:*:{#accountId}:*'], ['validationType' => 'always', 'resourceType' => 'Acl', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:*'], ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:Instance/*'], ['validationType' => 'always', 'resourceType' => 'ConsumerGroup', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/*'], ], ], ];