diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/rocketmq | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/rocketmq')
| -rw-r--r-- | data/en_us/rocketmq/2022-08-01/api-docs.php | 19830 |
1 files changed, 7400 insertions, 12430 deletions
diff --git a/data/en_us/rocketmq/2022-08-01/api-docs.php b/data/en_us/rocketmq/2022-08-01/api-docs.php index c1e6ab3..631e457 100644 --- a/data/en_us/rocketmq/2022-08-01/api-docs.php +++ b/data/en_us/rocketmq/2022-08-01/api-docs.php @@ -1,186 +1,70 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'RocketMQ', - 'version' => '2022-08-01', - ], + 'info' => ['style' => 'ROA', 'product' => 'RocketMQ', 'version' => '2022-08-01'], 'directories' => [ [ - 'id' => 322709, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'CreateInstance', - 'UpdateInstance', - 'DeleteInstance', - 'ListInstances', - 'GetInstance', - ], - ], - [ - 'id' => 322715, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'CreateTopic', - 'UpdateTopic', - 'DeleteTopic', - 'ListTopics', - 'GetTopic', - ], - ], - [ - 'id' => 322721, - 'title' => null, + 'children' => ['CreateTopic', 'UpdateTopic'], 'type' => 'directory', - 'children' => [ - 'CreateConsumerGroup', - 'UpdateConsumerGroup', - 'DeleteConsumerGroup', - 'ListConsumerGroups', - 'GetConsumerGroup', - ], + 'title' => 'Subject', ], [ - 'id' => 322727, - 'title' => null, + 'children' => ['ListConsumerGroups', 'GetConsumerGroup'], 'type' => 'directory', - 'children' => [ - 'ListTopicSubscriptions', - 'ListConsumerGroupSubscriptions', - 'GetConsumerGroupSubscription', - 'DeleteConsumerGroupSubscription', - ], + 'title' => 'Consumer groups', ], [ - 'id' => 322732, - 'title' => null, + 'children' => ['ListConsumerGroupSubscriptions'], 'type' => 'directory', - 'children' => [ - 'ListConsumerConnections', - 'GetConsumerGroupLag', - 'GetConsumerStack', - 'ResetConsumeOffset', - ], + 'title' => 'Subscription Relationships', ], [ - 'id' => 322737, - 'title' => null, + 'children' => ['ListConsumerConnections', 'GetConsumerGroupLag'], 'type' => 'directory', - 'children' => [ - 'ListMessages', - 'GetMessageDetail', - 'VerifySendMessage', - 'VerifyConsumeMessage', - ], + 'title' => 'Usage', ], [ - 'id' => 322742, - 'title' => null, + 'children' => ['ListMessages', 'GetMessageDetail', 'VerifySendMessage'], 'type' => 'directory', - 'children' => [ - 'ListTraces', - 'GetTrace', - ], + 'title' => 'Messages', ], [ - 'id' => 322745, - 'title' => null, + 'children' => ['CreateInstanceAccount', 'UpdateInstanceAccount', 'ListInstanceAccount', 'GetInstanceAccount', 'CreateInstanceAcl', 'UpdateInstanceAcl'], 'type' => 'directory', - 'children' => [ - 'CreateInstanceAccount', - 'UpdateInstanceAccount', - 'DeleteInstanceAccount', - 'ListInstanceAccount', - 'GetInstanceAccount', - 'CreateInstanceAcl', - 'UpdateInstanceAcl', - 'DeleteInstanceAcl', - 'ListInstanceAcl', - 'GetInstanceAcl', - 'CreateInstanceIpWhitelist', - 'DeleteInstanceIpWhitelist', - 'ListInstanceIpWhitelist', - 'GetInstanceIpWhitelist', - ], + 'title' => 'Access control list (ACL)', ], [ - 'id' => 322760, - 'title' => null, + 'children' => ['ListMigrations', 'ListMigrationOperations', 'ExecuteMigrationOperation', 'FinishMigrationStage'], 'type' => 'directory', - 'children' => [ - 'ListMigrations', - 'ListMigrationOperations', - 'ExecuteMigrationOperation', - 'FinishMigrationStage', - ], + 'title' => 'Cloud migration', ], [ - 'id' => 322765, - 'title' => null, + 'children' => ['CreateDisasterRecoveryPlan', 'UpdateDisasterRecoveryPlan', 'ListDisasterRecoveryPlans', 'GetDisasterRecoveryPlan', 'ListDisasterRecoveryItems'], 'type' => 'directory', - 'children' => [ - 'CreateDisasterRecoveryPlan', - 'DeleteDisasterRecoveryPlan', - 'UpdateDisasterRecoveryPlan', - 'ListDisasterRecoveryPlans', - 'GetDisasterRecoveryPlan', - 'AddDisasterRecoveryItem', - 'UpdateDisasterRecoveryItem', - 'DeleteDisasterRecoveryItem', - 'StartDisasterRecoveryItem', - 'StopDisasterRecoveryItem', - 'ListDisasterRecoveryItems', - 'GetDisasterRecoveryItem', - 'ListDisasterRecoveryCheckpoints', - 'SyncDisasterRecoveryCheckpoint', - ], + 'title' => 'Global Replicator', ], [ - 'id' => 322780, - 'title' => null, + 'children' => ['GetConsumeTimespan'], 'type' => 'directory', - 'children' => [ - 'ListTagResources', - 'TagResources', - 'UntagResources', - ], + 'title' => 'Other', ], [ - 'id' => 322784, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'ChangeResourceGroup', + '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', ], - ], - [ - 'id' => 322786, - 'title' => null, + 'title' => 'Others', 'type' => 'directory', - 'children' => [ - 'GetConsumeTimespan', - 'ListRegions', - 'ListAvailableZones', - 'ListMetricMeta', - ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CreateInstance' => [ - 'summary' => 'Creates an ApsaraMQ for RocketMQ 5.x instance.', - 'path' => '/instances', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddDisasterRecoveryItem' => [ + 'path' => '/disaster_recovery/{planId}/items', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -189,479 +73,902 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '145030', - 'abilityTreeNodes' => [ - 'FEATUREonsWNMPZ3', + '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<Boolean>', + 'description' => 'Result<Boolean>', + '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' => 'clientToken', + '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 client token that is used to ensure the idempotence of the request. You can use the client to generate the value of this parameter, but you must ensure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", + 'description' => 'The type of resource.'."\n" + ."\n" + .'Set this parameter to **instance**. The value of this parameter cannot be changed.'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'c2c5d1274a8d4317a13bc5b0d4******', + '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.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'instanceName' => [ - 'title' => '实例名称', - 'description' => 'The name of the instance that you want to create.'."\n" + '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" - .'If you leave this parameter empty, the instance ID is used as the instance name.'."\n", + .'- Orderly: Messages are delivered in order.', + 'enumValueTitles' => ['Concurrently' => 'Concurrent delivery', 'Orderly' => 'Orderly delivery'], 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-72u3048uxxx', + 'required' => true, + 'enum' => ['Orderly', 'Concurrently'], + 'example' => 'Concurrently', ], - 'serviceCode' => [ - 'title' => '服务编码', - 'description' => 'The code of the service to which the instance belongs. The service code of ApsaraMQ for RocketMQ is rmq.'."\n", - 'type' => 'string', + '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' => 'rmq', - 'default' => 'rmq', + 'example' => '', ], - 'seriesCode' => [ - 'title' => '系列编码', - 'description' => 'The primary edition of the instance. For information about the differences among primary edition instances, see [Instance selection](~~444722~~).'."\n" + '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" - .'Valid values:'."\n" + .'- CLUSTERING'."\n" ."\n" - .'* standard: Standard Edition'."\n" - .'* ultimate: Enterprise Platinum Edition'."\n" - .'* professional: Professional Edition'."\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<Boolean>', + 'description' => 'Result\\<boolean>', + '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' => '><notice>'."\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" + .'></notice>', + '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" - .'> After you create an instance, you can only upgrade the primary edition of the instance. The following editions are sorted in ascending order: Standard Edition, Professional Edition, Enterprise Platinum Edition. For example, you can upgrade an instance from Standard Edition to Professional Edition, but you cannot downgrade an instance from Professional Edition to Standard Edition.'."\n", + .'* ACTIVE_PASSIVE: one-way backup'."\n" + .'* ACTIVE_ACTIVE: two-way backup'."\n", 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'standard' => '', - 'ultimate' => '', - 'professional' => '', + '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' => '', ], - 'example' => 'standard', + 'required' => false, ], - 'subSeriesCode' => [ - 'title' => '子系列编码', - 'description' => 'The sub-category edition of the instance. For information about the differences among sub-category edition instances, see [Instance selection](~~444722~~).'."\n" + '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" - .'* cluster_ha: Cluster High-availability Edition'."\n" - .'* single_node: Standalone Edition'."\n" - .'* serverless: serverless'."\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" - .'If you set seriesCode to ultimate, you can set this parameter only to cluster_ha.'."\n" + .'Valid values:'."\n" ."\n" - .'> After you create an instance, you cannot change the sub-category edition of the instance.'."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], + 'example' => 'true', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Long>', + 'description' => 'Result<Long>', + '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" - .'Valid values:'."\n" + .'><notice>'."\n" ."\n" - .'* serverless: serverless'."\n" - .'* cluster_ha: Cluster High-availability Edition'."\n" - .'* single_node: Standalone Edition'."\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" + .'></notice>', + 'enumValueTitles' => ['standard' => 'Standard Edition', 'ultimate' => 'Platinum Edition', 'professional' => 'Professional Edition'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'serverless' => '', - 'cluster_ha' => 'cluster_ha', - 'single_node' => 'single_node', - ], + '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" + .'><notice>After an instance is created, you cannot change its sub-edition.></notice>', + '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' => [ - 'title' => '付费类型,'."\n" - .'预付费：Subscription'."\n" - .'后付费：PayAsYouGo', - 'description' => 'The billing method of the instance. ApsaraMQ for RocketMQ supports the subscription and pay-as-you-go billing methods.'."\n" + 'description' => 'The billing method of the instance. Message Queue for Apache RocketMQ supports subscription and pay-as-you-go.'."\n" ."\n" - .'Valid values:'."\n" - ."\n" - .'* PayAsYouGo: This billing method allows you to use resources before you pay for the resources.'."\n" - .'* Subscription: This billing method allows you to use resources after you pay for the resources.'."\n" - ."\n" - .'For more information, see [Billing methods](~~427234~~).'."\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, - 'enumValueTitles' => [ - 'PayAsYouGo' => '', - 'Subscription' => '', - ], + 'enum' => ['Subscription', 'PayAsYouGo'], + 'title' => '', 'example' => 'Subscription', - 'enum' => [ - 'Subscription', - 'PayAsYouGo', - ], - ], - 'period' => [ - 'title' => '购买时长，只有预付费支持', - 'description' => 'The subscription duration of the instance. This parameter takes effect only if you set paymentType to Subscription.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Monthly subscription: 1, 2, 3, 4, 5, and 6'."\n" - .'* Yearly subscription: 1, 2, and 3'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', ], + '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' => [ - 'title' => '购买时长单位，只有预付费支持'."\n" - .'月：Month'."\n" - .'年：Year', - 'description' => 'The unit of the subscription duration.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Month'."\n" - .'* Year'."\n", + '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, - 'enumValueTitles' => [ - 'Month' => '', - 'Year' => '', - ], + 'enum' => ['Month', 'Year'], + 'title' => '', 'example' => 'Month', - 'enum' => [ - 'Month', - 'Year', - ], ], 'autoRenew' => [ - 'title' => '是否自动续费，只有预付费支持', - 'description' => 'Specifies whether to enable auto-renewal for the instance. This parameter takes effect only if you set paymentType to Subscription. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", + '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, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], 'example' => 'true', ], - 'autoRenewPeriod' => [ - 'title' => '自动续费周期，只有预付费支持', - 'description' => 'The auto-renewal cycle of the instance. This parameter takes effect only if you set autoRenew to true. Unit: months.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Monthly renewal: 1, 2, 3, 6, and 12'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'remark' => [ - 'title' => '备注信息', - 'description' => 'The instance description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is the remark for test.', - ], + '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 information about instance specifications.'."\n", + 'title' => '', + 'description' => 'The specifications of the instance.', 'type' => 'object', 'properties' => [ - 'msgProcessSpec' => [ - 'title' => '消息收发规格', - 'description' => 'The computing specification that specifies the messaging transactions per second (TPS) of the instance. For more information, see [Instance editions](~~444715~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rmq.s2.2xlarge', - ], - 'sendReceiveRatio' => [ - 'title' => '消息收发比例', - 'description' => 'The ratio of the message sending TPS to the messaging TPS of the instance.'."\n" - ."\n" - .'For example, if the maximum messaging TPS of an instance is 1,000 and the ratio of the message sending TPS to the messaging TPS of the instance is 0.8, the maximum message sending TPS of the instance is 800 and the maximum message receiving TPS is 200.'."\n" - ."\n" - .'Valid values: 0 to 1. Default value: 0.5.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.5', - ], + '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' => [ - 'title' => '是否开启弹性伸缩', - 'description' => 'Specifies whether to enable the elastic TPS feature for the instance.'."\n" + 'description' => 'Specifies whether to enable elastic TPS for the instance.'."\n" ."\n" - .'Valid values:'."\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" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'After you enable the elastic TPS feature for an ApsaraMQ for RocketMQ instance, you can use a specific amount of TPS that exceeds the specification limit. You are charged for the elastic TPS feature. For more information, see [Computing fees](~~427237~~).'."\n" - ."\n" - .'> The elastic TPS feature is supported only by instances of specific editions. For more information, see [Instance editions](~~444715~~).'."\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, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], 'example' => 'true', ], - 'messageRetentionTime' => [ - 'title' => '消息保留时长', - 'description' => 'The retention period of messages. Unit: hours.'."\n" - ."\n" - .'For information about the valid values of this parameter, see the "Limits on resource quotas" section of the [Limits](~~440347~~) topic.'."\n" - ."\n" - .'ApsaraMQ for RocketMQ supports serverless scaling of message storage. You are charged storage fees based on your actual storage usage. You can change the retention period of messages to manage storage capacity. For more information, see [Storage fees](~~427238~~).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '72', - ], - 'storageEncryption' => [ - 'title' => '是否开启存储加密', - 'description' => 'Specifies whether to enable the encryption at rest feature.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'storageSecretKey' => [ - 'title' => '存储加密密钥Key', - 'description' => 'The key for encryption at rest.'."\n", + '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' => 'xxx', + 'example' => 'provisioned', ], - 'capacityType' => [ - 'title' => '容量模式。provisioned：预留+弹性；onDemand：按量付费', + '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', - 'enum' => [ - 'provisioned', - 'ondemand', - ], - ], - 'provisionedCapacity' => [ - 'title' => '预留容量', - 'type' => 'integer', - 'format' => 'int64', - ], - 'traceOn' => [ - 'title' => '是否开启消息轨迹功能。'."\n" - ."\n" - .'true：开启消息轨迹功能'."\n" - .'false：关闭消息轨迹功能'."\n" - .'该参数仅对 Serverless 类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见 Serverless 计费说明。 对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。', - 'type' => 'boolean', + 'example' => 'async_cross_az', + 'title' => '', + 'required' => false, ], ], 'required' => false, + 'example' => '', ], 'networkInfo' => [ - 'title' => '网络信息', - 'description' => 'The information about the network.'."\n", + 'title' => '', + 'description' => 'The network configurations.', 'type' => 'object', 'properties' => [ 'vpcInfo' => [ - 'title' => '专有网络信息', - 'description' => 'The virtual private cloud (VPC)-related configurations.'."\n", + 'title' => '', + 'description' => 'The virtual private cloud (VPC) configurations.', 'type' => 'object', 'properties' => [ - 'vpcId' => [ - 'title' => '专有网络ID', - 'description' => 'The ID of the VPC with which the instance to be created is associated.'."\n" - ."\n" - .'> After you create an ApsaraMQ for RocketMQ instance, you cannot change the VPC with which the instance is associated. If you want to change the VPC with which the instance is associated, you must release the instance and create a new instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-wz9qt50xhtj9krb******', - ], - 'vSwitchId' => [ - 'title' => '交换机ID', - 'description' => 'The ID of the vSwitch with which the instance is associated. If you want to specify multiple vSwitches, separate the vSwitches with vertical bars (|).'."\n" + '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" + .'><notice>'."\n" + ."\n" + .'This parameter is deprecated. We recommend that you use the `vSwitches` parameter.'."\n" + ."\n" + .'></notice>', '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 you create an ApsaraMQ for RocketMQ instance, you cannot change the vSwitch with which the instance is associated. If you want to change the vSwitch with which the instance is associated, you must release the instance and purchase a new instance.'."\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" - .'> We recommend that you configure vSwitches instead of this parameter.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'vsw-uf6gwtbn6etadpv*******', - ], - 'securityGroupIds' => [ - 'description' => 'The ID of the security group to which the instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sg-bp17hpmgz96tvnsdy6so', - ], - 'vSwitches' => [ - 'description' => 'The vSwitches.'."\n" + .'><notice>'."\n" ."\n" - .'> After you create an ApsaraMQ for RocketMQ instance, you cannot change the vSwitch with which the instance is associated. If you want to change the vSwitch with which the instance is associated, you must release the instance and purchase a new instance.'."\n" + .'This parameter is required. We recommend that you use this parameter to specify a vSwitch instead of the deprecated `vSwitchId` parameter.'."\n" ."\n" - .'> This parameter is required. We recommend that you configure this parameter instead of vSwitchId.'."\n", + .'></notice>', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'vSwitchId' => [ - 'description' => 'The ID of the vSwitch with which the instance is associated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-uf6gwtbn6etadpv*******', - ], + '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-related configurations.'."\n", + 'title' => '', + 'description' => 'The Internet access configurations.', 'type' => 'object', 'properties' => [ 'internetSpec' => [ - 'title' => '是否开启公网'."\n" - .'开启：enable'."\n" - .'关闭：disable', - 'description' => 'Specifies whether to enable the Internet access feature.'."\n" - ."\n" - .'Valid values:'."\n" + 'description' => 'Specifies whether to enable Internet access.'."\n" ."\n" - .'* enable'."\n" - .'* disable'."\n" - ."\n" - .'By default, ApsaraMQ for RocketMQ allows you to access instances in VPCs. If you enable Internet access for an instance, you can access the instance over the Internet. After you enable this feature, you are charged for outbound Internet traffic. For more information, see [Internet access fees](~~427240~~).'."\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, - 'enumValueTitles' => [ - 'enable' => '', - 'disable' => '', - ], + 'title' => '', 'example' => 'disable', ], 'flowOutType' => [ - 'title' => '公网计费类型'."\n" - .'固定带宽计费：payByBandwidth', - 'description' => 'The metering method of Internet usage.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* payByBandwidth: pay-by-bandwidth. This value is valid only if you enable Internet access.'."\n" - .'* payByTraffic: pay-by-traffic. This value is valid only if you enable Internet access.'."\n" - .'* uninvolved: No metering method is involved. This value is valid only if you disable Internet access.'."\n", + '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, - 'enumValueTitles' => [ - 'payByBandwidth' => 'payByBandwidth', - 'payByTraffic' => '', - 'uninvolved' => 'uninvolved', - ], + 'title' => '', 'example' => 'uninvolved', ], - 'flowOutBandwidth' => [ - 'title' => '公网带宽规格', - 'description' => 'The Internet bandwidth. Unit: MB/s.'."\n" - ."\n" - .'This parameter is required only if you set flowOutType to payByBandwidth.'."\n" - ."\n" - .'Valid values: 1 to 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + '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' => '公网IP白名单列表', - 'description' => 'The whitelist that includes the CIDR blocks that are allowed to access the ApsaraMQ for RocketMQ broker over the Internet. This parameter can be configured only if you use the public endpoint to access the instance.'."\n" + '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 CIDR blocks are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n" - .'* If you configure an IP address whitelist, only the CIDR blocks in the whitelist are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\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' => [ - 'title' => '公网IP白名单', - 'description' => 'The CIDR blocks in the whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.x.x/24', - ], + '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, - ], - 'commodityCode' => [ - 'description' => 'The commodity code. Valid values:'."\n" - ."\n" - .'* ons_rmqpost_public_intl: pay-as-you-go'."\n" - .'* ons_rmqsub_public_intl: subscription'."\n" - .'* ons_rmqsrvlesspost_public_intl: serverless instance'."\n" - .'serverless instance requires this parameter', - 'type' => 'string', - 'required' => false, - 'example' => 'ons_ rmqpost_public_cn', - ], - 'resourceGroupId' => [ - 'title' => '资源组ID', - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzy6pist7uuna', - ], + 'example' => '', + ], + 'commodityCode' => ['description' => 'The commodity code.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- `ons_rmqsub_public_cn`: subscription instance'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- `ons_rmqpost_public_cn`: pay-as-you-go instance'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- `ons_rmqsrvlesspost_public_cn`: serverless instance'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'- `ons_rmqpost_public_intl`: pay-as-you-go instance'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'- `ons_rmqsub_public_intl`: subscription instance'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'- `ons_rmqsrvlesspost_public_intl`: serverless instance'."\n" + ."\n" + .'</props>', '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 tags that you want to add to the instance.', + 'description' => 'The resource tags.', 'type' => 'array', 'items' => [ - 'description' => 'The tags that are used to filter instances.'."\n", + 'description' => 'The resource tag.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => 'The `key` of the tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'aaa', - ], - 'value' => [ - 'description' => 'The `value` of the tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'bbb', - ], + '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' => [ - 'title' => '访问控制信息', 'type' => 'object', 'properties' => [ - 'defaultVpcAuthFree' => [ - 'title' => '是否支持vpc免密访问', - 'type' => 'boolean', - ], + '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' => '', ], ], ], @@ -669,76 +976,56 @@ 200 => [ 'schema' => [ 'title' => 'Result<String>', - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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 ID of the created instance.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'code' => [ - 'title' => '错误码', - 'description' => 'The error code returned if the call failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'The HTTP status code returned.'."\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', - ], + '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' => '', ], ], ], - '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"}]', 'title' => 'CreateInstance', - '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", - ], - 'UpdateInstance' => [ - 'summary' => 'Updates the basic information and specifications of an ApsaraMQ for RocketMQ instance.', - 'path' => '/instances/{instanceId}', - 'methods' => [ - 'patch', + 'description' => '><notice>'."\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" + .'></notice>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -746,184 +1033,28 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the instance whose basic information and specifications you want to update.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + '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.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'instanceName' => [ - 'title' => '实例名称', - 'description' => 'The updated name of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_instance', - ], - 'remark' => [ - 'title' => '实例备注', - 'description' => 'The updated description of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is the remark for test.', - ], - 'networkInfo' => [ - 'title' => '网络信息', - 'description' => 'The updated network information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'internetInfo' => [ - 'title' => '公网信息', - 'description' => 'The information about the Internet over which the instance is accessed. This parameter takes effect only if the Internet access feature is enabled for the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'ipWhitelist' => [ - 'title' => '公网IP白名单列表', - 'description' => 'The whitelist that includes the IP addresses that are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n" - ."\n" - .'* If you do not configure an IP address whitelist, all CIDR blocks are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n" - .'* If you configure an IP address whitelist, only the IP addresses in the whitelist are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '公网IP白名单', - 'description' => 'The IP addresses in the whitlist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.x.x/24', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'productInfo' => [ - 'title' => '扩展配置', - 'description' => 'Additional configurations of the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'sendReceiveRatio' => [ - 'title' => '消息收发比例', - 'description' => 'The ratio of the number of messages that you can send to the number of messages that you can receive on the instance.'."\n" - ."\n" - .'Value values: 0.25 to 1.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.5', - ], - 'autoScaling' => [ - 'title' => '自适应弹性伸缩', - 'description' => 'Specifies whether to enable the elastic transactions per second (TPS) feature for the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'After you enable the elastic TPS feature for an ApsaraMQ for RocketMQ instance, you can use a specific number of TPS that exceeds the specification limit. You are charged for using the elastic TPS feature. For more information, see [Computing fees](~~427237~~).'."\n" - ."\n" - .'> The elastic TPS feature is supported only by specific instance editions. For more information, see [Instance editions](~~444715~~).'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'messageRetentionTime' => [ - 'title' => '消息保留时长', - 'description' => 'The retention period of messages. Unit: hours.'."\n" - ."\n" - .'For information about the valid values of this parameter, see the "Limits on resource quotas" section of the [Limits](~~440347~~) topic.'."\n" - ."\n" - .'ApsaraMQ for RocketMQ supports serverless scaling of message storage. You are charged storage fees based on your actual storage usage. You can change the retention period of messages to manage storage capacity. For more information, see [Storage fees](~~427238~~).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '72', - ], - 'traceOn' => [ - 'description' => 'Specifies whether to enable the message trace feature.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'This parameter is not in use. By default, the message trace feature is enabled for ApsaraMQ for RocketMQ instances, regardless of whether this parameter is configured.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'false' => '', - 'true' => '', - ], - 'example' => 'true', - ], - ], - 'required' => false, - ], - 'aclInfo' => [ - 'description' => 'The access control list for the instance.', - 'type' => 'object', - 'properties' => [ - 'aclTypes' => [ - 'description' => 'The authentication type of the instance.', - 'type' => 'array', - 'items' => [ - 'description' => 'The authentication type of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- default: intelligent identity authentication'."\n" - ."\n" - .'- apache_acl:access control list (ACL) identity authentication', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'default' => 'default', - 'apache_acl' => 'apache_acl', - ], - 'example' => 'apache_acl', - ], - 'required' => false, - ], - 'defaultVpcAuthFree' => [ - 'description' => 'Indicates whether the authentication-free in VPCs feature is enabled.'."\n" - .'Indicates whether the authentication-free in VPCs feature is enabled.'."\n" - .'Valid values:'."\n" - .'- true'."\n" - .'- false', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'false', - ], - ], - 'required' => false, - ], + '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' => '', ], ], ], @@ -931,76 +1062,50 @@ 200 => [ 'schema' => [ 'title' => 'Result<Boolean>', - 'description' => 'The response object.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => 'AA87DE09-DA44-52F4-9515-78B1B607****', - ], - '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' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - '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', - ], + '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\\": \\"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' => '> 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.', - ], - 'DeleteInstance' => [ - 'summary' => 'Releases an instance.', - 'path' => '/instances/{instanceId}', - 'methods' => [ - 'delete', + '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'], + ], ], - 'schemes' => [ - 'https', - 'http', + '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' => [], @@ -1009,1410 +1114,226 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', + 'abilityTreeCode' => '209893', + 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the ApsaraMQ for RocketMQ instance that you want to delete.', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody0129', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + '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' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result'."\n", + 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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", + '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', - 'example' => 'MissingInstanceId', + 'required' => true, + 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], + 'enum' => ['Topic', 'Group'], + 'example' => 'Topic', ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", + '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', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', + 'required' => true, + 'enumValueTitles' => ['Deny' => '拒绝访问', 'Allow' => '允许访问'], + 'enum' => ['Allow', 'Deny'], + 'example' => 'Allow', ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => 'The dynamic error code.'."\n", - 'type' => 'string', - 'example' => 'InstanceId', + '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' => '', ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'instanceId', + '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' => '', ], ], - ], - ], - ], - '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', - '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", - ], - 'ListInstances' => [ - 'summary' => 'Queries all ApsaraMQ for RocketMQ instances in a specific 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' => [ - 'title' => '过滤关键字', - 'description' => 'The filter condition that is used to query instances. If you do not configure this parameter, all instances are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-7e22ody****', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页页码', - 'description' => 'The page number.'."\n" - ."\n" - .'Valid values: 1 to 100000000.'."\n" - ."\n" - .'If you set this parameter to a value smaller than 1, the system uses 1 as the value. If you set this parameter to a value greater than 100000000, the system uses 100000000 as the value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Value values: 10 to 200.'."\n" - ."\n" - .'If you set this parameter to a value smaller than 10, the system uses 10 as the value. If you set this parameter to a value greater than 200, the system uses 200 as the value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '10', - 'example' => '10', - ], - ], - [ - 'name' => 'resourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源组ID', - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmx7caj******', - ], - ], - [ - 'name' => 'tags', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tags that are used to filter instances.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"key": "rmq-test", "value": "test"}]', - ], - ], - [ - 'name' => 'seriesCodes', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'The primary edition of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* standard: Standard Edition'."\n" - .'* ultimate: Enterprise Platinum Edition'."\n" - .'* professional: Professional Edition'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The primary edition of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - ], 'required' => false, - ], - ], - [ - 'name' => 'storageSecretKey', - 'in' => 'query', - 'schema' => [ - 'title' => '存储加密密钥Key', - 'description' => 'The storage encryption key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxx', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<MyPage<InstanceDTO>>', - 'description' => 'The response parameters.'."\n", + 'title' => 'Result<Boolean>', + 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '84445A20-2B50-5306-A3C0-AF99FC1833C6', - ], - '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 of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'title' => '分页大小', - 'description' => 'The number of entries returned on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'totalCount' => [ - 'title' => '总记录数', - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'list' => [ - 'title' => '分页数据', - 'description' => 'The pagination information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => 'The ID of the region in which the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'instanceName' => [ - 'title' => '实例名称', - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'test instance', - ], - 'status' => [ - 'title' => '实例状态', - 'description' => 'The status of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RELEASED'."\n" - .'* RUNNING'."\n" - .'* STOPPED'."\n" - .'* CHANGING'."\n" - .'* CREATING'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'RELEASED' => '', - 'RUNNING' => '', - 'STOPPED' => '', - 'CHANGING' => '', - 'CREATING' => '', - ], - 'example' => 'RUNNING', - 'enum' => [ - 'CREATING', - 'CHANGING', - 'RUNNING', - 'STOPPED', - 'RELEASED', - ], - ], - 'startTime' => [ - 'title' => '开服时间', - 'description' => 'The time when the instance was created.'."\n", - 'type' => 'string', - 'example' => '2022-08-01 00:00:00', - ], - 'expireTime' => [ - 'title' => '过期时间', - 'description' => 'The time when the instance expires.'."\n", - 'type' => 'string', - 'example' => '2022-09-01 00:00:00', - ], - 'releaseTime' => [ - 'title' => '释放时间', - 'description' => 'The time when the instance was released.'."\n", - 'type' => 'string', - 'example' => '2022-09-07 00:00:00', - ], - 'userId' => [ - 'title' => '所属人ID', - 'description' => 'The ID of the user who owns the instance.'."\n", - 'type' => 'string', - 'example' => '6W0xz2uPfiwp****', - ], - 'commodityCode' => [ - 'title' => '商品编码', - 'description' => 'The commodity code of the instance. The commodity code of ApsaraMQ for RocketMQ 5.0 instances has a similar format to ons_rmqsub_public_cn.'."\n", - 'type' => 'string', - 'example' => 'ons_rmqsub_public_cn', - ], - 'serviceCode' => [ - 'title' => '服务编码', - 'description' => 'The code of the service to which the instance belongs. The service code of ApsaraMQ for RocketMQ is rmq.'."\n", - 'type' => 'string', - 'example' => 'rmq', - ], - 'seriesCode' => [ - 'title' => '系列编码', - 'description' => 'The primary edition of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* standard: Standard Edition'."\n" - .'* ultimate: Enterprise Platinum Edition'."\n" - .'* professional: Professional Edition'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'standard' => '', - 'ultimate' => '', - 'professional' => '', - ], - 'example' => 'standard', - ], - 'subSeriesCode' => [ - 'title' => '子系列编码', - 'description' => 'The sub-category edition of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* cluster_ha: Cluster High-availability Edition'."\n" - .'* single_node: Standalone Edition'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'cluster_ha' => '', - 'single_node' => '', - ], - 'example' => 'cluster_ha', - ], - 'paymentType' => [ - 'title' => '付费类型', - 'description' => 'The billing method of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PayAsYouGo'."\n" - .'* Subscription'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PayAsYouGo' => '', - 'Subscription' => '', - ], - 'example' => 'Subscription', - 'enum' => [ - 'Subscription', - 'PayAsYouGo', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => 'The instance description.'."\n", - 'type' => 'string', - 'example' => 'This is remark for instance.', - ], - 'topicCount' => [ - 'title' => '主题数量', - 'description' => 'The number of topics that are created on the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'groupCount' => [ - 'title' => '消费组数量', - 'description' => 'The number of consumer groups that are created on the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the version of the instance was updated.'."\n", - 'type' => 'string', - 'example' => '2022-08-01 00:00:00', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => 'The time when the instance was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-08-02 00:00:00', - ], - 'resourceGroupId' => [ - 'title' => '资源组ID', - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmx7caj******', - ], - 'tags' => [ - 'title' => '资源标签列表。', - 'description' => 'The resource tags.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '资源标签。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '资源标签key值。', - 'description' => 'The tag key of the resource.'."\n", - 'type' => 'string', - 'example' => 'key', - ], - 'value' => [ - 'title' => '资源标签value值。', - 'description' => 'The tag value of the resource.'."\n", - 'type' => 'string', - 'example' => 'value', - ], - ], - ], - ], - 'productInfo' => [ - 'description' => 'The product information.'."\n", - 'type' => 'object', - 'properties' => [ - 'traceOn' => [ - 'description' => 'Indicates whether the message trace feature is enabled. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'This parameter is not in use. By default, the message trace feature is enabled for ApsaraMQ for RocketMQ instances, regardless of whether this parameter is configured.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'capacityType' => [ - 'type' => 'string', - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => 'The error code returned if the call failed.'."\n", - 'type' => 'string', - 'example' => 'MissingPageNumber', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Parameter pageNumber is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => 'The dynamic error code.'."\n", - 'type' => 'string', - 'example' => 'PageNumber', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'pageNumber', - ], + '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'], ], ], ], ], - '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' => '> 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", - ], - 'GetInstance' => [ - 'summary' => 'Queries the detailed information about an instance.', - 'path' => '/instances/{instanceId}', - 'methods' => [ - 'get', + 'title' => 'CreateInstanceAcl', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstanceAcl'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '147017', - 'abilityTreeNodes' => [ - 'FEATUREonsHF2FLP', - ], - ], + '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' => [ - 'title' => '实例ID', - 'description' => 'The ID of the instance that you want to query.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', + '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<InstanceDTO>', - 'description' => 'The response parameters.'."\n", + 'title' => 'Result<Boolean>', + 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '05AB7FBD-F1D3-5D87-BF78-BD782249****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => 'The ID of the region in which the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => 'The ID of the instance'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'instanceName' => [ - 'title' => '实例名称', - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'test instance', - ], - 'status' => [ - 'title' => '实例状态', - 'description' => 'The status of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RELEASED'."\n" - .'* RUNNING'."\n" - .'* STOPPED'."\n" - .'* CHANGING'."\n" - .'* CREATING'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'RELEASED' => '', - 'RUNNING' => '', - 'STOPPED' => '', - 'CHANGING' => '', - 'CREATING' => '', - ], - 'example' => 'RUNNING', - 'enum' => [ - 'CREATING', - 'CHANGING', - 'RUNNING', - 'STOPPED', - 'RELEASED', - ], - ], - 'startTime' => [ - 'title' => '开服时间', - 'description' => 'The time when the instance was started.'."\n", - 'type' => 'string', - 'example' => '2022-08-01 00:00:00', - ], - 'expireTime' => [ - 'title' => '过期时间', - 'description' => 'The time when the instance expires.'."\n", - 'type' => 'string', - 'example' => '2022-09-01 00:00:00', - ], - 'releaseTime' => [ - 'title' => '释放时间', - 'description' => 'The time when the instance was released.'."\n", - 'type' => 'string', - 'example' => '2022-09-07 00:00:00', - ], - 'userId' => [ - 'title' => '所属人ID', - 'description' => 'The ID of the user who owns the instance.'."\n", - 'type' => 'string', - 'example' => '111111111111111', - ], - 'bid' => [ - 'title' => 'BID', - 'description' => 'The business ID (BID) of the commodity.'."\n", - 'type' => 'string', - 'example' => '26842', - ], - 'commodityCode' => [ - 'title' => '商品编码', - 'description' => 'The commodity code of the instance. The commodity code of a ApsaraMQ for RocketMQ 5.0 instance has a similar format as ons_rmqsub_public_cn.', - 'type' => 'string', - 'example' => 'ons_rmqsub_public_cn', - ], - 'serviceCode' => [ - 'title' => '服务编码', - 'description' => 'The code of the service to which the instance belongs. The service code of ApsaraMQ for RocketMQ is rmq.', - 'type' => 'string', - 'example' => 'rmq', - ], - 'seriesCode' => [ - 'title' => '系列编码', - 'description' => 'The primary edition of the instance. For information about the differences between primary edition instances, see [Instance selection](~~444722~~).'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* standard: Standard Edition'."\n" - .'* ultimate: Enterprise Platinum Edition'."\n" - .'* professional: Professional Edition'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'standard' => '', - 'ultimate' => '', - 'professional' => '', - ], - 'example' => 'standard', - ], - 'subSeriesCode' => [ - 'title' => '子系列编码', - 'description' => 'The sub-category edition of the instance. For information about the differences between sub-category edition instances, see [Instance selection](~~444722~~).'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* cluster_ha: Cluster High-availability Edition'."\n" - .'* single_node: Standalone Edition'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'cluster_ha' => '', - 'single_node' => '', - ], - 'example' => 'cluster_ha', - ], - 'paymentType' => [ - 'title' => '付费类型', - 'description' => 'The billing method of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PayAsYouGo'."\n" - .'* Subscription'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PayAsYouGo' => '', - 'Subscription' => '', - ], - 'example' => 'Subscription', - 'enum' => [ - 'Subscription', - 'PayAsYouGo', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => 'The description of the instance.'."\n", - 'type' => 'string', - 'example' => 'This is remark for instance.', - ], - 'networkInfo' => [ - 'title' => '网络信息', - 'description' => 'The network information.'."\n", - 'type' => 'object', - 'properties' => [ - 'vpcInfo' => [ - 'title' => '专有网络信息', - 'description' => 'The virtual private cloud (VPC) information.'."\n", - 'type' => 'object', - 'properties' => [ - 'vpcId' => [ - 'title' => '专有网络ID', - 'description' => 'The ID of the VPC with which the instance is associated.'."\n", - 'type' => 'string', - 'example' => 'vpc-uf6of9452b2pba82c****', - ], - 'vSwitchId' => [ - 'title' => '交换机ID', - 'description' => 'The ID of the vSwitch with which the instance is associated.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'example' => 'vsw-uf6gwtbn6etadpvz7****', - ], - 'vSwitches' => [ - 'title' => '交换机列表', - 'description' => 'The vSwitches.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'vSwitchId' => [ - 'title' => '交换机ID', - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-uf6gwtbn6etadpvz7****', - ], - 'zoneId' => [ - 'title' => '可用区ID', - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - 'description' => '', - ], - ], - 'securityGroupIds' => [ - 'description' => 'The security group ID.'."\n", - 'type' => 'string', - 'example' => 'sg-hp35r2hc3a3sv8q2sb16', - ], - ], - ], - 'endpoints' => [ - 'title' => '接入点列表', - 'description' => 'The endpoints.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The endpoint.'."\n", - 'type' => 'object', - 'properties' => [ - 'endpointType' => [ - 'title' => '接入点类型', - 'description' => 'The type of the endpoint that is used to access the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TCP_VPC: VPC endpoint'."\n" - .'* TCP_INTERNET: public endpoint'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'TCP_VPC' => '', - 'TCP_INTERNET' => '', - ], - 'example' => 'TCP_INTERNET', - 'enum' => [ - 'TCP_INTERNET', - 'TCP_VPC', - ], - ], - 'endpointUrl' => [ - 'title' => '接入点地址', - 'description' => 'The endpoint that is used to access the instance.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080', - ], - 'ipWhitelist' => [ - 'description' => 'The whitelist that includes the IP addresses that are allowed to access the ApsaraMQ for RocketMQ broker over the Internet. This parameter can be configured only if you use the public endpoint to access the instance.'."\n" - ."\n" - .'* If you do not configure an IP address whitelist, all CIDR blocks are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n" - .'* If you configure an IP address whitelist, only the IP addresses in the whitelist are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n" - ."\n" - .'We recommend that you configure internetInfo.ipWhitelist instead of this parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The whitelist that includes the IP addresses that are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n", - 'type' => 'string', - 'example' => '192.168.x.x/24', - ], - 'example' => '192.168.x.x/24', - 'title' => '', - ], - 'endpointId' => [ - 'title' => '关联的pvl ep实例', - 'type' => 'string', - 'example' => 'ep-bpxxx', - ], - ], - ], - ], - 'internetInfo' => [ - 'title' => '公网信息', - 'description' => 'The information about the Internet.'."\n", - 'type' => 'object', - 'properties' => [ - 'internetSpec' => [ - 'title' => '是否开通公网', - 'description' => 'Specifies whether to enable the Internet access feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* enable'."\n" - .'* disable'."\n" - ."\n" - .'By default, ApsaraMQ for RocketMQ instances are accessed in virtual private clouds (VPCs). If you enable the Internet access feature, you are charged for Internet outbound bandwidth. For more information, see [Internet access fee](~~427240~~).', - 'type' => 'string', - 'enumValueTitles' => [ - 'enable' => '', - 'disable' => '', - ], - 'example' => 'enable', - ], - 'flowOutType' => [ - 'title' => '公网计费类型', - 'description' => 'The metering method for Internet usage.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PayByBandwidth: pay-by-bandwidth. If the Internet access feature is enabled, specify this value for the parameter.'."\n" - .'* uninvolved: N/A. If the Internet access feature is not enabled, specify this value for the parameter.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'payByBandwidth' => '', - 'uninvolved' => '', - ], - 'example' => 'payByBandwidth', - ], - 'flowOutBandwidth' => [ - 'title' => '公网带宽规格', - 'description' => 'The Internet bandwidth. Unit: MB/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ipWhitelist' => [ - 'title' => '公网IP白名单列表', - 'description' => 'The whitelist that includes the IP addresses that are allowed to access the ApsaraMQ for RocketMQ broker.'."\n" - ."\n" - .'* If this parameter is not configured, all IP addresses are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n" - .'* If this parameter is configured, only the IP addresses that are included in the whitelist can access the ApsaraMQ for RocketMQ broker over the Internet.', - 'type' => 'array', - 'items' => [ - 'title' => '公网IP白名单', - 'description' => 'The whitelist that includes the IP addresses that are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.', - 'type' => 'string', - 'example' => '192.168.x.x/24', - ], - ], - ], - ], - ], - ], - 'accountInfo' => [ - 'title' => '账号信息', - 'description' => 'The account information.'."\n", - 'type' => 'object', - 'properties' => [ - 'username' => [ - 'title' => '用户名', - 'description' => 'The username of the instance. If you access a ApsaraMQ for RocketMQ instance over the Internet, you must configure the username and password of the instance in the SDK code for authentication.', - 'type' => 'string', - 'example' => '6W0xz2uPfiwp****', - ], - ], - ], - 'instanceQuotas' => [ - 'title' => '容量信息', - 'description' => 'The instance quotas.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'quotaName' => [ - 'title' => '配额名称', - 'description' => 'The quota name.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* TOPIC_COUNT: the number of topics that can be created on the instance'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'TOPIC_COUNT' => '', - ], - 'example' => 'TOPIC_COUNT', - ], - 'usedCount' => [ - 'title' => '已使用量', - 'description' => 'The number of used topics on the instance.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'freeCount' => [ - 'title' => '免费', - 'description' => 'The number of topics that are free of charge on the instance.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '20', - ], - 'totalCount' => [ - 'title' => '总配额', - 'description' => 'The total number of topics on the instance.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - ], - ], - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the instance was created.'."\n", - 'type' => 'string', - 'example' => '2022-08-01 00:00:00 ', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => 'The time when the instance was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-08-02 00:00:00 ', - ], - 'extConfig' => [ - 'title' => '扩展配置，不再推荐使用，建议使用产品信息、网络信息中的字段替换', - 'description' => 'The extended configurations. We recommend you configure productInfo, internetInfo, or aclInfo instead of this parameter.'."\n", - 'type' => 'object', - 'properties' => [ - 'aclType' => [ - 'title' => '鉴权类型', - 'description' => 'The authentication type of the instance.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* default: intelligent authentication'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'default' => '', - ], - 'example' => 'default', - 'enum' => [ - 'default', - 'aliyun_ram', - 'apache_acl', - ], - ], - 'sendReceiveRatio' => [ - 'title' => '消息收发比例', - 'description' => 'The ratio between sent messages and received messages in the instance.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'autoScaling' => [ - 'title' => '自适应弹性伸缩', - 'description' => 'Specifies whether to enable the elastic TPS feature for the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: enable'."\n" - .'* false: disable'."\n" - ."\n" - .'This parameter is valid only when the supportAutoScaling parameter is set to enable.'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'messageRetentionTime' => [ - 'title' => '消息保留时长', - 'description' => 'The retention period of messages. Unit: hours.'."\n" - ."\n" - .'For information about the valid values of this parameter, see the "Limits on resource quotas" section in [Usage limits](~~440347~~).'."\n" - ."\n" - .'The storage of messages in ApsaraMQ for RocketMQ is serverless and scalable. You are charged for message storage based on your actual usage. You can change the retention period of messages to adjust storage capacity. For more information, see [Storage fee](~~427238~~).', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '72', - ], - 'supportAutoScaling' => [ - 'title' => '是否支持自适应弹性伸缩', - 'description' => 'Specifies whether the elastic TPS feature is supported by the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: enable'."\n" - .'* false: disable'."\n" - ."\n" - .'After you enable the elastic TPS feature for a ApsaraMQ for RocketMQ instance, you can use a specific amount of TPS that exceeds the specification limit. You are charged for the elastic TPS feature. For more information, see [Computing fee](~~427237~~).'."\n" - ."\n" - .'> The elastic TPS feature is supported only by specific instance editions. For more information, see [Instance specifications](~~444715~~).', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'internetSpec' => [ - 'title' => '是否开通公网', - 'description' => 'Indicates whether Internet access is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* enable'."\n" - .'* disable'."\n" - ."\n" - .'By default, you can access ApsaraMQ for RocketMQ instances in virtual private clouds (VPCs). If you enable the Internet access feature, you are charged for Internet outbound bandwidth. For more information, see [Internet access fees](~~427240~~).'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'enable' => '', - 'disable' => '', - ], - 'example' => 'enable', - 'enum' => [ - 'enable', - 'disable', - ], - ], - 'flowOutType' => [ - 'title' => '公网计费类型', - 'description' => 'The metering method of Internet usage.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PayByTraffic: pay-by-traffic'."\n" - .'* paybybandwidth: pay-by-bandwidth'."\n" - .'* uninvolved: N/A'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'payByTraffic' => '', - 'payByBandwidth' => '', - 'uninvolved' => '', - ], - 'example' => 'payByBandwidth', - 'enum' => [ - 'uninvolved', - 'payByTraffic', - 'payByBandwidth', - ], - ], - 'flowOutBandwidth' => [ - 'title' => '公网带宽规格', - 'description' => 'The Internet bandwidth. Unit: MB/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'msgProcessSpec' => [ - 'title' => '消息收发计算规格', - 'description' => 'The computing specification that is used to send and receive messages. For information about the upper limit of TPS, see [Instance specifications](~~444715~~).'."\n", - 'type' => 'string', - 'example' => 'rmq.s2.2xlarge', - ], - ], - 'deprecated' => true, - ], - 'resourceGroupId' => [ - 'title' => '资源组ID', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfm3tmjruyribi', - ], - 'productInfo' => [ - 'title' => '产品信息', - 'description' => 'The extended configurations of the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'msgProcessSpec' => [ - 'title' => '消息收发规格', - 'description' => 'The computing specification that is used to send and receive messages. For information about the upper limit of TPS, see [Instance specifications](~~444715~~).'."\n", - 'type' => 'string', - 'example' => 'rmq.s2.2xlarge', - ], - 'sendReceiveRatio' => [ - 'title' => '消息收发比例', - 'description' => 'The ratio between sent messages and received messages in the instance.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'autoScaling' => [ - 'title' => '是否开启弹性伸缩', - 'description' => 'Specifies whether to enable the elastic TPS feature for the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: enable'."\n" - .'* false: disable'."\n" - ."\n" - .'This parameter is valid only when the supportAutoScaling parameter is set to enable.'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'messageRetentionTime' => [ - 'title' => '消息保留时长', - 'description' => 'The retention period of messages. Unit: hours.'."\n" - ."\n" - .'For information about the valid values of this parameter, see the "Limits on resource quotas" section in [Usage limits](~~440347~~).'."\n" - ."\n" - .'The storage of messages in ApsaraMQ for RocketMQ is serverless and scalable. You are charged for message storage based on your actual usage. You can change the retention period of messages to adjust storage capacity. For more information, see [Storage fee](~~427238~~).', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '72', - ], - 'supportAutoScaling' => [ - 'title' => '是否支持弹性伸缩', - 'description' => 'Specifies whether to enable the elastic TPS feature for the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: enable'."\n" - .'* false: disable'."\n" - ."\n" - .'After you enable the elastic TPS feature for a ApsaraMQ for RocketMQ instance, you can use a specific amount of TPS that exceeds the specification limit. You are charged for the elastic TPS feature. For more information, see [Computing fee](~~427237~~).'."\n" - ."\n" - .'> The elastic TPS feature is supported by only specific instance editions. For more information, see [Instance specifications](~~444715~~).', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'traceOn' => [ - 'description' => 'Indicates whether the message trace feature is enabled. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'This parameter is not in use. By default, the message trace feature is enabled for ApsaraMQ for RocketMQ instances, regardless of whether this parameter is configured.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'storageEncryption' => [ - 'title' => '是否开启存储加密', - 'description' => 'Indicates whether storage encryption is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'storageSecretKey' => [ - 'title' => '存储加密密钥Key', - 'description' => 'The storage encryption key.'."\n", - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'capacityType' => [ - 'type' => 'string', - ], - 'provisionedCapacity' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - ], - 'aclInfo' => [ - 'title' => '访问控制信息', - 'description' => 'The information about access control.'."\n", - 'type' => 'object', - 'properties' => [ - 'aclTypes' => [ - 'description' => 'The authentication types of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The authentication type of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- default: intelligent identity authentication'."\n" - ."\n" - .'- apache_acl:access control list (ACL) identity authentication', - 'type' => 'string', - 'enumValueTitles' => [ - 'default' => '', - 'apache_acl' => '', - ], - 'example' => 'default', - ], - ], - 'defaultVpcAuthFree' => [ - 'description' => 'Indicates whether the authentication-free in VPCs feature is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'aclType' => [ - 'description' => 'The authentication type of the instance. This parameter is no longer in use. We recommend that you configure aclTypes.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- default: intelligent identity authentication'."\n" - ."\n" - .'- apache_acl:access control list (ACL) identity authentication**', - 'type' => 'string', - 'deprecated' => true, - 'enumValueTitles' => [ - 'default' => 'default', - 'apache_acl' => '', - ], - 'example' => 'default', - 'title' => '', - ], - ], - ], - 'software' => [ - 'title' => '实例软件信息', - 'description' => 'The instance software information.', - 'type' => 'object', - 'properties' => [ - 'softwareVersion' => [ - 'title' => '软件版本', - 'description' => 'The version of software.', - 'type' => 'string', - 'example' => '5.0-rmq-20230619-1', - ], - 'maintainTime' => [ - 'title' => '升级时间段', - 'description' => 'The period of upgrade time.', - 'type' => 'string', - 'example' => '02:00-06:00', - ], - 'upgradeMethod' => [ - 'title' => '升级方式，auto自动升级，manual手动升级', - 'description' => 'The upgrade method.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- Auto: automatic upgrade'."\n" - ."\n" - .'- Manual: manual upgrade', - 'type' => 'string', - 'enumValueTitles' => [ - 'auto' => '', - 'maunal' => '', - ], - 'example' => 'auto', - ], - ], - ], - 'topicCount' => [ - 'title' => '主题数量', - 'description' => 'The number of topics.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'groupCount' => [ - 'title' => '消费组数量', - 'description' => 'The number of groups.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'tags' => [ - 'title' => '资源标签列表。', - 'description' => 'The resource tags.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '资源标签。', - 'description' => 'The resource tags.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '资源标签key值。', - 'description' => 'The tag key of the resource.'."\n", - 'type' => 'string', - 'example' => 'key', - ], - 'value' => [ - 'title' => '资源标签value值。', - 'description' => 'The tag value of the resource.'."\n", - 'type' => 'string', - 'example' => 'value', - ], - ], - ], - ], - ], - ], - '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' => 'HTTP状态码', - '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', - ], + '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}'], ], ], ], ], - '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 },\\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 },\\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' => 'GetInstance', - '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", ], 'CreateTopic' => [ - 'summary' => 'Create Topic', + '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', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2424,102 +1345,59 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREonsHZ457W', - ], + 'abilityTreeNodes' => ['FEATUREonsHZ457W'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the instance to which the topic to be created belongs.', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + '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' => [ - 'title' => '主题名称', - 'description' => 'The name of the topic to be created, used for identifying the topic, and it must be globally unique.'."\n" - ."\n" - .'Value specifications are as follows:'."\n" - ."\n" - .'- Character restrictions: Supports letters a\\~z or A\\~Z, numbers 0~9, and underscores (_), hyphens (-).'."\n" - .'- Length restrictions: 1 to 60 characters.'."\n" - ."\n" - .'For reserved character restrictions, please refer to [Parameter Restrictions](~~440347~~).', - 'type' => 'string', - 'required' => true, - 'example' => 'topic_test', - ], + '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.'."\n", + 'title' => '', + 'description' => 'The information about the topic.', 'type' => 'object', 'properties' => [ 'messageType' => [ - 'title' => '消息类型', - 'description' => 'The type of messages in the topic that you want to create.'."\n" + 'description' => 'The message type of the topic to create.'."\n" ."\n" - .'Valid values:'."\n" + .'><notice>'."\n" ."\n" - .'* TRANSACTION: transactional messages'."\n" - .'* FIFO: ordered messages'."\n" - .'* DELAY: scheduled or delayed messages'."\n" - .'* NORMAL: normal messages'."\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" - .'> The type of messages in the topic must be the same as the type of messages that you want to send. For example, if you create a topic whose message type is ordered messages, you can use the topic to send and receive only ordered messages.'."\n", + .'></notice>', + 'enumValueTitles' => ['TRANSACTION' => 'Transactional message', 'FIFO' => 'Ordered message', 'DELAY' => 'Scheduled and delayed message', 'NORMAL' => 'Normal message'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'TRANSACTION' => '', - 'FIFO' => '', - 'DELAY' => '', - 'NORMAL' => '', - ], + 'enum' => ['NORMAL', 'FIFO', 'DELAY', 'TRANSACTION', 'LITE'], + 'title' => '', 'example' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'FIFO', - 'DELAY', - 'TRANSACTION', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => 'The description of the topic that you want to create.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is the remark for test.', - ], - 'maxSendTps' => [ - 'description' => 'The maximum TPS for message sending.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1500', - ], - 'liteTopicExpiration' => [ - 'title' => 'liteTopic过期时间，单位：分钟'."\n" - .'取值范围：15-720。'."\n" - .'默认-1，表示永久存在', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - 'default' => '-1', ], + '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' => '', ], ], ], @@ -2530,73 +1408,45 @@ 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'Request ID, each request\'s ID is unique and can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the execution was successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => 'Return result.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => 'Error code.', - 'type' => 'string', - 'example' => 'Topic.Existed', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'The topic already exists.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => 'Dynamic error code.', - 'type' => 'string', - 'example' => 'TopicName', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => 'Dynamic error message.', - 'type' => 'string', - 'example' => 'topicName', - ], + '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', - 'translator' => 'machine', - ], - 'UpdateTopic' => [ - 'summary' => 'Update Topic', - 'path' => '/instances/{instanceId}/topics/{topicName}', - 'methods' => [ - 'patch', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTopic'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -2604,766 +1454,503 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '144678', - 'abilityTreeNodes' => [ - 'FEATUREonsCON1A8', - ], - ], + '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' => '实例ID', - 'description' => 'The ID of the instance to which the topic to be updated belongs.', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', + 'title' => 'Result<Boolean>', + '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' => [ [ - 'name' => 'topicName', + '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' => [ - 'title' => '主题名称', - 'description' => 'The name of the topic to be updated.', + '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, - 'example' => 'topic_test', + 'enumValueTitles' => ['TAG' => 'TAG过滤', 'SQL' => 'SQL过滤'], + 'example' => 'TAG', + 'title' => '', ], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '', - 'description' => 'Request body structure.', - 'type' => 'object', - 'properties' => [ - 'remark' => [ - 'title' => '备注', - 'description' => 'Updated remarks for the topic.', - 'type' => 'string', - 'required' => false, - 'example' => 'This is the remark for test.', - ], - 'maxSendTps' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'description' => 'Maximum send message tps', - 'example' => '500', - ], - 'liteTopicExpiration' => [ - 'title' => 'liteTopic过期时间，单位：分钟'."\n" - .'取值范围：15-720。'."\n" - .'默认-1，表示永久存在', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - ], - 'required' => false, - ], + 'name' => 'filterExpression', + 'in' => 'query', + 'schema' => ['description' => 'The filter expression.'."\n", 'type' => 'string', 'required' => true, 'example' => '*', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'Request ID, each request has a unique ID that can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Whether the execution result is successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => 'Return result.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => 'Error code.', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'The topic cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => 'Dynamic error code', - 'type' => 'string', - 'example' => 'TopicName', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'topicName', - ], + '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\\": \\"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', + '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', - ], - 'DeleteTopic' => [ - 'summary' => 'Deletes a specified topic.', - 'path' => '/instances/{instanceId}/topics/{topicName}', - 'methods' => [ - 'delete', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConsumerGroupSubscription'], + ], ], - 'schemes' => [ - 'https', - 'http', + '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' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'planId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the instance to which the topic belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => 'Backup plan ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016', 'title' => ''], ], [ - 'name' => 'topicName', + 'name' => 'itemId', 'in' => 'path', - 'schema' => [ - 'title' => '主题名称', - 'description' => 'The name of the topic.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'topic_test', - ], + 'schema' => ['description' => 'Backup mapping task ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100000650', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result<Boolean>', - 'description' => 'The response object.'."\n", + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => 'HTTP状态码', - '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', - ], + '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\\": \\"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', - '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", - ], - 'ListTopics' => [ - 'summary' => 'Query Topic List', - 'path' => '/instances/{instanceId}/topics', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '144680', - 'abilityTreeNodes' => [ - 'FEATUREonsXSOU1Y', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'instanceId', + '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' => '实例ID', - 'description' => 'Specifies which instance\'s topic list to retrieve.', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', + 'title' => 'Result<Boolean>', + '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' => [ [ - 'name' => 'filter', - 'in' => 'query', - 'schema' => [ - 'title' => '过滤条件', - 'description' => 'The filter condition for the query. If not provided, all topics under the instance will be queried.', - 'type' => 'string', - 'required' => false, - 'example' => 'topic_test', + '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' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页页码', - 'description' => 'Page number, indicating which page of results to return.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'pageSize', - 'in' => 'query', + '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' => '分页大小', - 'description' => 'Page size, the maximum number of results to display per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '10', - 'example' => '3', + 'title' => 'Result<Boolean>', + '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'], + ], ], ], - [ - 'name' => 'messageTypes', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'The message type of the topic.', - 'type' => 'array', - 'items' => [ - 'description' => 'The type of topic to query under the instance. If not provided, all topics under the instance will be queried.'."\n" - .'Parameter values are as follows:'."\n" - .'- TRANSACTION: Transactional messages'."\n" - .'- FIFO: Ordered messages'."\n" - .'- DELAY: Timed/Delayed messages'."\n" - .'- NORMAL: Normal messages', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TRANSACTION' => 'TRANSACTION', - 'FIFO' => 'FIFO', - 'DELAY' => 'DELAY', - 'NORMAL' => 'NORMAL', - ], - 'example' => 'NORMAL', + ], + '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}'], ], - 'required' => false, - 'enumValueTitles' => [], ], ], ], + ], + '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<MyPage<TopicDTO>>', - 'description' => 'The response parameters.'."\n", + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'Request ID, each request has a unique ID that can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the execution was successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => 'The returned data.'."\n", - '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' => '3', - ], - 'totalCount' => [ - 'title' => '总记录数', - 'description' => 'Total number of results returned.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'list' => [ - 'title' => '分页数据', - 'description' => 'The topics.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => 'The region ID to which the instance belongs.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'title' => 'Topic编码', - 'description' => 'Topic name.', - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageType' => [ - 'title' => '消息类型,MessageTypeEnum[UNSPECIFIED,NORMAL(普通),FIFO(顺序),DELAY(延迟),TRANSACTION(事务),UNRECOGNIZED(无法识别),code,desc]', - 'description' => 'The type of messages in the topic.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TRANSACTION: transactional messages'."\n" - .'* FIFO: ordered messages'."\n" - .'* DELAY: scheduled or delayed messages'."\n" - .'* NORMAL: normal messages'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'TRANSACTION' => 'TRANSACTION', - 'FIFO' => 'FIFO', - 'DELAY' => 'DELAY', - 'NORMAL' => 'NORMAL', - ], - 'example' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'FIFO', - 'DELAY', - 'TRANSACTION', - ], - ], - 'status' => [ - 'title' => 'Topic状态,TopicStatusEnum[CREATING(创建中),RUNNING(运行中),code,desc]', - 'description' => 'The topic status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RUNNING'."\n" - .'* CREATING'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'RUNNING' => 'RUNNING', - 'CREATING' => 'CREATING', - ], - 'example' => 'RUNNING', - 'enum' => [ - 'CREATING', - 'RUNNING', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => 'Remark information of the topic.', - 'type' => 'string', - 'example' => 'This is the remark for test.', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'Creation time.', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => 'Last update time of the topic.', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'maxSendTps' => [ - 'description' => 'The maximum TPS for message sending.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'liteTopicExpiration' => [ - 'title' => 'liteTopic过期时间，单位：分钟', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => 'Error code.', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'The topic cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => 'Dynamic error code.', - 'type' => 'string', - 'example' => 'TopicName', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => 'Dynamic error message.', - 'type' => 'string', - 'example' => 'topicName', - ], + '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\\": \\"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', + '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', - ], - 'GetTopic' => [ - 'summary' => 'Query Topic Details', - 'path' => '/instances/{instanceId}/topics/{topicName}', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstanceAccount'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '144800', - 'abilityTreeNodes' => [ - 'FEATUREons8BETJT', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the instance to which the topic to be queried belongs.', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ - 'name' => 'topicName', + 'name' => 'username', 'in' => 'path', + 'schema' => ['description' => 'The username of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', 'schema' => [ - 'title' => '主题名称', - 'description' => 'The name of the topic to be queried.', + '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, - 'example' => 'topic_test', + '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<TopicDTO>', - 'description' => 'The response parameters.'."\n", + 'title' => 'Result<Boolean>', + 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'Request ID, each request\'s ID is unique and can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the execution was successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => 'The region ID to which the instance belongs.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => 'The ID of the instance to which the topic belongs.', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'title' => 'Topic编码', - 'description' => 'Topic name.', - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageType' => [ - 'title' => '消息类型,MessageTypeEnum[UNSPECIFIED,NORMAL(普通),FIFO(顺序),DELAY(延迟),TRANSACTION(事务),UNRECOGNIZED(无法识别),code,desc]', - 'description' => 'The type of messages in the topic.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TRANSACTION: transactional messages'."\n" - .'* FIFO: ordered messages'."\n" - .'* DELAY: scheduled or delayed messages'."\n" - .'* NORMAL: normal messages'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TRANSACTION: transactional messages'."\n" - .'* FIFO: ordered messages'."\n" - .'* DELAY: scheduled or delayed messages'."\n" - .'* NORMAL: normal messages'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'TRANSACTION' => 'TRANSACTION', - 'FIFO' => 'FIFO', - 'DELAY' => 'DELAY', - 'NORMAL' => 'NORMAL', - ], - 'example' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'FIFO', - 'DELAY', - 'TRANSACTION', - ], - ], - 'status' => [ - 'title' => '主题状态', - 'description' => 'The topic status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RUNNING'."\n" - .'* CREATING'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'RUNNING' => 'RUNNING', - 'CREATING' => 'CREATING', - ], - 'example' => 'RUNNING', - 'enum' => [ - 'CREATING', - 'RUNNING', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => 'Remark information of the topic.', - 'type' => 'string', - 'example' => 'This is the remark for test.'."\n", - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'Creation time of the topic.', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => 'Last modification time of the topic.', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'maxSendTps' => [ - 'description' => 'The maximum TPS for message sending.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000'."\n" - ."\n", - ], - 'liteTopicExpiration' => [ - 'title' => 'liteTopic过期时间，单位：分钟', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => 'Error code.', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'The topic cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => 'Dynamic error code.', - 'type' => 'string', - 'example' => 'TopicName', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => 'Dynamic error message.', - 'type' => 'string', - 'example' => 'topicName', - ], + '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\\": \\"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', + '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', - ], - 'CreateConsumerGroup' => [ - 'summary' => 'Creates a consumer group.', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -3372,233 +1959,140 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREonsTT47IL', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '209878', + 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - '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', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ - 'name' => 'consumerGroupId', - 'in' => 'path', + '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' => [ - 'title' => '消费组ID', - 'description' => 'The result data that is returned.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'GID_test_groupId', + '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' => '', ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The request body.'."\n", + 'title' => 'Result<Boolean>', + 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ - 'remark' => [ - 'title' => '备注', - 'description' => 'The description of the consumer group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is the remark for test.', - ], - 'deliveryOrderType' => [ - 'title' => '投递顺序性', - 'description' => 'The message delivery method of the consumer group.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Concurrently: concurrent delivery'."\n" - .'* Orderly: ordered delivery'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Concurrently' => '', - 'Orderly' => '', - ], - 'example' => 'Concurrently', - 'enum' => [ - 'Orderly', - 'Concurrently', - ], - ], - 'consumeRetryPolicy' => [ - 'title' => '消费重试策略', - 'description' => 'The consumption retry policy of the consumer group. For more information, see [Consumption retry](~~440356~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'maxRetryTimes' => [ - 'title' => '最大重试次数', - 'description' => 'The maximum number of retries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '16', - ], - 'retryPolicy' => [ - 'title' => '重试策略类型', - 'description' => 'The retry policy. For more information, see [Message retry](~~440356~~).'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* FixedRetryPolicy: fixed-interval retry. This value is valid only if you set deliveryOrderType to Orderly.'."\n" - .'* DefaultRetryPolicy: exponential backoff retry. This value is valid only if you set deliveryOrderType to Concurrently.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'FixedRetryPolicy' => '', - 'DefaultRetryPolicy' => '', - ], - 'example' => 'DefaultRetryPolicy', - 'enum' => [ - 'DefaultRetryPolicy', - 'FixedRetryPolicy', - ], - ], - 'deadLetterTargetTopic' => [ - 'description' => 'The dead-letter topic.'."\n" - ."\n" - .'If a message still fails to be consumed after the maximum number of retries specified in the consumption retry policy is reached, the message is delivered to the dead-letter topic for subsequent business recovery or backtracking. For more information, see [Consumption retry and dead-letter messages](~~440356~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DLQ_mqtest', - ], - 'fixedIntervalRetryTime' => [ - 'description' => 'The fixed interval. Unit: seconds. This parameter takes effect only if you set retryPolicy to FixedRetryPolicy. Valid values:'."\n" - ."\n" - .'* Concurrent delivery: 10 to 1800'."\n" - .'* Ordered delivery: 1 to 600', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => true, - ], - 'maxReceiveTps' => [ - 'description' => 'The maximum number of messages that can be processed by consumers per second.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300', - ], - 'messageModel' => [ - 'title' => '消费模式', - 'type' => 'string', - 'example' => 'CLUSTERING', - 'default' => 'CLUSTERING', - 'enum' => [ - 'CLUSTERING', - 'LITE_SELECTIVE', - ], - ], - 'topicName' => [ - 'title' => 'lite类型的topicName', - 'type' => 'string', - 'example' => 'test1', - ], + '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}'], ], - 'required' => false, ], ], ], + ], + '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<Boolean>', - 'description' => 'Result<Boolean>', + 'description' => 'The response object.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\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' => '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' => 'HTTP状态码', - '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', - ], + '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\\": \\"InvalidConsumerGroupId\\",\\n \\"message\\": \\"Parameter consumerGroupId is invalid.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"ConsumerGroupId\\",\\n \\"dynamicMessage\\": \\"consumerGroupId\\"\\n}","type":"json"}]', - 'title' => 'CreateConsumerGroup', - 'description' => 'The ID of the consumer group. The ID is globally unique and is used to identify a consumer group.'."\n" - ."\n" - .'The following limits are imposed on the ID:'."\n" - ."\n" - .'* Character limit: The ID can contain letters, digits, underscores (\\_), hyphens (-), and percent signs (%).'."\n" - .'* Length limit: The ID must be 1 to 60 characters in length.'."\n" - ."\n" - .'For more information about strings that are reserved for the system, see [Limits on parameters](~~440347~~).'."\n", - ], - 'UpdateConsumerGroup' => [ - 'summary' => 'Update ConsumerGroup', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', - 'methods' => [ - 'patch', - ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -3606,214 +2100,186 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '144683', - 'abilityTreeNodes' => [ - 'FEATUREonsTBTXFL', - ], - ], + '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' => [ - 'title' => '实例ID', - 'description' => 'The ID of the instance to which the consumer group to be updated belongs.', + 'description' => 'The migration stage type.', + 'enumValueTitles' => ['MIGRATE_MESSAGE' => 'message migration'], 'type' => 'string', 'required' => true, - 'example' => 'rmq-cn-7e22on9****', + 'example' => 'MIGRATE_MESSAGE', + 'title' => '', ], ], [ - 'name' => 'consumerGroupId', + 'name' => 'operationId', 'in' => 'path', - 'schema' => [ - 'title' => '消费组ID', - 'description' => 'The ID of the consumer group to be updated.', - 'type' => 'string', - 'required' => true, - 'example' => 'CID-TEST', - ], + 'schema' => ['description' => 'The migration operation ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2729', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'remark' => [ - 'title' => '备注', - 'description' => 'The new description of the consumer group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is the remark for test.', - ], - 'deliveryOrderType' => [ - 'title' => '投递顺序性', - 'description' => 'The new message delivery method of the consumer group.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Concurrently: concurrent delivery'."\n" - .'* Orderly: ordered delivery'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Concurrently' => 'Concurrently', - 'Orderly' => 'Orderly', - ], - 'example' => 'Concurrently', - 'enum' => [ - 'Concurrently', - 'Orderly', - ], - 'deprecated' => true, - ], - 'consumeRetryPolicy' => [ - 'title' => '消费重试策略', - 'description' => 'The new consumption retry policy of the consumer group. For more information, see [Consumption retry](~~440356~~).'."\n", + 'operationParam' => [ + 'title' => '', + 'description' => 'The operation parameters.', 'type' => 'object', 'properties' => [ - 'retryPolicy' => [ - 'title' => '重试策略类型', - 'description' => 'The retry policy. For more information, see [Message retry](~~440356~~).'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* FixedRetryPolicy: fixed-interval retry. This value is valid only if you set deliveryOrderType to Orderly.'."\n" - .'* DefaultRetryPolicy: exponential backoff retry. This value is valid only if you set deliveryOrderType to Concurrently.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'FixedRetryPolicy' => 'FixedRetryPolicy', - 'DefaultRetryPolicy' => 'DefaultRetryPolicy', - ], - 'example' => 'DefaultRetryPolicy', - 'enum' => [ - 'DefaultRetryPolicy', - 'FixedRetryPolicy', - ], - ], - 'maxRetryTimes' => [ - 'title' => '最大重试次数', - 'description' => 'The maximum number of retries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '16', - ], - 'deadLetterTargetTopic' => [ - 'description' => 'The dead-letter topic.'."\n" - ."\n" - .'If a message still fails to be consumed after the maximum number of retries specified in the consumption retry policy is reached, the message is delivered to the dead-letter topic for subsequent business recovery or backtracking. For more information, see [Consumption retry and dead-letter messages](~~440356~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DLQ_mqtest', - ], - 'fixedIntervalRetryTime' => [ - 'description' => 'Fixed retry interval, unit: seconds.This option is effective when retryPolicy is FixedRetryPolicy.Value range：'."\n" - .' - Concurrently:10-1800'."\n" - .' - Orderly:1-600', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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' => true, - ], - 'maxReceiveTps' => [ - 'description' => 'The maximum number of messages that can be processed by consumers per second.'."\n", - 'type' => 'integer', - 'format' => 'int64', 'required' => false, - 'example' => '100', + 'example' => '', ], ], 'required' => false, + 'description' => 'The request body.', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<MigrationOperationDTO>', + 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID, which is unique for each request and can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => 'C7F94090-3358-506A-97DC-34BC803C****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the execution was successful.', - 'type' => 'boolean', - 'example' => 'true', - ], + '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 result returned.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => 'Error code.', - 'type' => 'string', - 'example' => 'InvalidDeliveryOrderType', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'Parameter deliveryOrderType is invalid.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => 'Dynamic error code.', - 'type' => 'string', - 'example' => 'xxx', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => 'Dynamic error message.', - 'type' => 'string', - 'example' => 'xxx', + '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}'], ], ], ], ], - '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' => '><notice>The OpenAPI provided by Alibaba Cloud is a management API used for managing and querying related resources of Alibaba Cloud services. It is recommended to integrate it only in the management chain. It is strictly prohibited to rely on OpenAPI implementation in the core data chain of message sending and receiving, otherwise it may lead to risks in the chain.></notice>', 'translator' => 'machine', ], - 'DeleteConsumerGroup' => [ - 'summary' => 'Deletes a specified consumer group.', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - 'http', - ], + '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' => [], @@ -3821,30 +2287,28 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'migrationId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the instance from which you want to delete the consumer group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => 'The migration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'consumerGroupId', + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-pe334f1nx04', 'title' => ''], + ], + [ + 'name' => 'stageType', 'in' => 'path', 'schema' => [ - 'title' => '消费组ID', - 'description' => 'The ID of the consumer group.'."\n", + 'description' => 'The type of the migration stage. The value MIGRATE\\_MESSAGE indicates message migration.', + 'enumValueTitles' => ['MIGRATE_MESSAGE' => 'Message migration.'], 'type' => 'string', 'required' => true, - 'example' => 'CID-TEST', + 'example' => 'MIGRATE_MESSAGE', + 'title' => '', ], ], ], @@ -3852,78 +2316,46 @@ 200 => [ 'schema' => [ 'title' => 'Result<Boolean>', - 'description' => 'The response object.'."\n", + 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => 'HTTP状态码', - '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', - ], + '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\\": \\"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', - '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", - ], - 'ListConsumerGroups' => [ - 'summary' => 'List Consumer Groups', - 'path' => '/instances/{instanceId}/consumerGroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -3932,242 +2364,88 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '144685', - 'abilityTreeNodes' => [ - 'FEATUREonsYVMMCL', - ], + 'abilityTreeNodes' => ['FEATUREons0MOUAZ'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'Specifies which instance\'s consumer group list to retrieve.', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], - ], - [ - 'name' => 'filter', - 'in' => 'query', - 'schema' => [ - 'title' => '过滤条件', - 'description' => 'The filter condition for the query. If not provided, all consumer groups under the specified instance will be queried.', - 'type' => 'string', - 'required' => false, - 'example' => 'CID-TEST', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页页码', - 'description' => 'Page number, indicating which page of results to return.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'CID-TEST', 'title' => ''], ], [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => 'Page size, the maximum number of results to display per page.'."\n" - ."\n" - .'Value range: [10, 100].', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - ], + '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' => 'Result<MyPage<ConsumerGroupDTO>>', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'Request ID, each request has a unique ID that can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => '5503A460-98ED-5543-92CF-4853DE28****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the execution was successful.', - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => [ - 'title' => '返回结果', - 'description' => 'The returned data.'."\n", + 'description' => 'The data returned.', '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 number of returned results.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'list' => [ - 'title' => '分页数据', - 'description' => 'The consumer groups.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => 'The region ID to which the instance belongs.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'consumerGroupId' => [ - 'title' => '消费组ID', - 'description' => 'Consumer group ID.', - 'type' => 'string', - 'example' => 'GID-TEST', - ], - 'status' => [ - 'title' => '消费组状态', - 'description' => 'Status of the consumer group.', - 'type' => 'string', - 'enumValueTitles' => [ - 'RUNNING' => 'RUNNING', - 'CREATING' => 'CREATING', - ], - 'example' => 'RUNNING', - 'enum' => [ - 'CREATING', - 'RUNNING', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => 'Remark information of the consumer group.', - 'type' => 'string', - 'example' => 'This is the remark for test.', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'Creation time of the consumer group.', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => 'Last update time of the consumer group.', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'maxReceiveTps' => [ - 'description' => 'The maximum TPS for message sending.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'messageModel' => [ - 'title' => '消费模式', - 'type' => 'string', - 'example' => 'LITE_SELECTIVE', - ], - 'topicName' => [ - 'title' => 'lite类型的topicName', - 'type' => 'string', - 'example' => 'test1', - ], - ], - 'description' => '', - ], - ], + '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' => [ - 'title' => '错误码', - 'description' => 'Error code.', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'Parameter InstanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => 'Dynamic error code.', - 'type' => 'string', - 'example' => 'xxx', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], + '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' => '', ], ], ], - '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' => '><notice>The OpenAPI provided by Alibaba Cloud is a management API used for managing and querying related resources of Alibaba Cloud services. It is recommended to integrate it only in the management chain. Do not rely on OpenAPI implementation in the core data chain for message sending and receiving, as this may lead to risks in the chain.></notice>', - 'translator' => 'machine', + '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' => 'Queries the details of a specified consumer group.', + 'summary' => 'Retrieves the details of a specified consumer group.', 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4180,403 +2458,135 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '144684', - 'abilityTreeNodes' => [ - 'FEATUREonsJCXOZ6', - ], + 'abilityTreeNodes' => ['FEATUREonsJCXOZ6'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the instance to which the consumer group belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + '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' => [ - 'title' => '消费者组ID', - 'description' => 'The ID of the consumer group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CID-TEST', - ], + 'schema' => ['description' => 'The ID of the consumer group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'CID-TEST'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result<ConsumerGroupDTO>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], + '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.'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => 'The ID of the region in which the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'consumerGroupId' => [ - 'title' => '消费组ID', - 'description' => 'The ID of the consumer group.'."\n", - 'type' => 'string', - 'example' => 'CID-TEST', - ], + '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' => [ - 'title' => '消费组状态', - 'description' => 'The status of the consumer group.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RUNNING'."\n" - .'* CREATING'."\n", + 'description' => 'The state of the consumer group.', + 'enumValueTitles' => ['RUNNING' => 'The consumer group is running.', 'CREATING' => 'The consumer group is being created.'], 'type' => 'string', - 'enumValueTitles' => [ - 'RUNNING' => '', - 'CREATING' => '', - ], + 'enum' => ['CREATING', 'RUNNING'], + 'title' => '', 'example' => 'RUNNING', - 'enum' => [ - 'CREATING', - 'RUNNING', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => 'The remarks on the consumer group.'."\n", - 'type' => 'string', - 'example' => 'This is the remark for test.', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the consumer group was created.'."\n", - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => 'The time when the consumer group was last updated.'."\n", - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', ], + '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' => [ - 'title' => '投递顺序性', - 'description' => 'The message delivery method of the consumer group.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Concurrently: concurrent delivery'."\n" - .'* Orderly: ordered delivery'."\n", + 'description' => 'The message delivery order for the consumer group.', + 'enumValueTitles' => ['Concurrently' => 'Concurrent delivery', 'Orderly' => 'Orderly delivery'], 'type' => 'string', - 'enumValueTitles' => [ - 'Concurrently' => '', - 'Orderly' => '', - ], + 'enum' => ['Orderly', 'Concurrently'], + 'title' => '', 'example' => 'Concurrently', - 'enum' => [ - 'Orderly', - 'Concurrently', - ], ], 'consumeRetryPolicy' => [ - 'title' => '消费重试策略', - 'description' => 'The consumption retry policy of the consumer group. For more information, see [Consumption retry](~~440356~~).'."\n", + 'title' => '', + 'description' => 'The consumption retry policy. For more information, see'."\n" + .'[Consumption retry](~~440356~~).', 'type' => 'object', 'properties' => [ 'retryPolicy' => [ - 'title' => '重试策略类型', - 'description' => 'The retry policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* FixedRetryPolicy: fixed-interval retry'."\n" - .'* DefaultRetryPolicy: exponential backoff retry'."\n", + 'description' => 'The retry policy.', + 'enumValueTitles' => ['FixedRetryPolicy' => 'fixed-interval retry', 'DefaultRetryPolicy' => 'backoff retry'], 'type' => 'string', - 'enumValueTitles' => [ - 'FixedRetryPolicy' => '', - 'DefaultRetryPolicy' => '', - ], + 'enum' => ['DefaultRetryPolicy', 'FixedRetryPolicy'], + 'title' => '', 'example' => 'DefaultRetryPolicy', - 'enum' => [ - 'DefaultRetryPolicy', - 'FixedRetryPolicy', - ], - ], - 'maxRetryTimes' => [ - 'title' => '最大重试次数', - 'description' => 'The maximum number of retries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'deadLetterTargetTopic' => [ - 'description' => 'The dead-letter topic.'."\n" - ."\n" - .'If a consumer still fails to consume a message after the message is retried for a specified number of times, the message is delivered to a dead-letter topic for subsequent business recovery or troubleshooting. For more information, see [Consumption retry and dead-letter messages](~~440356~~).'."\n", - 'type' => 'string', - 'example' => 'DLQ_mqtest', - ], - 'fixedIntervalRetryTime' => [ - 'description' => 'Fixed interval retry time,Value range, unit: seconds'."\n" - .' - Concurrently:10-1800'."\n" - .' - Orderly:1-600', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', ], + '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' => 'Maximum received message tps', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'messageModel' => [ - 'title' => '消费模式：'."\n" - .' CLUSTERING：集群消费'."\n" - .' LITE_SELECTIVE：LITE_SELECTIVE', - 'type' => 'string', - 'example' => 'LITE_SELECTIVE', - ], - 'topicName' => [ - 'title' => 'lite类型的topicName', - 'type' => 'string', - 'example' => 'test1', - ], + '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' => [ - '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' => 'HTTP状态码', - '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', - ], + '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 },\\n \\"code\\": \\"InvalidConsumerGroupId\\",\\n \\"message\\": \\"Parameter consumerGroupId is invalid.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"ConsumerGroupId\\",\\n \\"dynamicMessage\\": \\"consumerGroupId\\"\\n}","type":"json"}]', + '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' => '> 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", - ], - 'ListTopicSubscriptions' => [ - 'summary' => 'Queries the subscriptions of a specific topic.', - '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', - ], - ], - [ - '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', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<List<SubscriptionDTO>>', - 'description' => 'Result\\<List>'."\n", - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', - 'description' => 'The consumption mode. Valid values: BROADCASTING and CLUSTERING.'."\n", - 'type' => 'string', - 'example' => 'BROADCASTING', - ], - 'subscriptionStatus' => [ - 'title' => '订阅状态,SubscriptionStatusEnum[ONLINE(在线),OFFLINE(离线),code,desc]', - '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' => '过滤表达式类型,SubscriptionExpressionTypeEnum[SQL(SQL过滤),TAG(TAG过滤),UNSPECIFIED(FILTER_TYPE_UNSPECIFIED 过滤类型未指定),code,desc]', - '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', - ], - ], - ], - ], - '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' => 'HTTP状态码', - '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', - ], + 'description' => '><notice>'."\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" + .'></notice>', + '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}'], ], ], ], ], - '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', ], - 'ListConsumerGroupSubscriptions' => [ - 'summary' => 'Queries the subscriptions of a specific consumer group.', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetConsumerGroupLag' => [ + 'summary' => 'Queries the message accumulation of a consumer group.', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/lag', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4585,185 +2595,137 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '145821', - 'abilityTreeNodes' => [ - 'FEATUREons0MOUAZ', - ], + 'abilityTreeCode' => '145824', + 'abilityTreeNodes' => ['FEATUREonsJCXOZ6'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the ApsaraMQ for RocketMQ instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-tl32wwz1r05', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-2r42vrvde0j', 'title' => ''], ], [ 'name' => 'consumerGroupId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the consumer group whose subscriptions you want to query.'."\n" - ."\n" - .'If you do not configure this parameter, the subscriptions of all consumer groups on the specified instance are queried.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PRINT_RETRY_CONSUMER', - ], + 'schema' => ['description' => 'The consumer group ID.', 'type' => 'string', 'required' => true, 'example' => 'CID-TEST', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'query', - 'schema' => [ - 'title' => '主题名称', - 'description' => 'The topic name. If you do not specify this parameter, all subscriptions of the consumer group are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'topic_test', - ], + '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<List<SubscriptionDTO>>', - 'description' => 'Result\\<List>'."\n", + 'title' => 'Result<ConsumerGroupLagDTO>', + 'description' => 'Result\\<ConsumerGroupLagDto>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5F4D9D5F-625B-59FF-BD4F-DA8284575DB4', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The subscriptions of the consumer group.'."\n", - 'type' => 'object', - 'properties' => [ - 'consumerGroupId' => [ - 'title' => '消费者组', - 'description' => 'The ID of the consumer group.'."\n", - 'type' => 'string', - 'example' => 'CID-TEST', - ], - 'topicName' => [ - 'title' => '订阅主题', - 'description' => 'The topic to which the consumer group subscribes.'."\n", - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageModel' => [ - 'title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', - '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' => '订阅状态,SubscriptionStatusEnum[ONLINE(在线),OFFLINE(离线),code,desc]', - '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 as long as 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' => '过滤表达式类型,SubscriptionExpressionTypeEnum[SQL(SQL过滤),TAG(TAG过滤),UNSPECIFIED(FILTER_TYPE_UNSPECIFIED 过滤类型未指定),code,desc]', - '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' => 'SQL', + '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'], ], - 'topicCreated' => [ - 'description' => 'Indicates whether the topic is created.'."\n", - 'type' => 'boolean', - 'example' => 'true', + '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' => '', ], - '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' => 'boolean', - 'example' => 'true', + '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' => [ - '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' => 'HTTP状态码', - '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', - ], + '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}'], ], ], ], ], - '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"}]', - 'title' => 'ListConsumerGroupSubscriptions', ], 'GetConsumerGroupSubscription' => [ - 'summary' => 'Queries the subscriptions of a consumer group.', 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions/{topicName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'methods' => ['get'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], @@ -4771,39 +2733,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-uqm32kqyy11', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => 'The name of the topic to which the consumer group subscribes.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mq003', 'title' => ''], ], ], 'responses' => [ @@ -4813,20 +2758,10 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], + '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' => '返回结果', + 'title' => '', 'description' => 'The data returned.'."\n", 'type' => 'array', 'items' => [ @@ -4837,298 +2772,180 @@ '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' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', - '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' => '订阅状态,SubscriptionStatusEnum[ONLINE(在线),OFFLINE(离线),code,desc]', - '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' => '过滤表达式类型,SubscriptionExpressionTypeEnum[SQL(SQL过滤),TAG(TAG过滤),UNSPECIFIED(FILTER_TYPE_UNSPECIFIED 过滤类型未指定),code,desc]', - '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', - ], + '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' => '客户端ID', - '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' => '宿主机IP/公网出网IP', - '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' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', - 'description' => 'The consumption mode of the consumer group. Valid values:'."\n" - ."\n" - .'* BROADCASTING: broadcasting consumption'."\n" - .'* CLUSTERING: clustering consumption'."\n", - 'type' => 'string', - 'example' => 'BROADCASTING', - ], + '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' => 'HTTP状态码', - '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', - ], + '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', - ], - 'DeleteConsumerGroupSubscription' => [ - 'summary' => 'Deletes the subscriptions of a consumer group.', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions', - 'methods' => [ - 'delete', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConsumerGroupSubscription'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'delete', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-tl32upjeb08', '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', - ], - ], - [ - 'name' => 'topicName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The topic name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'topic_test', - ], - ], - [ - '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' => '', - 'SQL' => '', - ], - 'example' => 'TAG', - ], + 'schema' => ['description' => 'The consumer Group ID.', 'type' => 'string', 'required' => true, 'example' => 'GID_TT_TASK', 'title' => ''], ], [ - 'name' => 'filterExpression', + 'name' => 'clientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The filter expression.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '*', - ], + 'schema' => ['description' => 'The client ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '172.26.76.48@Lqd7dImlp9KJ5V84', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'The response parameters.'."\n", + 'title' => 'Result<ConsumerJstackDTO>', + 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], + '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 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' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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.'."\n", - 'type' => 'string', - 'example' => 'xxx', + '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\\": \\"723CDA5C-E25C-5EAF-9601-08C286DF8A4D\\",\\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', - 'translator' => 'machine', - ], - 'ListConsumerConnections' => [ - 'summary' => 'Queries the connections of a specific consumer client.', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/connections', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -5137,194 +2954,118 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREons0MOUAZ', - ], + 'abilityTreeCode' => '225053', + 'abilityTreeNodes' => ['FEATUREonsOVRH1R'], ], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'planId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-uax32mf9h1f', - ], + 'schema' => ['description' => 'The ID of the global message backup plan.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016', 'title' => ''], ], [ - 'name' => 'consumerGroupId', + 'name' => 'itemId', 'in' => 'path', - 'schema' => [ - 'description' => 'The consumer group ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'GID_TEST_STOCK_OPEND_GW', - ], - ], - [ - 'name' => 'topicName', - 'in' => 'query', - 'schema' => [ - 'title' => 'lite类型的topic名称', - 'type' => 'string', - 'example' => 'test1', - ], - ], - [ - 'name' => 'liteTopicName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Lite消息队列主题名称', - 'type' => 'string', - 'example' => 'abc', - ], + 'schema' => ['description' => 'The ID of the topic mapping.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100070284', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<ConsumerConnectionsDTO>', - 'description' => 'Result<ConsumerConnectionsDTO>', + 'title' => 'Result<DisasterRecoveryItemDTO>', + 'description' => 'Result<DisasterRecoveryItemDTO>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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 returned data.'."\n", + 'title' => '', + 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => 'The ID of the region in which the instance resides.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'consumerGroupId' => [ - 'title' => '主题名称', - 'description' => 'The consumer group ID.'."\n", - 'type' => 'string', - 'example' => 'CID-TEST', - ], - 'connections' => [ - 'title' => '客户端连接列表', - 'description' => 'The client connection list', + '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' => '', + 'description' => 'Topics included in the backup mapping', 'type' => 'object', 'properties' => [ - 'clientId' => [ - 'title' => '客户端ID', - 'description' => 'The ID of the client.', - 'type' => 'string', - 'example' => '172.17.135.197@17392#1936705963#551717232#9873695589062458', - ], - 'hostname' => [ - 'title' => '客户端IP', - 'description' => 'The `hostname` of the cloud-native box.'."\n", - 'type' => 'string', - 'example' => 'vos', - ], - 'egressIp' => [ - 'title' => '宿主机IP/公网出网IP', - 'description' => 'Host IP/Public IP', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'language' => [ - 'title' => '客户端语言', - 'description' => 'The language of the client.', - 'type' => 'string', - 'example' => 'java', - ], - 'version' => [ - 'title' => '客户端版本', - 'description' => 'The version of the client.', - 'type' => 'string', - 'example' => '1.0', - ], - 'messageModel' => [ - 'title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', - 'description' => 'Consumption Mode'."\n" - .'- BROADCASTING'."\n" - .'- CLUSTERING', + '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', - 'example' => 'BROADCASTING', + '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 returned error code.'."\n", - 'type' => 'string', - 'example' => 'MissingPageNumber', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - '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', - ], + '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\\": \\"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', - ], - 'GetConsumerGroupLag' => [ - 'summary' => 'Query Consumer Group Backlog Information', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/lag', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -5336,249 +3077,150 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '145824', - 'abilityTreeNodes' => [ - 'FEATUREonsJCXOZ6', - ], + 'abilityTreeCode' => '225054', + 'abilityTreeNodes' => ['FEATUREonsOVRH1R'], ], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-2r42vrvde0j', - ], - ], - [ - 'name' => 'consumerGroupId', + 'name' => 'planId', 'in' => 'path', - 'schema' => [ - 'description' => 'The consumer Group ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'CID-TEST', - ], - ], - [ - 'name' => 'topicName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The topic name.'."\n", - 'example' => 'normal-topic-1', - ], - ], - [ - 'name' => 'liteTopicName', - 'in' => 'query', - 'schema' => [ - 'title' => '轻量主题名称', - 'type' => 'string', - 'example' => 'abc', - ], + 'schema' => ['description' => 'The ID of the Global Replicator task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<ConsumerGroupLagDTO>', - 'description' => 'Result<ConsumerGroupLagDTO>', + 'title' => 'Result<DisasterRecoveryPlanDTO>', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n" - ."\n", - 'type' => 'string', - 'example' => 'F5764C40-FB8C-53AE-B95D-96AB3D0E9375', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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" - ."\n", + 'title' => '', + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => 'Instance ID', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'consumerGroupId' => [ - 'title' => '消费组ID', - 'description' => 'Consumer Group ID', - 'type' => 'string', - 'example' => 'CID-TEST', - ], - 'totalLag' => [ - 'title' => '整体堆积量', - 'description' => 'Total lag count', + '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', - 'properties' => [ - 'readyCount' => [ - 'title' => '就绪消息量', - 'description' => 'Ready message count', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'inflightCount' => [ - 'title' => '处理中消息量', - 'description' => 'The number of messages being consumed.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'deliveryDuration' => [ - 'title' => '投递延迟时间', - 'description' => 'Delivery delay time, in seconds', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'lastConsumeTimestamp' => [ - 'title' => '最新消费时间', - 'description' => 'Last consumption time', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1735629607846', - ], - ], + 'additionalProperties' => ['type' => 'string', 'example' => 'xxxx', 'description' => 'The extended information.'."\n", 'title' => ''], ], - 'topicLagMap' => [ - 'title' => '各主题堆积量', - 'description' => 'Backlog for each topic', - 'type' => 'object', - 'additionalProperties' => [ + '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' => [ - 'readyCount' => [ - 'title' => '就绪消息量', - 'description' => 'Ready message count', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'inflightCount' => [ - 'title' => '处理中消息量', - 'description' => 'The number of messages being consumed.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'deliveryDuration' => [ - 'title' => '投递延迟时间', - 'description' => 'Delivery delay time, in seconds', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'lastConsumeTimestamp' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1735629607846', - 'description' => 'lastConsumeTimestamp', + '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' => ''], ], - 'description' => 'Total message count', + 'title' => '', ], ], - 'topicName' => [ - 'title' => '订阅的topic名称', - 'type' => 'string', - 'example' => 'test1', + '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' => '', ], - 'liteTopicLagMap' => [ - 'title' => '轻量主题的消费堆积', - 'type' => 'object', - 'additionalProperties' => [ - 'title' => 'lite类型topic的消费堆积', - 'type' => 'object', - 'properties' => [ - 'readyCount' => [ - 'title' => '堆积消息量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', - ], - 'deliveryDuration' => [ - 'title' => '投递延迟时间，单位：秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - ], - ], + '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' => 'Error code', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'Error message', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - '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' => 'The dynamic error message.'."\n" - ."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], + '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\\": \\"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', - 'translator' => 'machine', - ], - 'GetConsumerStack' => [ - 'summary' => 'Queries the stack information about a consumer.', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/stack', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'https', - 'http', + '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' => [], @@ -5588,293 +3230,449 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147017', + 'abilityTreeNodes' => ['FEATUREonsHF2FLP'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-tl32upjeb08', - ], - ], - [ - 'name' => 'consumerGroupId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The consumer Group ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'GID_TT_TASK', - ], - ], - [ - 'name' => 'clientId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '172.26.76.48@Lqd7dImlp9KJ5V84', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the instance to query.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<ConsumerJstackDTO>', - 'description' => 'The result.'."\n", + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], + '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 data returned.'."\n", + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => 'The region ID.'."\n", + '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' => 'cn-hangzhou', + 'example' => 'standard', ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => 'The instance ID.'."\n", + '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' => 'rmq-cn-7e22ody****', + 'example' => 'cluster_ha', ], - 'consumerGroupId' => [ - 'title' => '主题名称', - 'description' => 'The ID of the consumer group.'."\n", + 'paymentType' => [ + 'title' => '', + 'description' => 'The payment type of the instance.', + 'enumValueTitles' => ['PayAsYouGo' => 'Pay-as-you-go (postpaid).', 'Subscription' => 'Subscription (prepaid).'], 'type' => 'string', - 'example' => 'CID-TEST', + 'enum' => ['Subscription', 'PayAsYouGo'], + 'example' => 'Subscription', ], - 'stacks' => [ - 'title' => '堆栈信息', - 'description' => 'Stack Information.', + '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" + .'<notice>This field is deprecated. Use the vSwitches field instead. For compatibility, this field returns only one vSwitch.></notice>', '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' => 'Consume stack information.', + 'description' => 'The capacity information.', 'type' => 'object', 'properties' => [ - 'thread' => [ - 'title' => '线程ID', - 'description' => 'Thread id.', + 'quotaName' => [ + 'title' => '', + 'description' => 'The quota name of the instance.', + 'enumValueTitles' => ['TOPIC_COUNT' => 'Topic creation quota of the instance.'], 'type' => 'string', - 'example' => '123', + 'example' => 'TOPIC_COUNT', ], - 'tracks' => [ - 'title' => '堆栈信息', - 'description' => 'Stack Information.', - 'type' => 'array', - 'items' => [ - 'description' => 'Stack Information.', - 'type' => 'string', - 'example' => 'xxx', - ], + '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" + .'<props="intl">This parameter does not take effect. Regardless of whether this parameter is enabled, the instance supports the message trace feature by default.</props>'."\n" + .'<props="china">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~~).</props>'."\n" + ."\n" + .'<props="china">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.</props>', '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.'."\n", - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - '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', - ], + '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\\": \\"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', - ], - '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.', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeOffsets/{topicName}', - 'methods' => [ - 'patch', - ], - 'schemes' => [ - 'https', - 'http', - ], - 'security' => [ - [ - 'AK' => [], + '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' => '><notice>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.></notice>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], ], ], - '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', - ], - ], - [ - 'name' => 'consumerGroupId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The consumer group ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dolphin_status', - ], - ], + 'ramActions' => [ [ - 'name' => 'topicName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The topic name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'AMZN_REPORT_TOPIC', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'resetType' => [ - 'title' => '重置方式,ConsumeOffsetResetTypeEnum[LATEST_OFFSET(最新位点),SPECIFIED_TIME(指定时间),code,desc]', - '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', - ], - '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, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<Void>', - 'description' => 'Result'."\n", - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => 'HTTP状态码', - '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', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rocketmq:GetInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#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', ], - 'ListMessages' => [ - 'summary' => 'Queries messages.', - 'path' => '/instances/{instanceId}/topics/{topicName}/messages', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetInstanceAccount' => [ + 'summary' => 'Retrieves the account details for a specified instance.', + 'path' => '/instances/{instanceId}/account', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5883,344 +3681,89 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREonsNPGYUW', - 'FEATUREonsKQSI06', - ], + 'abilityTreeCode' => '150942', + 'abilityTreeNodes' => ['FEATUREonsGA7IC4'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-zvp2vtypu05', - ], - ], - [ - 'name' => 'topicName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The topic name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_delay_queue', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-20p36ja4m0y'], ], [ - 'name' => 'messageId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Message Id.', - 'type' => 'string', - 'required' => false, - 'example' => '7F00000100207A4F0F294A938F7807AE', - ], - ], - [ - 'name' => 'messageKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'Message key.', - 'type' => 'string', - 'required' => false, - 'example' => 'XSCBillResult', - ], - ], - [ - 'name' => 'startTime', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-09-09 08:00:00', - ], - ], - [ - 'name' => 'endTime', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-09-09 09:00:00', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '20', - 'minimum' => '1', - 'example' => '10', - ], - ], - [ - 'name' => 'scrollId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The scroll ID of the request.'."\n" - ."\n" - .'You do not need to configure this parameter for the first page. This parameter is included in the pagination request based on the result returned for the first page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00', - ], - ], - [ - 'name' => 'liteTopicName', + 'name' => 'username', 'in' => 'query', - 'schema' => [ - 'title' => '轻量主题名称', - 'type' => 'string', - 'example' => 'abc', - ], + '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' => 'Result<MyPage<MessageDTO>>', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => [ - 'title' => '返回结果', - 'description' => 'The data returned.'."\n", + 'description' => 'The response data.', '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' => '50', - ], - 'totalCount' => [ - 'title' => '总记录数', - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'list' => [ - 'title' => '分页数据', - 'description' => 'The pagination information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The message information.'."\n", - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'title' => '主题名称', - 'description' => 'The name of the topic.'."\n", - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageId' => [ - 'title' => '消息ID', - 'description' => 'Message Id.', - 'type' => 'string', - 'example' => '7F000001000114B4340C5ABF94500079', - ], - 'bornTime' => [ - 'title' => '生成时间', - 'description' => 'Message born time.', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'storeTime' => [ - 'title' => '存储时间', - 'description' => 'Message store time.', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'body' => [ - 'title' => '消息体', - 'description' => 'Message body.', - 'type' => 'string', - 'example' => '{}', - ], - 'bodySize' => [ - 'description' => 'Message body size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'bornHost' => [ - 'title' => '消息来自哪里', - 'description' => 'The client on which messages are produced.'."\n", - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'storeHost' => [ - 'title' => '消息存储位置', - 'description' => 'The broker on which messages are stored.'."\n", - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'messageType' => [ - 'title' => '消息类型', - 'description' => 'Message type.', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'messageTag' => [ - 'title' => '标签列表', - 'description' => 'The message tag.'."\n", - 'type' => 'string', - 'example' => 'xx', - ], - 'messageGroup' => [ - 'title' => '以前的shardingkey，顺序消息独有', - 'description' => 'The message group. This parameter is returned only for ordered messages.'."\n", - 'type' => 'string', - 'example' => 'xx', - ], - 'messageKeys' => [ - 'title' => '业务标识', - 'description' => 'Message keys.', - 'type' => 'array', - 'items' => [ - 'description' => 'Message key.', - 'type' => 'string', - 'example' => 'xx', - ], - ], - 'userProperties' => [ - 'title' => '用户属性', - 'description' => 'Message user properties.', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'Message user properties.', - 'example' => 'xx', - ], - ], - 'liteTopicName' => [ - 'title' => '轻量主题名称', - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], - ], - 'scrollId' => [ - 'description' => 'The scroll ID of the request.'."\n" - ."\n" - .'The ID is automatically generated by the system. The result can be paginated only if this parameter is included in the pagination request.'."\n", + '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' => 'B13D0B07-F24B-4790-88D8-D47A38063D00', + 'example' => 'ENABLE', + 'title' => '', ], + 'remark' => ['description' => 'The remark.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - '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' => 'HTTP状态码', - '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', - ], + '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\\": \\"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', - ], - 'GetMessageDetail' => [ - 'summary' => 'Obtains the details of a specific message.', - 'path' => '/instances/{instanceId}/topics/{topicName}/messages/{messageId}', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -6230,522 +3773,332 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREonsNPGYUW', - ], + 'abilityTreeCode' => '263406', + 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-lbj31fs790d', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ - 'name' => 'topicName', + 'name' => 'username', 'in' => 'path', - 'schema' => [ - 'description' => 'The topic name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'flink_test', - ], + 'schema' => ['description' => 'The username.'."\n", 'type' => 'string', 'required' => true, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'messageId', - 'in' => 'path', + 'name' => 'resourceType', + 'in' => 'query', 'schema' => [ - 'description' => 'The message ID.'."\n", + '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, - 'example' => '0A792FDB001F7591083D30ADB1DA11D5', + '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' => 'Result<MessageDTO>', - 'description' => 'The result.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FAEBD71F-E839-52F9-BD7B-8F1290525841', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => [ - 'title' => '返回结果', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'title' => '主题名称', - 'description' => 'The topic name.'."\n", - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageId' => [ - 'title' => '消息ID', - 'description' => 'The message ID.'."\n", - 'type' => 'string', - 'example' => '01BE87E485F0C7808C04543CAF00000001', - ], - 'bornTime' => [ - 'title' => '生成时间', - 'description' => 'The time when the message was generated.'."\n", - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'storeTime' => [ - 'title' => '存储时间', - 'description' => 'The time when the message was stored.'."\n", - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'body' => [ - 'title' => '消息体', - 'description' => 'The message body.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'bodySize' => [ - 'description' => 'The size of the message body.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'bornHost' => [ - 'title' => '消息来自哪里', - 'description' => 'The client on which the message was produced.'."\n", - 'type' => 'string', - 'example' => 'xxx.xx.xxx.xx', - ], - 'storeHost' => [ - 'title' => '消息存储位置', - 'description' => 'The broker on which the message was stored.'."\n", - 'type' => 'string', - 'example' => 'xxx.xx.xxx.xx', - ], - 'messageType' => [ - 'title' => '消息类型', - 'description' => 'The message type.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'messageTag' => [ - 'title' => '标签列表', - 'description' => 'The tags.'."\n", - 'type' => 'string', - 'example' => 'xx', - ], - 'messageGroup' => [ - 'title' => '以前的shardingkey，顺序消息独有', - 'description' => 'The sharding key. This parameter is returned only for ordered messages.'."\n", - 'type' => 'string', - 'example' => 'xx', - ], - 'messageKeys' => [ - 'title' => '业务标识', - 'description' => 'The message keys.'."\n", + '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 message key.'."\n", - 'type' => 'string', - 'example' => 'xx', - ], - ], - 'userProperties' => [ - 'title' => '用户属性', - 'description' => 'The user attributes.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'xxx', - 'description' => 'The user attribute.'."\n", - ], - ], - 'systemProperties' => [ - 'description' => 'The default system attributes.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'xx', - 'description' => 'The default system attribute.'."\n", - ], + 'items' => ['description' => 'The type of operation that can be performed on the resource.'."\n", 'type' => 'string', 'example' => 'Pub', 'title' => ''], + 'title' => '', ], - 'liteTopicName' => [ - 'title' => '轻量主题名称', - 'type' => 'string', - 'example' => 'abc', + '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' => [ - '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' => 'HTTP状态码', - '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', - ], + '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\\": \\"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', - 'translator' => 'machine', - ], - 'VerifySendMessage' => [ - 'summary' => 'Verifies the message sending feature of a specific topic on a specific instance.', - 'path' => '/instances/{instanceId}/topics/{topicName}/messages', - 'methods' => [ - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREonsB0E8FD', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '260123', + 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-wwo32kqfm10', - ], - ], - [ - 'name' => 'topicName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The topic name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'card_status_topic', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'ipWhitelists', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'message' => [ - 'title' => '消息内容', - 'description' => 'The message body.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'successful', - ], - 'messageTag' => [ - 'title' => '消息标签', - 'description' => 'The message tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xx', - ], - 'messageKey' => [ - 'title' => '业务标识', - 'description' => 'The message key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xx', - ], - 'liteTopicName' => [ - 'title' => '轻量主题名称', - 'type' => 'string', - 'example' => 'abc', - ], - ], + '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' => 'Result<String>', - 'description' => 'The result.'."\n", + 'title' => 'Schema of Response', + 'description' => '', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3BD2C19B-66DE-59C7-B2F6-FD1BE21DC8C1', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => [ - 'title' => '返回结果', - 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'example' => '0A64228900207A4F0F2931A4E0D40BE5', - ], - 'code' => [ - 'title' => '错误码', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'InvalidConsumerGroupId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - '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' => 'consumerGroupId', + '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' => ''], ], ], ], ], - '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', - ], - 'VerifyConsumeMessage' => [ - 'summary' => 'Verifies the consumption status of a message in a specific topic on a specific instance.', - 'path' => '/instances/{instanceId}/topics/{topicName}/messages/{messageId}/action/verifyConsume', - 'methods' => [ - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREonsNPGYUW'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-i7m2vc1vx01', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-lbj31fs790d', 'title' => ''], ], [ 'name' => 'topicName', 'in' => 'path', - 'schema' => [ - 'description' => 'The topic name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'delay_topic', - ], + 'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'required' => true, 'example' => 'flink_test', 'title' => ''], ], [ 'name' => 'messageId', 'in' => 'path', - 'schema' => [ - 'description' => 'The message ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'A9FE190A59AA421ED014743DFDBF017D', - ], - ], - [ - 'name' => 'consumerGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the consumer group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TEST_FINANCE_STOCK_OUT_GROUP', - ], - ], - [ - 'name' => 'clientId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'zeekr-settlement-server-dc555456f-v2lcg@1@1@qfvorazqns', - ], + 'schema' => ['description' => 'The ID of the message.', 'type' => 'string', 'required' => true, 'example' => '0A792FDB001F7591083D30ADB1DA11D5', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'The result.'."\n", + 'title' => 'Result<MessageDTO>', + 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], + '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 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' => 'HTTP状态码', - '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', + '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' => '', ], ], ], - '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', - ], - 'ListTraces' => [ - 'summary' => 'Queries the message traces of a specific topic.', - 'path' => '/instances/{instanceId}/topics/{topicName}/traces', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -6757,275 +4110,105 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREonsNKYZ9K', - 'FEATUREonsJEU5XG', - 'FEATUREonsYT2OK3', - ], + 'abilityTreeCode' => '144800', + 'abilityTreeNodes' => ['FEATUREons8BETJT'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-tl32upjeb08', - ], + '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 topic name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'topic_hpms_product_price_change', - ], - ], - [ - 'name' => 'startTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2023-05-10 10:42:11', - ], - ], - [ - 'name' => 'endTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2023-05-19 10:10:09', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '10', - ], - ], - [ - 'name' => 'queryType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* MESSAGE_ID'."\n" - .'* MESSAGE_KEY'."\n" - .'* TOPIC'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'MESSAGE_ID' => 'MESSAGE_ID', - 'MESSAGE_KEY' => 'MESSAGE_KEY', - 'TOPIC' => 'TOPIC', - ], - 'example' => 'MESSAGE_ID', - ], - ], - [ - 'name' => 'messageId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The message ID.'."\n" - ."\n" - .'This parameter is required if you set queryType to MESSAGE_ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0100163E0EC1F1965C04C7906700000000', - ], - ], - [ - 'name' => 'messageKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The message key.'."\n" - ."\n" - .'This parameter is required if you set queryType to MESSAGE_ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'order_ceating', - ], - ], - [ - 'name' => 'liteTopicName', - 'in' => 'query', - 'schema' => [ - 'title' => '轻量主题名称', - 'type' => 'string', - 'example' => 'abc', - ], + 'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'topic_test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'Result<TopicDTO>', + 'description' => 'Result', '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.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], + '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' => [ - 'description' => 'The returned result.'."\n", + 'title' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'pageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'totalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + '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', ], - 'list' => [ - 'description' => 'Trace list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Trace list.', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'description' => 'The name of the topic.'."\n", - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageId' => [ - 'description' => 'Message id.', - 'type' => 'string', - 'example' => '7F00000100207A4F0F294A938F7807AE', - ], - 'bornTime' => [ - 'description' => 'Message born time.', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'messageTag' => [ - 'description' => 'Message tag.', - 'type' => 'string', - 'example' => 'xx', - ], - 'messageKeys' => [ - 'description' => 'Message keys.', - 'type' => 'array', - 'items' => [ - 'description' => 'Message key.', - 'type' => 'string', - 'example' => 'xx', - ], - ], - ], - ], + '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' => '', ], - 'httpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => 'The dynamic error code.'."\n", - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'InstanceId', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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}'], + ], + ], + ], ], - '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', ], 'GetTrace' => [ - 'summary' => 'Queries the trace of a specific message in a specific topic.', + 'summary' => 'Retrieves the trace of a specified message in a specified topic.', 'path' => '/instances/{instanceId}/topics/{topicName}/traces/{messageId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7038,842 +4221,548 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '172963', - 'abilityTreeNodes' => [ - 'FEATUREonsNKYZ9K', - ], + 'abilityTreeNodes' => ['FEATUREonsNKYZ9K'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-zvp2vtypu05', - ], + '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 topic name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'linkedcare-image', - ], + '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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '012A5AB0BBEC8A000104C6342B00001ECF', - ], + 'schema' => ['description' => 'The message ID.', 'type' => 'string', 'required' => true, 'example' => '012A5AB0BBEC8A000104C6342B00001ECF', 'title' => ''], ], [ 'name' => 'startTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '2023-05-10 10:42:11', 'title' => ''], ], [ 'name' => 'endTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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 parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - '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' => '7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49', - ], - 'success' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'description' => 'The topic name.'."\n", - 'type' => 'string', - 'example' => 'topic_test', - ], + '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.'."\n", + 'description' => 'The message information.', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'instanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-u0t2ygjq505', - ], - 'topicName' => [ - 'description' => 'The topic name.'."\n", - 'type' => 'string', - 'example' => 'Topic_normal_inspector', - ], - 'messageId' => [ - 'description' => 'The message ID.', - 'type' => 'string', - 'example' => '0A79275A00207A4F0F2916C92F9A0B94', - ], - 'bornTime' => [ - 'description' => 'Message born time.', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'storeTime' => [ - 'description' => 'Message store time.', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'body' => [ - 'description' => 'Message body.', - 'type' => 'string', - 'example' => '{}', - ], - 'bornHost' => [ - 'description' => 'Message born host.', - 'type' => 'string', - 'example' => 'x.x.x.x', - ], - 'storeHost' => [ - 'description' => 'Message store host.', - 'type' => 'string', - 'example' => 'x.x.x.x', - ], - 'messageType' => [ - 'description' => 'Message type.', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'messageTag' => [ - 'description' => 'Message tag.', - 'type' => 'string', - 'example' => 'xx', - ], - 'messageGroup' => [ - 'description' => 'Message grpup.', - 'type' => 'string', - 'example' => 'xx', - ], + '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' => 'Message keys.', + 'description' => 'The business ID.', 'type' => 'array', - 'items' => [ - 'description' => 'Message key.', - 'type' => 'string', - 'example' => 'xx', - ], + 'items' => ['description' => 'The business ID.', 'type' => 'string', 'example' => 'xx', 'title' => ''], + 'title' => '', + 'example' => '', ], 'userProperties' => [ - 'description' => 'Message user properties.', + 'description' => 'The user-defined properties.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'xx', - 'description' => 'Message user properties.', - ], - ], - 'transactionId' => [ - 'description' => 'Message transaction id.', - 'type' => 'string', - 'example' => 'xx', - ], - 'liteTopicName' => [ - 'title' => '轻量主题名称', - 'type' => 'string', - 'example' => 'abc', + '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 producer trace.'."\n", + 'description' => 'The trace information of the producer.', 'type' => 'object', 'properties' => [ 'records' => [ - 'description' => 'The production records.'."\n", + 'description' => 'The list of production records.', 'type' => 'array', 'items' => [ - 'description' => 'The production record.'."\n", + 'description' => 'The list of production records.', 'type' => 'object', 'properties' => [ - 'userName' => [ - 'description' => 'Producer name.', - 'type' => 'string', - 'example' => 'xxx', - ], - 'clientHost' => [ - 'description' => 'Client host.', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'produceTime' => [ - 'description' => 'Producer time.', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'produceDuration' => [ - 'description' => 'Producer duration.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'produceStatus' => [ - 'description' => 'Producer status.', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'arriveTime' => [ - 'description' => 'Arrive time.', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'messageSource' => [ - 'description' => 'Message source.', - 'type' => 'string', - 'example' => 'CONSOLE', - ], - 'dlqOriginTopic' => [ - 'description' => 'Dead-letter queue topic.', - 'type' => 'string', - 'example' => 'test_topic', - ], - 'dlqOriginMessageId' => [ - 'description' => 'Dead-letter queue message ID.', - 'type' => 'string', - 'example' => '0A79275A00207A4F0F2916C92F9A0B94', - ], - 'recallTime' => [ - 'description' => 'The time when the scheduled message withdrawal request was initiated', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08'."\n", - ], + '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 broker trace.'."\n", + 'description' => 'The trace information of the broker.', 'type' => 'object', 'properties' => [ - 'presetDelayTime' => [ - 'description' => 'Preset delivery time.', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'delayStatus' => [ - 'description' => 'Delay status.', - 'type' => 'string', - 'example' => 'SUCCESS', - ], + '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' => 'Operation list.', + 'description' => 'The list of operations.', 'type' => 'array', 'items' => [ - 'description' => 'Operation list.', + 'description' => 'The list of operations.', 'type' => 'object', 'properties' => [ - 'operateType' => [ - 'description' => 'Operation type.', - 'type' => 'string', - 'example' => 'ADD', - ], - 'operateTime' => [ - 'description' => 'Operation time.', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], + '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' => 'Withdraw scheduled message request result', - 'type' => 'string', - 'example' => 'RECALL_OK', - ], + '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' => 'Consumer trace info.', + 'description' => 'The trace information of the consumer.', 'type' => 'array', 'items' => [ - 'description' => 'Consumer trace info.', + 'description' => 'The trace information of the consumer.', 'type' => 'object', 'properties' => [ - 'consumerGroupId' => [ - 'description' => 'The consumer group ID.'."\n", - 'type' => 'string', - 'example' => 'GID_inspector_group', - ], + 'consumerGroupId' => ['description' => 'The consumer group ID.', 'type' => 'string', 'example' => 'GID_inspector_group', 'title' => ''], 'records' => [ - 'description' => 'Consumer record list.', + 'description' => 'The list of consumption records.', 'type' => 'array', 'items' => [ - 'description' => 'Consumer record list.', + 'description' => 'The list of consumption records.', 'type' => 'object', 'properties' => [ - 'userName' => [ - 'description' => 'Consumer name.', - 'type' => 'string', - 'example' => 'test', - ], - 'clientHost' => [ - 'description' => 'Client host.', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'fifoEnable' => [ - 'description' => 'Whether to consume fifo.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'consumeStatus' => [ - 'description' => 'Consume status.', - 'type' => 'string', - 'example' => 'SUCCESS', - ], + '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' => 'Operation list.', + 'description' => 'The list of operations.', 'type' => 'array', 'items' => [ - 'description' => 'Operation list.', + 'description' => 'The list of operations.', 'type' => 'object', 'properties' => [ - 'operateType' => [ - 'description' => 'Operation type.', - 'type' => 'string', - 'example' => 'ADD', - ], - 'operateTime' => [ - 'description' => 'Operation time.', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'invisibleTime' => [ - 'description' => 'Invisible time, milliseconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'deadMessage' => [ - 'description' => 'Whether it is a dead letter message.', - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => 'POP_CK', - 'type' => 'string', - 'example' => '123', - ], + 'popCk' => ['description' => 'The POP checkpoint.', 'type' => 'string', 'example' => '123', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'consumeStatus' => [ - 'description' => 'Consume status.', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'deadMessage' => [ - 'description' => 'Whether it is a dead letter message.', - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => 'Dead letter info.', + 'description' => 'The information about the dead-letter message.', 'type' => 'object', 'properties' => [ - 'topicName' => [ - 'description' => 'The topic name.'."\n", - 'type' => 'string', - 'example' => 'Register_Sync', - ], - 'messageId' => [ - 'description' => 'MessageId.', - 'type' => 'string', - 'example' => '7F000001001F7A4F0F29463F0376047D', - ], - 'toDlqTime' => [ - 'description' => 'Arrival time in the dead letter queue.', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], + '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.'."\n", - 'type' => 'string', - 'example' => 'InvalidConsumerGroupId', - ], - 'message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => 'The dynamic error code.'."\n", - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], + '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\\": \\"空 | 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\\": \\"空 | 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"}]', + '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', - ], - 'CreateInstanceAccount' => [ - 'summary' => 'Creates an account that is used to access an instance.', - 'path' => '/instances/{instanceId}/accounts', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrace'], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', + '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' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'password' => [ - 'title' => '用户密码', - 'description' => 'The password of the account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'xxx', - ], - 'username' => [ - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'xxx', - ], - ], - 'required' => false, - ], + 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<ZoneDTO>>', + 'description' => 'Result<List<ZoneDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => '3AE0999C-8DBA-5CEE-8D9A-BE8D4A90DF8D', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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 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' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => 'No permission details', - 'type' => 'string', - 'example' => 'xxx', + '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'], ], ], ], ], - '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', - ], - 'UpdateInstanceAccount' => [ - 'summary' => 'Updates the information about a specific account in a specific instance.', - 'path' => '/instances/{instanceId}/accounts/{username}', - 'methods' => [ - 'patch', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '209887', - 'abilityTreeNodes' => [ - 'FEATUREonsGA7IC4', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREons0MOUAZ'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-uax32mf9h1f', 'title' => ''], ], [ - 'name' => 'username', + 'name' => 'consumerGroupId', 'in' => 'path', - 'schema' => [ - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The consumer group ID.', 'type' => 'string', 'required' => true, 'example' => 'GID_TEST_STOCK_OPEND_GW', 'title' => ''], ], [ - 'name' => 'accountStatus', + 'name' => 'topicName', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the account.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DISABLE'."\n" - .'* ENABLE'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DISABLE' => '', - 'ENABLE' => '', - ], - 'example' => 'ENABLE', - ], + 'schema' => ['description' => 'The name of the lite topic.', 'type' => 'string', 'example' => 'test1', 'title' => '', 'required' => false], ], [ - 'name' => 'password', + 'name' => 'liteTopicName', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the Lite MSMQ topic.', 'type' => 'string', 'example' => 'abc', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<ConsumerConnectionsDTO>', + 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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 is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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 result.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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', + '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\\": \\"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', - ], - 'DeleteInstanceAccount' => [ - 'summary' => 'Delete access control ACL user', - 'path' => '/instances/{instanceId}/accounts/{username}', - 'methods' => [ - 'delete', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '145821', + 'abilityTreeNodes' => ['FEATUREons0MOUAZ'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => 'The ID of the ApsaraMQ for RocketMQ instance.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-tl32wwz1r05', 'title' => ''], ], [ - 'name' => 'username', + 'name' => 'consumerGroupId', 'in' => 'path', - 'schema' => [ - 'description' => 'Account name', - 'type' => 'string', - 'required' => true, - 'example' => 'xxx', - ], + '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<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<SubscriptionDTO>>', + 'description' => 'Result\\<List>', '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', - ], + '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 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', + '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' => '', ], ], ], - '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', - 'translator' => 'machine', - ], - 'ListInstanceAccount' => [ - 'summary' => 'Queries the accounts that are used to access a specific instance.', - 'path' => '/instances/{instanceId}/accounts', - 'methods' => [ - 'get', + 'title' => 'ListConsumerGroupSubscriptions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConsumerGroupSubscriptions'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -7883,249 +4772,127 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '209888', - 'abilityTreeNodes' => [ - 'FEATUREonsGA7IC4', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '144685', + 'abilityTreeNodes' => ['FEATUREonsYVMMCL'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], - ], - [ - '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', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'pageSize', + 'name' => 'filter', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '10', - 'example' => '10', - ], + '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' => 'username', + 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The page number of the results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'title' => '', 'example' => '1'], ], [ - 'name' => 'accountType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The account type.'."\n" - .' - CUSTOMER'."\n" - .' - DEFAULT', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CUSTOMER' => '', - 'DEFAULT' => '', - ], - 'example' => 'CUSTOMER', - ], - ], - [ - 'name' => 'accountStatus', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the account.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DISABLE'."\n" - .'* ENABLE'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DISABLE' => '', - 'ENABLE' => '', - ], - 'example' => 'ENABLE', - ], + '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<MyPage<InstanceAccountDTO>>', - 'description' => 'The response parameters.'."\n", + 'title' => 'Result<MyPage<ConsumerGroupDTO>>', + 'description' => 'Result\\<MyPage\\<ConsumerGroupDto>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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 data returned.'."\n", + 'title' => '', + 'description' => 'The returned data.', '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' => '24', - ], + '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 pagination information.'."\n", + 'title' => '', + 'description' => 'The data returned on the current page.', 'type' => 'array', 'items' => [ - 'description' => 'The account information.'."\n", 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => 'regionId', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例id', - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'username' => [ - 'title' => '用户名', - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'accountType' => [ - 'title' => '账号类型', - 'description' => 'The account type.'."\n" - .' - CUSTOMER'."\n" - .' - DEFAULT', - 'type' => 'string', - 'enumValueTitles' => [ - 'CUSTOMER' => '', - 'DEFAULT' => '', - ], - 'example' => 'CUSTOMER', - ], - 'accountStatus' => [ - 'title' => '账号状态', - 'description' => 'The status of the account.'."\n" - .'Valid values:'."\n" - .' - DISABLE'."\n" - .' - ENABLE', + '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', - 'enumValueTitles' => [ - 'DISABLE' => '', - 'ENABLE' => '', - ], - 'example' => 'ENABLE', + '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' => [ - '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' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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', - ], + '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\\": \\"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 }\\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', - ], - 'GetInstanceAccount' => [ - 'summary' => 'Obtains the account used to access a specific instance.', - 'path' => '/instances/{instanceId}/account', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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' => '><notice>'."\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" + .'></notice>', + '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' => [], @@ -8134,700 +4901,625 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '150942', - 'abilityTreeNodes' => [ - 'FEATUREonsGA7IC4', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '251690', + 'abilityTreeNodes' => ['FEATUREonsOVRH1R'], ], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'planId', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The instance ID.'."\n" - ."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-20p36ja4m0y', - ], + 'schema' => ['title' => '备份计划ID', 'description' => 'Backup Plan ID', 'type' => 'string', 'required' => true, 'example' => '1300000016'], ], [ - 'name' => 'username', + 'name' => 'itemId', + 'in' => 'path', + 'schema' => ['title' => '备份映射ID', 'description' => 'Backup Mapping ID', 'type' => 'string', 'required' => true, 'example' => '100070284'], + ], + [ + 'name' => 'instanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The username of the account.'."\n" - ."\n" - .'If you do not configure this parameter, the default username of the instance is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + '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' => 'The response parameters.'."\n", + 'description' => 'Response Result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID, each request\'s ID is unique and can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => 'B5C59E80-FCFC-5796-ABE4-D39EAAE578E4', - ], - 'success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => 'The returned data.'."\n", + 'description' => 'Response Data', 'type' => 'object', 'properties' => [ - 'username' => [ - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'password' => [ - 'description' => 'The password of the account.'."\n", - 'type' => 'string', - 'example' => '*************', - ], - 'accountStatus' => [ - 'type' => 'string', - 'description' => 'The status of the account.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DISABLE'."\n" - .'* ENABLE'."\n", - 'example' => 'ENABLE', + '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' => 'The error code.'."\n" - ."\n", - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'description' => 'The error message.'."\n" - ."\n", - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => 'The dynamic error code.'."\n" - ."\n", - 'type' => 'string', - 'example' => 'ConsumerGroupId', - ], - 'dynamicMessage' => [ - 'description' => 'The dynamic error message.'."\n" - ."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], + '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\\": \\"B5C59E80-FCFC-5796-ABE4-D39EAAE578E4\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"username\\": \\"xxx\\",\\n \\"password\\": \\"*************\\",\\n \\"accountStatus\\": \\"ENABLE\\"\\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', + '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', - ], - 'CreateInstanceAcl' => [ - 'summary' => 'Creates an access control list (ACL) in a specific instance.', - 'path' => '/instances/{instanceId}/acl/account/{username}', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDisasterRecoveryCheckpoints'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '209893', - 'abilityTreeNodes' => [ - 'FEATUREonsO60XBD', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225046', + 'abilityTreeNodes' => ['FEATUREonsOVRH1R', 'FEATUREonsU22PJL'], ], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'planId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => 'The ID of the Global Replicator task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'username', - 'in' => 'path', - 'schema' => [ - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'abc', - ], + 'name' => 'topicName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The topic name.'."\n", 'example' => 'topic-test920', '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', - 'enum' => [ - 'Topic', - 'Group', - ], - ], - 'resourceName' => [ - 'title' => '授权资源名称', - 'description' => 'The name of the resource on which you want to grant permissions.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'decision' => [ - 'title' => '决策,DecisionEnum[ALLOW,DENY,type,desc]', - 'description' => 'The decision result of the authorization.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Deny'."\n" - .'* Allow'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Deny' => '', - 'Allow' => '', - ], - 'example' => 'Allow', - 'enum' => [ - 'Allow', - 'Deny', - ], - ], - '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', - ], - 'required' => true, - 'enumValueTitles' => [ - 'Sub' => '', - 'Pub|Sub' => '', - 'Pub' => '', - ], - 'example' => 'Pub', - ], - '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', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + '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<Boolean>', - 'description' => 'The result.'."\n", + 'title' => 'Result<MyPage<DisasterRecoveryItemDTO>>', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], + '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' => '返回结果', + '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' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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.'."\n", - 'type' => 'string', - 'example' => 'xxx', + '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\\": \\"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"}]', - 'title' => 'CreateInstanceAcl', + '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', - ], - 'UpdateInstanceAcl' => [ - 'summary' => 'Updates the permissions on the resources of a specific instance for a specific user.', - 'path' => '/instances/{instanceId}/acl/account/{username}', - 'methods' => [ - 'patch', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDisasterRecoveryItems'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '209892', - 'abilityTreeNodes' => [ - 'FEATUREonsO60XBD', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225050', + 'abilityTreeNodes' => ['FEATUREonsOVRH1R'], ], 'parameters' => [ [ 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-778xxx', 'title' => ''], ], [ - 'name' => 'username', - 'in' => 'path', - 'schema' => [ - 'description' => 'The username.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + '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' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'resourceType' => [ - 'title' => '授权的资源列表,ResourceTypeEnum[TOPIC,GROUP,code,desc]', - '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', - ], - 'required' => false, - 'enumValueTitles' => [ - 'Sub' => '', - 'Pub|Sub' => '', - 'Pub' => '', - ], - 'example' => 'Pub', - 'title' => '', - ], - 'decision' => [ - 'title' => '决策,DecisionEnum[ALLOW,DENY,type,desc]', - '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' => 'ip白名单', - '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', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + '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<Boolean>', - 'description' => 'Result'."\n", + 'title' => 'Result<MyPage<DisasterRecoveryPlanDTO>>', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], + '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' => '返回结果', + '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' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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.'."\n", - 'type' => 'string', - 'example' => 'xxx', + '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\\": \\"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"}]', - 'title' => 'UpdateInstanceAcl', - ], - 'DeleteInstanceAcl' => [ - 'summary' => 'Deletes the permissions of a specific account of an instance.', - 'path' => '/instances/{instanceId}/acl/account/{username}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '209888', + 'abilityTreeNodes' => ['FEATUREonsGA7IC4'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + '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' => 'path', - 'schema' => [ - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'in' => 'query', + 'schema' => ['description' => 'The username of the account.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'resourceType', + 'name' => 'accountType', '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", + 'description' => 'The type of the account.', + 'enumValueTitles' => ['CUSTOMER' => 'custom account', 'DEFAULT' => 'default account'], 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Group' => 'Group', - 'Topic' => 'Topic', - ], - 'example' => 'Topic', + 'required' => false, + 'example' => 'CUSTOMER', + 'title' => '', ], ], [ - 'name' => 'resourceName', + 'name' => 'accountStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the resource on which the permissions are granted.'."\n", + 'description' => 'The status of the account.', + 'enumValueTitles' => ['DISABLE' => 'Disabled', 'ENABLE' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'required' => false, + 'example' => 'ENABLE', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'The result.'."\n", + 'title' => 'Result<MyPage<InstanceAccountDTO>>', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], + '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 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' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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', - ], + '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}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7358418D-83BD-507A-8079-611C63E05674\\",\\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', - 'translator' => 'machine', ], 'ListInstanceAcl' => [ - 'summary' => 'Queries the access control lists (ACLs) of an instance.', 'path' => '/instances/{instanceId}/acl', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8838,56 +5530,28 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '209895', - 'abilityTreeNodes' => [ - 'FEATUREonsO60XBD', - ], + 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + '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', - ], + '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', - ], + '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', - ], + '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' => [ @@ -8897,85 +5561,40 @@ 'description' => 'The result.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], + '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' => '返回结果', + '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', - ], + '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' => '分页数据', + 'title' => '', 'description' => 'The pagination information.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ACL.'."\n", 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], + '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' => '访问类型', + 'title' => '', 'description' => 'The ACL type.'."\n" ."\n" .'Valid value:'."\n" ."\n" .'* APACHE: open source ACL.'."\n", 'type' => 'string', - 'enumValueTitles' => [ - 'APACHE' => '', - ], + 'enumValueTitles' => ['APACHE' => '开源ACL'], 'example' => 'APACHE', ], - 'username' => [ - 'title' => '访问秘钥', - 'description' => 'The username.'."\n", - 'type' => 'string', - 'example' => 'test', - ], + 'username' => ['title' => '', 'description' => 'The username.'."\n", 'type' => 'string', 'example' => 'test'], 'resourceType' => [ - 'title' => '资源类型', + 'title' => '', 'description' => 'The resource type.'."\n" ."\n" .'Valid values:'."\n" @@ -8983,20 +5602,12 @@ .'* Group'."\n" .'* Topic'."\n", 'type' => 'string', - 'enumValueTitles' => [ - 'Group' => '', - 'Topic' => '', - ], + 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], 'example' => 'Topic', ], - 'resourceName' => [ - 'title' => '资源名称', - 'description' => 'The resource name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], + 'resourceName' => ['title' => '', 'description' => 'The resource name.'."\n", 'type' => 'string', 'example' => 'test'], 'decision' => [ - 'title' => '决策,DecisionEnum[ALLOW,DENY,type,desc]', + 'title' => '', 'description' => 'The decision result.'."\n" ."\n" .'Valid values:'."\n" @@ -9004,10 +5615,7 @@ .'* Deny: Access is denied.'."\n" .'* Allow: Access is allowed.'."\n", 'type' => 'string', - 'enumValueTitles' => [ - 'Deny' => '', - 'Allow' => '', - ], + 'enumValueTitles' => ['Deny' => '拒绝访问', 'Allow' => '允许访问'], 'example' => 'Allow', ], 'actions' => [ @@ -9021,81 +5629,61 @@ .'* SUB: message subscription.'."\n" .'* Pub: message sending.'."\n", 'type' => 'string', - 'enumValueTitles' => [ - 'Sub' => '', - 'Pub' => '', - ], + 'enumValueTitles' => ['Sub' => '订阅', 'Pub' => '发送'], 'example' => 'Pub', + 'title' => '', ], + 'title' => '', ], 'ipWhitelists' => [ - 'title' => 'ip白名单', + 'title' => '', 'description' => 'The IP address whitelists.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The IP address whitelist.'."\n", - 'type' => 'string', - 'example' => '0.0.0.0/0', - ], + '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' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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', - ], + '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', - ], - 'GetInstanceAcl' => [ - 'summary' => 'Queries information about the access control list (ACL) of an instance.', - 'path' => '/instances/{instanceId}/acl/account/{username}', - 'methods' => [ - 'get', + 'summary' => 'Queries the access control lists (ACLs) of an instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceAcl'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -9104,446 +5692,549 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '263406', - 'abilityTreeNodes' => [ - 'FEATUREonsO60XBD', - ], + '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****', - ], + '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', - ], + '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' => 'resourceType', + 'name' => 'pageSize', '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', - ], + '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' => 'resourceName', + 'name' => 'ipWhitelist', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource on which you want to grant permissions.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'IP whitelist.', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => 'Result<MyPage<String>>', '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', - ], + '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' => [ - 'description' => 'The returned data.'."\n", + 'title' => '', + 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - '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', - ], - 'username' => [ - 'description' => 'The username.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'resourceType' => [ - 'description' => 'The type of the resource on which the permissions are granted.'."\n", - 'type' => 'string', - 'example' => 'Topic', - ], - 'resourceName' => [ - 'description' => 'The name of the resource on which the permissions are granted.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'decision' => [ - 'description' => 'The decision result of the authorization.'."\n", - 'type' => 'string', - 'example' => 'Allow', - ], - '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', - ], - ], - 'ipWhitelists' => [ - 'description' => 'The IP address whitelists.'."\n", + '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. IP addresses and CIDR blocks are supported.'."\n", - 'type' => 'string', - 'example' => '0.0.0.0/0', - ], + 'items' => ['description' => 'The IP address whitelist.'."\n", 'type' => 'string', 'example' => '0.0.0.0/0', 'title' => ''], ], ], ], - 'code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => 'The dynamic error code.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'dynamicMessage' => [ - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], + '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\\": \\"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\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', - 'title' => 'GetInstanceAcl', - ], - 'CreateInstanceIpWhitelist' => [ - 'summary' => 'Creates an IP address whitelist.', - 'path' => '/instances/{instanceId}/ip/whitelist', - 'methods' => [ - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '144675', + 'abilityTreeNodes' => ['FEATUREonsICR0M4'], ], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + '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' => 'body', - 'in' => 'body', - 'style' => 'json', + '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 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', - ], - 'required' => true, - ], - ], + '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<Boolean>', - 'description' => 'The result.'."\n", + 'title' => 'Result<MyPage<InstanceDTO>>', + 'description' => 'Result\\<MyPage\\<InstanceDto>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], + '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.'."\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' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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.'."\n", - 'type' => 'string', - 'example' => 'xxx', + '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" + .'<props="intl">This parameter is not yet in effect. The message trace feature is supported by default regardless of whether this parameter is enabled.</props>'."\n" + .'<props="china">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~~).</props>'."\n" + ."\n" + .'<props="china">'."\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" + .'</props>', '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\\": \\"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', - 'translator' => 'machine', - ], - 'DeleteInstanceIpWhitelist' => [ - 'summary' => 'Deletes a specific IP address whitelist from an instance.', - 'path' => '/instances/{instanceId}/ip/whitelist', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', + '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' => '><notice>'."\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" + .'></notice>', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '209878', - 'abilityTreeNodes' => [ - 'FEATUREonsO60XBD', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREonsNPGYUW', 'FEATUREonsKQSI06'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-zvp2vtypu05', 'title' => ''], ], [ - 'name' => 'ipWhitelist', + '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 IP address whitelist.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => '0.0.0.0/0', - ], + 'schema' => ['description' => 'The message ID.', 'type' => 'string', 'required' => false, 'example' => '7F00000100207A4F0F294A938F7807AE', 'title' => ''], ], [ - 'name' => 'ipWhitelists', + 'name' => 'messageKey', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The IP address whitelist.', - 'example' => '0.0.0.0/0'."\n", - ], - 'required' => false, - 'description' => 'The IP address whitelist.', - ], + '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<Boolean>', - 'description' => 'The result.'."\n", + 'title' => 'Result<MyPage<MessageDTO>>', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], + '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.'."\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' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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', + '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\\": \\"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', - 'translator' => 'machine', - ], - 'ListInstanceIpWhitelist' => [ - 'summary' => 'Queries the IP address whitelists of an instance.', - 'path' => '/instances/{instanceId}/ip/whitelist', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -9551,171 +6242,91 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '209879', - 'abilityTreeNodes' => [ - 'FEATUREonsO60XBD', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], - ], - [ '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', - ], + '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' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '10', - 'example' => '10', - ], - ], - [ - 'name' => 'ipWhitelist', - 'in' => 'query', - 'schema' => [ - 'description' => 'IP whitelist.', - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0.0/0', - ], + '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<MyPage<String>>', - 'description' => 'The response parameters.'."\n", + 'title' => 'Result<MyPage<MetricMetaDTO>>', + 'description' => 'Result<MyPage<MetricMetaDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], + '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' => 'The data returned.'."\n", + 'description' => 'Return result', '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', - ], + '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' => 'The pagination information.'."\n", + 'description' => 'Paged data', 'type' => 'array', 'items' => [ - 'description' => 'The IP address whitelist.'."\n", - 'type' => 'string', - 'example' => '0.0.0.0/0', + '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' => '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' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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', - ], + '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\\": \\"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', - ], - 'GetInstanceIpWhitelist' => [ - 'summary' => 'Queries the information about the IP address whitelist of an instance.', - 'path' => '/instances/{instanceId}/ip/whitelists', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -9723,131 +6334,221 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '260123', - 'abilityTreeNodes' => [ - 'FEATUREonsO60XBD', - ], - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'instanceId', + '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 instance ID.'."\n", + 'description' => 'The type of the migration stage.', + 'enumValueTitles' => ['MIGRATE_MESSAGE' => 'message migration'], 'type' => 'string', 'required' => true, - 'example' => 'rmq-cn-7e22ody****', + 'example' => 'MIGRATE_MESSAGE', + 'title' => '', ], ], [ - 'name' => 'ipWhitelists', + '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' => [ - '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', - ], + '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' => 'Schema of Response', - 'description' => '', + 'title' => 'Result<MyPage<MigrationOperationDTO>>', + 'description' => 'Result\\<MyPage>', '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', - ], + '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' => [ - 'description' => 'The data returned.'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'ipWhitelists' => [ - 'description' => 'The IP address whitelists.', + '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 IP address whitelist.', - 'type' => 'string', - 'example' => '0.0.0.0/0', + '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.'."\n", - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'httpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => 'The dynamic error code.'."\n", - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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}'], + ], + ], + ], ], - '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', ], 'ListMigrations' => [ 'summary' => 'Queries migration tasks.', 'path' => '/migrations', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'methods' => ['get'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], @@ -9855,276 +6556,219 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'filter', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xx', - ], + 'schema' => ['description' => 'The filter condition for the query.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], ], [ 'name' => 'migrationType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The migration type:'."\n" + ."\n" + .'- INSTANCE\\_MIGRATION: instance migration', + 'enumValueTitles' => ['INSTANCE_MIGRATION' => 'Instance migration'], 'type' => 'string', 'required' => true, - 'example' => 'RESOURCE_IMPORT', + 'example' => 'INSTANCE_MIGRATION', + 'title' => '', ], ], [ 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], + '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '10000', - 'minimum' => '10', - 'example' => '10', - ], + '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' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm4goe2ckfiva', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Result<MyPage<MigrationDTO>>', - 'description' => 'Result<MyPage<MigrationDTO>>', + 'description' => 'Result\\<MyPage>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'E5897B2E-C3AC-56DC-A482-F0E9E53F48D5', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '', + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'pageNumber' => [ - 'title' => '当前页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'title' => '分页大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'totalCount' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + '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' => '', + 'title' => '', + 'description' => 'The data on the current page.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The list of migration tasks.', 'type' => 'object', 'properties' => [ - 'migrationId' => [ - 'title' => '迁移ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21', - ], - 'migrationName' => [ - 'title' => '迁移名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx', - ], - 'migrationType' => [ - 'title' => '迁移类型,MigrationTypeEnum[RESOURCE_IMPORT(资源导入),INSTANCE_MIGRATION(实例迁移),code(编码),desc(描述)]', - 'description' => '', - 'type' => 'string', - 'example' => 'INSTANCE_MIGRATION', - ], + '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' => [ - 'title' => '迁移状态,MigrationStatusEnum[CREATED(已创建),MIGRATING(迁移中),COMPLETED(已完成),code(编码),desc(描述)]', - 'description' => '', + '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' => [ - 'title' => '用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '111', - ], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => '111'], 'currentStage' => [ - 'title' => '当前阶段,MigrationStageTypeEnum[CONNECT_NETWORK(网络打通),MIGRATE_METADATA(迁移元数据),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(消息迁移),code(编码),desc(描述),type(类型)]', - 'description' => '', + 'title' => '', + 'description' => 'The current migration stage.', 'type' => 'object', 'properties' => [ 'stageType' => [ - 'title' => '阶段类型,MigrationStageTypeEnum[CONNECT_NETWORK(网络打通),MIGRATE_METADATA(迁移元数据),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(消息迁移),code(编码),desc(描述),type(类型)]', - 'description' => '', + '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' => [ - 'title' => '阶段状态,MigrationStageStatusEnum[INIT(未开始),DOING(执行中),DONE(已完成),code(编码),desc(描述)]', - 'description' => '', + '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' => [ - 'title' => '阶段数据', - 'description' => '', - 'type' => 'any', - 'example' => '[]', - ], + 'stageData' => ['description' => 'The stage data.', 'type' => 'any', 'title' => '', 'example' => '[]'], ], + 'example' => '', ], 'migrationSource' => [ - 'title' => '迁移来源', - 'description' => '', + 'title' => '', + 'description' => 'The migration source.', 'type' => 'object', 'properties' => [ 'sourceType' => [ - 'title' => '迁移来源类型,MigrationSourceTypeEnum[EXTERNAL_INSTANCE(外部实例),UPLOADED_FILE(上传文件),code(编码),desc(描述),type(类型)]', - 'description' => '', + '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' => [ - 'title' => '迁移来源数据', - 'description' => '', - 'type' => 'any', - 'example' => '[]', - ], + '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' => '', + 'title' => '', + 'description' => 'The migration target.', 'type' => 'object', 'properties' => [ 'targetType' => [ - 'title' => '迁移目标类型,MigrationTargetTypeEnum[INTERNAL_INSTANCE(内部实例),code(编码),desc(描述),type(类型)]', - 'description' => '', + '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' => [ - 'title' => '迁移目标数据', - 'description' => '', - 'type' => 'any', - 'example' => '[]', - ], + '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' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2022-08-01 00:00:00', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], + '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' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'instanceId', - ], + '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', - ], - 'ListMigrationOperations' => [ - 'summary' => 'Queries a list of migration operations.', - 'path' => '/migrations/{migrationId}/stages/{stageType}/operations', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -10132,626 +6776,603 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'migrationId', - 'in' => 'path', + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '135', + 'title' => 'Result<List<RegionDTO>>', + 'description' => 'Result\\<List>'."\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' => [ [ - 'name' => 'stageType', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MIGRATE_MESSAGE', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ [ - 'name' => 'operationType', + 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'IMPORT_CONSUMER_GROUP', - ], + 'schema' => ['title' => '地域ID。', 'description' => 'Region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'filter', + 'name' => 'resourceType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xx', - ], + 'schema' => ['title' => '资源类型。', 'description' => 'Resource type.', 'type' => 'string', 'required' => true, 'example' => 'instance'], ], [ - 'name' => 'instanceId', + 'name' => 'resourceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-zxu37eiqq0x', - ], + 'schema' => ['title' => '资源ID列表，JSON格式。', 'description' => 'List of resource IDs, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '["rmq-cn-pe334n08h08"]'], ], [ - 'name' => 'pageNumber', + 'name' => 'tag', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['title' => '标签列表，JSON格式。', 'description' => 'List of tags, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '[{"key": "rmq-test", "value": "test"}]'], ], [ - 'name' => 'pageSize', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '10000', - 'minimum' => '10', - 'example' => '10', - ], + '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<MyPage<MigrationOperationDTO>>', - 'description' => 'Result<MyPage<MigrationOperationDTO>>', + 'title' => 'Result<InnerListTagResourcesResponse>', + 'description' => 'Result<InnerListTagResourcesResponse>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5F88833', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '', + 'description' => 'Return result', 'type' => 'object', 'properties' => [ - 'pageNumber' => [ - 'title' => '当前页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'title' => '分页大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'totalCount' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'list' => [ - 'title' => '分页数据', - 'description' => '', + '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' => '', + 'description' => 'Resource tag relationships.', 'type' => 'object', 'properties' => [ - 'operationId' => [ - 'title' => '迁移操作ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '183', - ], - 'migrationId' => [ - 'title' => '迁移ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'stageType' => [ - 'title' => '迁移阶段类型', - 'description' => '', - 'type' => 'string', - 'example' => 'CONNECT_NETWORK', - ], - 'operationType' => [ - 'title' => '操作类型,MigrationOperationTypeEnum[IMPORT_TOPIC(导入主题),IMPORT_CONSUMER_GROUP(导入消费者组),CONNECT_NETWORK(网络打通),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(迁移消息),code(编码),desc(描述),param(参数类型),result(结果类型)]', - 'description' => '', - 'type' => 'string', - 'example' => 'IMPORT_CONSUMER_GROUP', - ], - 'operationStatus' => [ - 'title' => '操作状态,MigrationOperationStatusEnum[INIT(未开始),DOING(执行中),DONE(已完成),FAIL(已失败),code(编码),desc(描述)]', - 'description' => '', - 'type' => 'string', - 'example' => 'DOING', - ], - 'operationKey' => [ - 'title' => '操作对象主键', - 'description' => '', - 'type' => 'string', - 'example' => 'xx', - ], - 'businessStatus' => [ - 'title' => '操作业务状态,ConnectNetworkBusinessStatusEnum[CONNECT_PENDING(等待打通),CONNECT_DOING(打通中),CONNECT_SUCCESS(打通成功),CONNECT_FAILURE(打通失败),code,desc]', - 'description' => '', - 'type' => 'string', - 'example' => 'CONNECT_PENDING', - ], - 'operationParam' => [ - 'title' => '操作参数', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'paramData' => [ - 'title' => '参数信息', - 'description' => '', - 'type' => 'any', - 'example' => '[]', - ], - ], - ], - 'operationResult' => [ - 'title' => '操作结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'resultData' => [ - 'title' => '操作结果', - 'description' => '', - 'type' => 'any', - 'example' => '[]', - ], - ], - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2022-08-01 00:00:00', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], + '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' => '', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'The topic already exists.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'consumerGroupId', - ], + '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'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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' => '*'], + ], + ], + ], ], - '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', ], - 'ExecuteMigrationOperation' => [ - 'summary' => 'Executes a specific operation on a specific migration task.', - 'path' => '/migrations/{migrationId}/stages/{stageType}/operations/{operationId}/execute', - 'methods' => [ - 'post', + 'ListTopicSubscriptions' => [ + 'path' => '/instances/{instanceId}/topics/{topicName}/subscriptions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + '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<List<SubscriptionDTO>>', + 'description' => 'Result\\<List>'."\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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '144680', + 'abilityTreeNodes' => ['FEATUREonsXSOU1Y'], ], 'parameters' => [ [ - 'name' => 'migrationId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '44', - ], + 'schema' => ['description' => 'The ID of the instance whose topics you want to query.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'instanceId', + 'name' => 'filter', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-x0r37kelk0o', - ], + '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' => 'stageType', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'example' => 'MIGRATE_METADATA', - ], + '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' => 'operationId', - 'in' => 'path', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2729', - ], + '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' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'messageTypes', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'operationParam' => [ - 'title' => '操作参数', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'paramData' => [ - 'title' => '参数信息', - 'description' => '', - 'type' => 'any', - 'required' => false, - 'example' => '{}', - ], - ], - 'required' => false, - ], + '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<MigrationOperationDTO>', - 'description' => 'Result<MigrationOperationDTO>', + 'title' => 'Result<MyPage<TopicDTO>>', + 'description' => 'Result\\<MyPage>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '814BCD66-2D76-5080-AAD2-E50E5BDB0995', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '', + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'operationId' => [ - 'title' => '迁移操作ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '110', - ], - 'migrationId' => [ - 'title' => '迁移ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'stageType' => [ - 'title' => '迁移阶段类型', - 'description' => '', - 'type' => 'string', - 'example' => 'MIGRATE_METADATA', - ], - 'operationType' => [ - 'title' => '操作类型,MigrationOperationTypeEnum[IMPORT_TOPIC(导入主题),IMPORT_CONSUMER_GROUP(导入消费者组),CONNECT_NETWORK(网络打通),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(迁移消息),code(编码),desc(描述),param(参数类型),result(结果类型)]', - 'description' => '', - 'type' => 'string', - 'example' => 'CONNECT_NETWORK', - ], - 'operationStatus' => [ - 'title' => '操作状态,MigrationOperationStatusEnum[INIT(未开始),DOING(执行中),DONE(已完成),FAIL(已失败),code(编码),desc(描述)]', - 'description' => '', - 'type' => 'string', - 'example' => 'DONE', - ], - 'operationKey' => [ - 'title' => '操作对象主键', - 'description' => '', - 'type' => 'string', - 'example' => 'group01', - ], - 'businessStatus' => [ - 'title' => '操作业务状态,ConnectNetworkBusinessStatusEnum[CONNECT_PENDING(等待打通),CONNECT_DOING(打通中),CONNECT_SUCCESS(打通成功),CONNECT_FAILURE(打通失败),code,desc]', - 'description' => '', - 'type' => 'string', - 'example' => 'MIGRATE_WAIT', - ], - 'operationParam' => [ - 'title' => '操作参数', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'paramData' => [ - 'title' => '参数信息', - 'description' => '', - 'type' => 'any', - 'example' => '{}', - ], - ], - ], - 'operationResult' => [ - 'title' => '操作结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'resultData' => [ - 'title' => '操作结果', - 'description' => '', - 'type' => 'any', - 'example' => '{}', + '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' => '', ], - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', + 'example' => '', ], ], + 'example' => '', ], - 'code' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'The topic already exists.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'instanceId', - ], + '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\\": \\"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', - ], - 'FinishMigrationStage' => [ - 'summary' => '完成当前迁移阶段', - 'path' => '/migrations/{migrationId}/stages/{stageType}/finish', - 'methods' => [ - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREonsNKYZ9K', 'FEATUREonsJEU5XG', 'FEATUREonsYT2OK3'], ], 'parameters' => [ [ - 'name' => 'migrationId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-tl32upjeb08', 'title' => ''], ], [ - 'name' => 'instanceId', + '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' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-pe334f1nx04', - ], + 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => true, 'example' => '2023-05-10 10:42:11', 'title' => ''], ], [ - 'name' => 'stageType', - 'in' => 'path', + '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' => 'CONNECT_NETWORK', + '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' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '16425867-C948-5A0C-9A24-5259727BE727', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => [ - 'title' => '返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidConsumerGroupId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'instanceId', + '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' => '', ], ], ], - '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"}]', - ], - 'CreateDisasterRecoveryPlan' => [ - 'summary' => 'Create Disaster Recovery Plan', - 'path' => '/disaster_recovery', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -10759,18 +7380,24 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225047', - 'abilityTreeNodes' => [ - 'FEATUREonsOVRH1R', - 'FEATUREonsU22PJL', - ], - ], + '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', @@ -10778,413 +7405,200 @@ '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", + '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, - 'enumValueTitles' => [ - 'ACTIVE_ACTIVE' => 'ACTIVE_ACTIVE', - 'ACTIVE_PASSIVE' => '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' => 'ALIYUN_ROCKETMQ', - 'EXTERNAL_ROCKETMQ' => 'EXTERNAL_ROCKETMQ', - ], - 'example' => 'ALIYUN_ROCKETMQ', - ], - 'regionId' => [ - 'title' => '实例所在区域', - 'description' => 'The region where the instance resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - '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' => 'Secondary', - 'ACTIVE' => 'Primary', - ], - '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' => 'No authentication required', - 'ACL_AUTH' => 'ACL authentication', - ], - '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' => 'Virtual Private Cloud', - 'TCP_INTERNET' => 'TCP public network', - ], - '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' => '交换机ID', - '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', - ], - 'propertyValue' => [ - 'description' => 'The attribute value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bbb', - ], - ], - 'required' => false, - ], - '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******', - ], - 'consumerGroupId' => [ - 'description' => 'The ID of the consumer group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GID_DS_XXX_YYY', - ], - ], - 'required' => false, - ], - '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' => 'open', - 'false' => 'close', - ], - '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' => 'open', - 'false' => 'close', - ], - 'example' => 'true', + '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<Long>', - 'description' => 'Result<Long>', + 'title' => 'Result<Void>', + 'description' => 'Result'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => '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, provided only in scenarios where access is denied due to lack of RAM permissions', - 'type' => 'string', - 'example' => 'xxx', - ], + '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\\": \\"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', - 'translator' => 'machine', - ], - 'DeleteDisasterRecoveryPlan' => [ - 'summary' => 'Deletes a global message backup plan.', - 'path' => '/disaster_recovery/{planId}', - 'methods' => [ - 'delete', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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', - ], + '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' => [ - 'description' => 'The ID of the global message backup plan.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + '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<Boolean>', - 'description' => 'The response parameters.'."\n", + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], + '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\\": \\"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', - ], - 'UpdateDisasterRecoveryPlan' => [ - 'summary' => 'Modifies a global message backup plan.', - 'path' => '/disaster_recovery/{planId}', - 'methods' => [ - 'patch', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -11194,994 +7608,373 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225048', - 'abilityTreeNodes' => [ - 'FEATUREonsU22PJL', - ], + 'abilityTreeCode' => '251695', + 'abilityTreeNodes' => ['FEATUREonsOVRH1R'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the global message backup plan.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['description' => 'Backup Plan ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13000000xx', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + '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' => [ - 'description' => 'The request body.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Response Result', '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' => '实例ID', - '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' => '', - ], - '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_INTERNET' => '', - ], - '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' => '交换机ID', - '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', - ], - 'propertyValue' => [ - 'description' => 'The attribute value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bbb', - ], - ], - 'required' => false, - ], - '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", - ], - 'consumerGroupId' => [ - 'description' => 'The consumer group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GID_DS_XXX_YYY', - ], - ], - 'required' => false, - ], - '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', - ], + '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' => ''], ], - 'required' => false, ], ], ], + '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<Boolean>', - 'description' => 'The response parameters.'."\n", + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], + '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\\": \\"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', - ], - 'ListDisasterRecoveryPlans' => [ - 'summary' => 'Queries Global Replicator tasks.', - 'path' => '/disaster_recovery', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225050', - 'abilityTreeNodes' => [ - 'FEATUREonsOVRH1R', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-778xxx', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'filter', + 'name' => 'resourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The filter condition. Global Replicator tasks are filtered by task name or description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + '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' => 'pageNumber', + 'name' => 'resourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The resource IDs, in the JSON format.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-pe3355cs707'], ], [ - 'name' => 'pageSize', + 'name' => 'tagKey', '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', - ], + '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<MyPage<DisasterRecoveryPlanDTO>>', - 'description' => 'The response parameters.'."\n", + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => '计划ID', - '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' => '计划类型,DisasterRecoveryTypeEnum[ACTIVE_PASSIVE(灾备),ACTIVE_ACTIVE(双活),code,desc]', - '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' => '计划状态,DisasterRecoveryStatusEnum[CREATED(已创建),DELETED(已删除),code,desc]', - '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', - ], - ], - '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' => '实例ID', - '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' => '交换机ID', - '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', - ], - 'propertyValue' => [ - 'description' => 'The attribute value.'."\n", - 'type' => 'string', - 'example' => 'bbb', - ], - ], - ], - 'securityGroupId' => [ - 'description' => 'The security group ID.'."\n", - 'type' => 'string', - 'example' => 'sg-bp17hpmgz9******'."\n", - ], - 'consumerGroupId' => [ - 'description' => 'The ID of the consumer group.'."\n", - 'type' => 'string', - 'example' => 'GID_ui_xxx', - ], - ], - ], - ], - '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', - ], - ], - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], + '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\\": \\"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_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', - 'translator' => 'machine', - ], - 'GetDisasterRecoveryPlan' => [ - 'summary' => 'Queries the details of a Global Replicator task.', - 'path' => '/disaster_recovery/{planId}', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '225054', - 'abilityTreeNodes' => [ - 'FEATUREonsOVRH1R', - ], + 'abilityTreeCode' => '144683', + 'abilityTreeNodes' => ['FEATUREonsTBTXFL'], ], 'parameters' => [ [ - 'name' => 'planId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the Global Replicator task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'schema' => ['description' => 'The ID of the instance to which the consumer group belongs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rmq-cn-7e22on9****'], ], - ], - 'responses' => [ - 200 => [ + [ + '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' => [ - 'title' => 'Result<DisasterRecoveryPlanDTO>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", + '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', - 'example' => '7358418D-83BD-507A-8079-611C63E0xxx', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'deprecated' => true, + 'required' => false, + 'enum' => ['Concurrently', 'Orderly'], + 'title' => '', + 'example' => 'Concurrently', ], - 'data' => [ - 'title' => '返回结果', - 'description' => 'The returned data.'."\n", + 'consumeRetryPolicy' => [ + 'title' => '', + 'description' => 'The updated consumption retry policy for the consumer group. For more information, see'."\n" + .'[Consumption retry](~~440356~~).', 'type' => 'object', 'properties' => [ - 'planId' => [ - 'title' => '计划ID', - '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' => '计划类型,DisasterRecoveryTypeEnum[ACTIVE_PASSIVE(灾备),ACTIVE_ACTIVE(双活),code,desc]', - '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' => '计划状态,DisasterRecoveryStatusEnum[CREATED(已创建),DELETED(已删除),code,desc]', - '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", - ], - ], - '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' => '实例ID', - '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' => '交换机ID', - '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', - ], - 'propertyValue' => [ - 'description' => 'The attribute value.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - ], - ], - 'securityGroupId' => [ - 'description' => 'The security group ID.'."\n", - 'type' => 'string', - 'example' => 'sg-bp17hpmgz9******'."\n", - ], - 'consumerGroupId' => [ - 'description' => 'The consumer Group ID.', - 'type' => 'string', - 'example' => 'GID_DS_XXX_YYY', - ], - ], - ], - ], - '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" + 'retryPolicy' => [ + 'description' => 'The retry policy. For more information, see [Message retry](~~440356~~).'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'syncCheckpointEnabled' => [ - 'description' => 'Indicates whether consumer progress synchronization is enabled.'."\n" - ."\n" - .'Valid values:'."\n" + .'- FixedRetryPolicy: fixed interval retry. This policy applies only to orderly messages.'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', + .'- 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' => '', ], - 'code' => [ - 'title' => '错误码', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], + 'maxReceiveTps' => ['description' => 'The maximum transactions per second (TPS) for message consumption.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - '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', - ], - 'AddDisasterRecoveryItem' => [ - 'summary' => 'Adds a topic mapping to a Global Replicator task.', - 'path' => '/disaster_recovery/{planId}/items', - 'methods' => [ - 'post', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result\\<boolean>', + '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' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => '><notice>'."\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" + .'></notice>', + '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' => [], @@ -12193,178 +7986,122 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '225043', - 'abilityTreeNodes' => [ - 'FEATUREonsOVRH1R', - 'FEATUREonsU22PJL', - ], + 'abilityTreeCode' => '263691', + 'abilityTreeNodes' => ['FEATUREonsOVRH1R', 'FEATUREonsU22PJL'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', - 'schema' => [ - 'description' => 'Backup plan ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], + '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' => 'Request body structure. Required.', + 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ 'topics' => [ - 'title' => '容灾Item所包含的容灾主题', - 'description' => 'Topics included in the backup mapping. Required.', + 'description' => 'The topics involved in the topic mapping.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'Topics included in the backup mapping', + 'description' => 'The topic involved in the topic mapping.'."\n", 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'regionId' => ['description' => 'The region ID.'."\n", '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', + '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' => 'ALIYUN_ROCKETMQ', - 'EXTERNAL_ROCKETMQ' => 'EXTERNAL_ROCKETMQ', - ], + 'enumValueTitles' => ['ALIYUN_ROCKETMQ' => '阿里云实例', 'EXTERNAL_ROCKETMQ' => '外部实例'], 'example' => 'ALIYUN_ROCKETMQ'."\n", + 'title' => '', ], - '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, - ], + '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, - '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', + 'enumValueTitles' => ['Concurrently' => '并发投递', 'Orderly' => '顺序投递'], 'example' => 'Concurrently', + 'title' => '', ], ], 'required' => false, + 'title' => '', ], 'required' => false, + 'title' => '', ], ], 'required' => false, + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", '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', - ], - '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', - ], + '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\\": \\"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', - 'translator' => 'machine', - ], - 'UpdateDisasterRecoveryItem' => [ + '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.', - 'path' => '/disaster_recovery/{planId}/items/{itemId}', - 'methods' => [ - 'patch', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDisasterRecoveryItem'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -12376,34 +8113,14 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '263691', - 'abilityTreeNodes' => [ - 'FEATUREonsOVRH1R', - 'FEATUREonsU22PJL', - ], + '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', - ], - ], - [ - 'name' => 'itemId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the topic mapping.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100070284', - ], + 'schema' => ['description' => 'The ID of the global message backup plan.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016', 'title' => ''], ], [ 'name' => 'body', @@ -12413,172 +8130,314 @@ 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'topics' => [ - 'description' => 'The topics involved in the topic mapping.'."\n", + '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 topic involved in the topic mapping.'."\n", + 'description' => 'The instance involved in the Global Replicator task.'."\n", 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], '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'."\n", - ], - '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', + 'enumValueTitles' => ['ALIYUN_ROCKETMQ' => '阿里云实例', 'EXTERNAL_ROCKETMQ' => '外部实例'], + 'example' => 'ALIYUN_ROCKETMQ', ], - 'topicName' => [ - 'description' => 'The topic name. You must specify this parameter.'."\n", + '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, - 'example' => 'Topic_xxx', + 'enumValueTitles' => ['PASSIVE' => '备', 'ACTIVE' => '主'], + 'example' => 'ACTIVE', ], - 'consumerGroupId' => [ - 'description' => 'The ID of the consumer group. If you use the two-way backup mode, you must specify this parameter.'."\n", + '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, - 'example' => 'GID_xxx', - 'deprecated' => true, + 'enumValueTitles' => ['NO_AUTH' => '无须认证', 'ACL_AUTH' => 'acl认证'], + 'example' => 'NO_AUTH', ], - 'deliveryOrderType' => [ - 'description' => 'The method used to deliver messages to the destination instance.'."\n" - ."\n" - .'Valid values:'."\n" + '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" - .'* Concurrently: concurrent delivery'."\n" - .'* Orderly: ordered delivery'."\n", + .'* TCP_INTERNET: Internet over TCP'."\n" + .'* TCP_VPC: virtual private cloud (VPC) over TCP.'."\n", 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Concurrently' => '', - 'Orderly' => '', + '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' => ''], ], - 'example' => 'Concurrently', + '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' => 'Schema of Response', + 'title' => 'Result<Boolean>', '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', - ], - 'data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => 'The dynamic error code.'."\n", - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], + '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\\": \\"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', - ], - 'DeleteDisasterRecoveryItem' => [ - 'summary' => 'Deletes a topic mapping of a Global Replicator task.', - 'path' => '/disaster_recovery/{planId}/items/{itemId}', - 'methods' => [ - 'delete', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'planId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'Backup plan ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['description' => 'The ID of the instance to update.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'itemId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Backup mapping task ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100000650', + '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" + .'<props="intl">This parameter is not yet in effect. Message tracing is enabled by default for all instances.</props>'."\n" + .'<props="china">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~~).</props>'."\n" + .'<props="china">This parameter does not apply to pay-as-you-go and subscription instances. The message trace feature is enabled by default for these instances.</props>', + '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' => '', ], ], ], @@ -12586,1126 +8445,464 @@ 200 => [ 'schema' => [ 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => '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', - ], + '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\\": \\"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', - ], - 'StartDisasterRecoveryItem' => [ - 'summary' => 'Starts a topic mapping of a Global Replicator task.', - 'path' => '/disaster_recovery/{planId}/items/{itemId}/start', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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' => '><notice>'."\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" + .'></notice>', + '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' => 'planId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'Backup plan ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ - 'name' => 'itemId', + 'name' => 'username', 'in' => 'path', + 'schema' => ['description' => 'The name of the account.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'accountStatus', + 'in' => 'query', 'schema' => [ - 'description' => 'Mapping task ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100000704', + '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<Boolean>', - 'description' => 'Result<Boolean>', + 'description' => 'The data returned for the request.', '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', - ], + '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\\": \\"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', - 'translator' => 'machine', - ], - 'StopDisasterRecoveryItem' => [ - 'summary' => 'Stops a topic mapping of a Global Replicator task.', - 'path' => '/disaster_recovery/{planId}/items/{itemId}/stop', - 'methods' => [ - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'planId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'Backup plan ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****', 'title' => ''], ], [ - 'name' => 'itemId', + 'name' => 'username', 'in' => 'path', - 'schema' => [ - 'description' => 'Mapping task ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100070284', - ], + 'schema' => ['description' => 'The username.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'description' => 'The request body.'."\n", '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', + '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', - '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', + 'required' => true, + 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], + 'example' => 'Topic', ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => 'Dynamic error code', - 'type' => 'string', - 'example' => 'InstanceId', + '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' => '', ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => 'Dynamic error message', + 'decision' => [ + 'title' => '', + 'description' => 'The decision result of the authorization.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Deny'."\n" + .'* Allow'."\n", 'type' => 'string', - 'example' => 'instanceId', + 'required' => false, + 'enumValueTitles' => ['Deny' => '拒绝访问', 'Allow' => '允许访问'], + 'example' => 'Allow', ], - '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', + '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, ], ], - ], - ], - ], - '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', - 'translator' => 'machine', - ], - 'ListDisasterRecoveryItems' => [ - 'summary' => 'Queries the Global Replicator tasks of an instance.', - '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', - ], - ], - [ - 'name' => 'topicName', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'type' => 'string', 'required' => false, - 'description' => 'The topic name.'."\n", - 'example' => 'topic-test920', - ], - ], - [ - 'name' => 'filter', - 'in' => 'query', - 'schema' => [ - 'description' => 'The filter condition. Topics are filtered by topic name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'topic_test', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - '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<MyPage<DisasterRecoveryItemDTO>>', - 'description' => 'The response parameters.'."\n", + 'title' => 'Result<Boolean>', + 'description' => 'Result'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], - 'planId' => [ - 'title' => '容灾Item所在容灾计划ID', - 'description' => 'The ID of the topic mapping.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1300000016', - ], - 'itemStatus' => [ - 'title' => '容灾Item状态,DisasterRecoveryItemStatusEnum[CREATING(创建中),CHANGING(变更中),RUNNING(运行中),MANUAL_STOPPED(人工停用),OVERDUE_STOPPED(欠费停用),code,desc]', - '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' => '容灾Item所包含的容灾主题', - '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', - ], - 'instanceType' => [ - 'title' => '实例类型', - 'description' => 'The instance type.'."\n", - 'type' => 'string', - 'example' => 'ALIYUN_ROCKETMQ', - ], - 'instanceId' => [ - 'title' => '实例ID', - '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' => '消费者组ID', - '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', - ], - ], - ], - ], - 'extInfo' => [ - 'title' => '扩展信息', - 'description' => 'The extended information.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The extended information.'."\n", - 'example' => '{}', - ], - ], - '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', - ], - ], - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], + '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'], ], ], ], ], - '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', - 'translator' => 'machine', - ], - 'GetDisasterRecoveryItem' => [ - 'summary' => 'Queries the details of a topic mapping in a Global Replicator task.', - 'path' => '/disaster_recovery/{planId}/items/{itemId}', - 'methods' => [ - 'get', + 'title' => 'UpdateInstanceAcl', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceAcl'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '225053', - 'abilityTreeNodes' => [ - 'FEATUREonsOVRH1R', - ], + 'abilityTreeCode' => '144678', + 'abilityTreeNodes' => ['FEATUREonsCON1A8'], ], 'parameters' => [ [ - 'name' => 'planId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the global message backup plan.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['title' => '实例ID', 'description' => 'The ID of the instance that contains the topic.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'itemId', + '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' => [ - 'description' => 'The ID of the topic mapping.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100070284', + '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<DisasterRecoveryItemDTO>', - 'description' => 'Result<DisasterRecoveryItemDTO>', + 'title' => 'Result<Boolean>', + 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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', - ], - 'planId' => [ - 'title' => '容灾Item所在容灾计划ID', - 'description' => 'The ID of the global message backup plan.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1300000016', - ], - 'itemStatus' => [ - 'title' => '容灾Item状态,DisasterRecoveryItemStatusEnum[CREATING(创建中),CHANGING(变更中),RUNNING(运行中),MANUAL_STOPPED(人工停用),OVERDUE_STOPPED(欠费停用),code,desc]', - 'description' => 'The topic mapping task status.', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'topics' => [ - 'title' => '容灾Item所包含的容灾主题', - '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', - ], - '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' => '实例ID', - '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' => '消费者组ID', - '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' => 'Concurrently', - 'Orderly' => 'Orderly', - ], - 'example' => 'Concurrently', - ], - ], - ], - ], - 'extInfo' => [ - 'title' => '扩展信息', - 'description' => 'Additional Information', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{}', - 'description' => 'Additional Information', - ], - ], - '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' => 'HTTP状态码', - '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' => '访问拒绝详细信息，有且仅有在因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.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], + '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\\": {\\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', - ], - 'ListDisasterRecoveryCheckpoints' => [ - 'summary' => 'Queries consumer progress synchronization tasks.', - 'path' => '/disaster_recovery/{planId}/items/{itemId}/checkpoints', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '251690', - 'abilityTreeNodes' => [ - 'FEATUREonsOVRH1R', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'planId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '备份计划ID', - 'description' => 'Backup Plan ID', - 'type' => 'string', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-i7m2vc1vx01', 'title' => ''], ], [ - 'name' => 'itemId', + 'name' => 'topicName', 'in' => 'path', - 'schema' => [ - 'title' => '备份映射ID', - 'description' => 'Backup Mapping ID', - 'type' => 'string', - 'required' => true, - 'example' => '100070284', - ], + 'schema' => ['description' => 'The topic name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'delay_topic', 'title' => ''], ], [ - 'name' => 'instanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '源实例ID', - 'description' => 'Source Instance ID', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'name' => 'messageId', + 'in' => 'path', + 'schema' => ['description' => 'The message ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'A9FE190A59AA421ED014743DFDBF017D', 'title' => ''], ], [ - 'name' => 'filter', + 'name' => 'consumerGroupId', 'in' => 'query', - 'schema' => [ - 'title' => '过滤条件', - 'description' => 'Filter Condition', - 'type' => 'string', - 'required' => false, - 'example' => 'topic_test', - ], + 'schema' => ['description' => 'The ID of the consumer group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'TEST_FINANCE_STOCK_OUT_GROUP', 'title' => ''], ], [ - 'name' => 'pageNumber', + 'name' => 'clientId', 'in' => 'query', - 'schema' => [ - 'description' => 'Current page number, starting from 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'Page size, the maximum number of results returned per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The client ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'zeekr-settlement-server-dc555456f-v2lcg@1@1@qfvorazqns', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Response Result', + 'title' => 'Result<Boolean>', + 'description' => 'The result.'."\n", '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', - ], - 'data' => [ - 'description' => 'Response Data', - 'type' => 'object', - 'properties' => [ - 'pageNumber' => [ - 'description' => 'Current page number', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => 'Page size', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'totalCount' => [ - 'description' => 'Total number of records', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'list' => [ - 'description' => 'Paged data', - 'type' => 'array', - 'items' => [ - 'description' => 'Paged data', - 'type' => 'object', - 'properties' => [ - 'planId' => [ - 'description' => 'Backup Plan ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13000000xx', - ], - 'itemId' => [ - 'description' => 'Backup Mapping ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000000xx', - ], - 'checkpointId' => [ - 'description' => 'Consumption Progress ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000000xx', - ], - 'lastSyncTime' => [ - 'description' => 'Last synchronization time', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1740724080343', - ], - 'sourceProgress' => [ - 'description' => 'Source consumption progress', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'description' => 'Instance ID', - 'type' => 'string', - 'example' => 'rmq-cn-3mp3vblzxxx', - ], - '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', - ], - 'consumerGroupId' => [ - 'description' => 'Consumer Group ID', - 'type' => 'string', - 'example' => 'GID_TEST', - ], - 'topicName' => [ - 'description' => 'The topic name.'."\n", - 'type' => 'string', - 'example' => 'TOPIC_TEST', - ], - 'lastFetchTime' => [ - 'description' => 'Last fetch time', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1740724080343', - ], - 'progressData' => [ - 'description' => 'Consumption progress data', - 'type' => 'object', - 'properties' => [ - 'consumeTimestamp' => [ - 'description' => 'Latest consumption time', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1740724080343', - ], - ], - ], - ], - ], - 'targetProgress' => [ - 'description' => 'Target consumption progress', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'description' => 'Instance ID', - 'type' => 'string', - 'example' => 'rmq-cn-nwy3i065xxx', - ], - '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', - ], - 'consumerGroupId' => [ - 'description' => 'Consumer group ID', - 'type' => 'string', - 'example' => 'GID_TEST', - ], - 'topicName' => [ - 'description' => 'Topic name', - 'type' => 'string', - 'example' => 'TOPIC_TEST', - ], - 'lastFetchTime' => [ - 'description' => 'Latest fetch time', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1740724080343', - ], - 'progressData' => [ - 'description' => 'Consumption progress data', - 'type' => 'object', - 'properties' => [ - 'consumeTimestamp' => [ - 'description' => 'Latest consumption time', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1740724080343', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'code' => [ - 'description' => 'Error code', - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'description' => 'Error message', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'description' => 'HTTP status code', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => 'Dynamic error code', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], + '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'], ], ], ], ], - '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', - 'translator' => 'machine', - ], - 'SyncDisasterRecoveryCheckpoint' => [ - 'summary' => 'Synchronize Disaster Recovery Plan Consumption Progress', - 'path' => '/disaster_recovery/{planId}/items/{itemId}/checkpoints/{checkpointId}', - 'methods' => [ - 'post', + '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'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -13715,1430 +8912,1203 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '251695', - 'abilityTreeNodes' => [ - 'FEATUREonsOVRH1R', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREonsB0E8FD'], ], 'parameters' => [ [ - 'name' => 'planId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'Backup Plan ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13000000xx', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-wwo32kqfm10', 'title' => ''], ], [ - 'name' => 'itemId', + 'name' => 'topicName', 'in' => 'path', - 'schema' => [ - 'description' => 'Mapping ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13000000xx', - ], + 'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'required' => true, 'example' => 'card_status_topic', 'title' => ''], ], [ - 'name' => 'checkpointId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Consumption Progress ID', - 'type' => 'integer', - 'format' => 'int64', + '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, - 'example' => '13000000xx', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Response Result', + 'title' => 'Result<String>', + 'description' => 'The response data.', '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', - ], - 'data' => [ - 'description' => 'Result Data', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'description' => 'Error Code', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'description' => 'Error Message', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'description' => 'HTTP Status Code', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'description' => 'Dynamic Error Code', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], + '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' => '', ], ], ], - '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', - 'translator' => 'machine', - ], - 'ListTagResources' => [ - 'summary' => 'Queries the tags that are added to resources.', - 'path' => '/resourceTag/list', - 'methods' => [ - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + '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'], + ], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + '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}'], + ], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', + ], + ], + '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'], + ], ], - 'parameters' => [ - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域ID。', - 'description' => 'Region ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + ], + '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}'], ], ], - [ - 'name' => 'resourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型。', - 'description' => 'Resource type.', - 'type' => 'string', - 'required' => true, - 'example' => 'instance', + ], + [ + '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}'], ], ], - [ - 'name' => 'resourceId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源ID列表，JSON格式。', - 'description' => 'List of resource IDs, in JSON format.', - 'type' => 'string', - 'required' => false, - 'example' => '["rmq-cn-pe334n08h08"]', + ], + [ + '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}'], ], ], - [ - 'name' => 'tag', - 'in' => 'query', - 'schema' => [ - 'title' => '标签列表，JSON格式。', - 'description' => 'List of tags, in JSON format.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"key": "rmq-test", "value": "test"}]', + ], + [ + '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}'], ], ], - [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '下一个查询开始的位置。', - 'description' => 'The position from which the next query starts.', - 'type' => 'string', - 'required' => false, - 'example' => 'd09e2b63e1b12d905b7080ff70', + ], + [ + '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}'], ], ], - [ - 'name' => 'resourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmx7caj******', + ], + [ + '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}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<InnerListTagResourcesResponse>', - 'description' => 'Result<InnerListTagResourcesResponse>', - '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', - ], - 'requestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'F00C6A70-C782-5DD6-9D11-0CFC710100C7', - ], - 'tagResources' => [ - 'description' => 'Resource tag relationships.', - 'type' => 'array', - 'items' => [ - 'description' => 'Resource tag relationships.', - 'type' => 'object', - 'properties' => [ - 'resourceType' => [ - 'description' => 'Resource type.', - 'type' => 'string', - 'example' => 'instance', - ], - 'tagValue' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => 'value', - ], - 'resourceId' => [ - 'description' => 'Resource ID.', - 'type' => 'string', - 'example' => 'rmq-cn-pe334n08h08', - ], - 'tagKey' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'key', - ], - 'category' => [ - 'description' => 'Tag category.', - 'type' => 'string', - 'example' => 'custom', - ], - 'scope' => [ - 'description' => 'Visibility scope.', - 'type' => 'string', - 'example' => 'public', - ], - 'aliUid' => [ - 'description' => 'UID of the resource owner.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1876441048322426', - ], - ], - ], - ], - ], - ], - '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', - ], - ], + [ + '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}'], ], ], ], - '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', - 'translator' => 'machine', - ], - 'TagResources' => [ - 'summary' => 'Creates resource tags.', - 'path' => '/resourceTag/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + [ + '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}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + '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}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + '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}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域ID。', - 'description' => 'The region ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + '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}'], ], ], - [ - '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', + ], + [ + '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}'], ], ], - [ - 'name' => 'resourceId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源ID列表，JSON格式。', - 'description' => 'The resource IDs, in the JSON format.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-pe3355cs707', + ], + [ + '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}'], ], ], - [ - 'name' => 'tag', - 'in' => 'query', - 'schema' => [ - 'title' => '标签列表，JSON格式。', - 'description' => 'tag, in JSON format.', - 'type' => 'string', - 'required' => true, - 'example' => '[{"key": "rmq-test", "value": "test"}]', + ], + [ + 'apiName' => 'ListDisasterRecoveryCheckpoints', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'rocketmq:ListDisasterRecoveryCheckpoints', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => 'HTTP状态码', - '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', - ], - ], + [ + '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}'], ], ], ], - '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', - ], - 'UntagResources' => [ - 'summary' => 'Removes tags from resources.', - 'path' => '/resourceTag/delete', - 'methods' => [ - 'delete', + [ + '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/*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + '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}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + '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}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'TagResources', + 'description' => '', 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rocketmq:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域ID。', - 'description' => 'The region ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + '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}'], ], ], - [ - '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', + ], + [ + '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}'], ], ], - [ - 'name' => 'resourceId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源ID列表，JSON格式。', - 'description' => 'The resource IDs, in the JSON format.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-pe3355cs707', + ], + [ + '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}'], ], ], - [ - 'name' => 'tagKey', - 'in' => 'query', - 'schema' => [ - 'title' => '标签键列表，JSON格式。', - 'description' => 'The keys of tags.', - 'type' => 'string', - 'required' => false, - 'example' => '["key1", "key2"]', + ], + [ + '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}'], ], ], - [ - 'name' => 'all', - 'in' => 'query', - 'schema' => [ - 'title' => '是否删除所有标签。', - 'description' => 'Whether to delete all tags.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ], + [ + '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}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => 'HTTP状态码', - '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', - ], - ], + [ + '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}'], ], ], ], - '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', - ], - 'ChangeResourceGroup' => [ - 'summary' => 'Changes the resource group to which a ApsaraMQ for RocketMQ instance belongs.', - 'path' => '/resourceGroup/change', - 'methods' => [ - 'post', + [ + 'apiName' => 'ListTagResources', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'rocketmq:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + '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}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + '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}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + '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' => '*'], + ], + ], ], - '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******', + [ + '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}'], ], ], - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the instance resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + ], + [ + '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}'], ], ], - [ - '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', + ], + [ + '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/*'], ], ], - [ - '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****', + ], + [ + 'apiName' => 'ListMigrations', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'rocketmq:ListMigrations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - ], - 'data' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'description' => 'The error code returned if the call failed.'."\n", - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'description' => 'The dynamic error code.'."\n", - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => 'The dynamic error message.'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], - ], + [ + '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}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + '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}'], + ], + ], ], - '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', - ], - 'GetConsumeTimespan' => [ - 'summary' => 'Queries the time range within which the consumer offset in a topic can be reset.', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeTimespan/{topicName}', - 'methods' => [ - 'get', + [ + '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}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + '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}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + '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}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetInstanceAccount', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREons0MOUAZ', + 'ramAction' => [ + 'action' => 'rocketmq:GetInstanceAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', + [ + '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}'], ], ], - [ - 'name' => 'consumerGroupId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CID-TEST', + ], + [ + '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}'], ], ], - [ - 'name' => 'topicName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'topicxxx', + ], + [ + '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}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Result', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80', - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'instanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'topic_test', - ], - 'consumerGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CID-TEST', - ], - 'minTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026222', - ], - 'maxTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026833', - ], - 'consumeTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026400', - ], - ], - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxx', - ], - 'dynamicMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxx', - ], - ], + [ + '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}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + '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}'], + ], + ], ], - '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"}]', - 'title' => 'GetConsumeTimespan', - ], - 'ListRegions' => [ - 'summary' => 'Queries regions in which ApsaraMQ for RocketMQ is available.', - 'path' => '/regions', - 'methods' => [ - 'get', + [ + '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}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + '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}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListDisasterRecoveryPlans', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rocketmq:ListDisasterRecoveryPlans', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + '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}'], + ], + ], ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<List<RegionDTO>>', - 'description' => 'Result\\<List>'."\n", - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => 'regionId,类似 cn-hangzhou', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'regionName' => [ - 'title' => '中文region，类似杭州', - 'description' => 'The region name.'."\n", - 'type' => 'string', - 'example' => 'hangzhou', - ], - 'supportRocketmqV5' => [ - 'title' => '是否开通新服 v5版本', - 'description' => 'Indicates whether ApsaraMQ for RocketMQ V5 is activated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'supportRocketmqV4' => [ - 'title' => '是否开通旧服 v4版本', - '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', - ], - 'tagValue' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'any', - 'example' => 'xx', - ], - ], - ], - ], - ], - ], - ], - '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' => 'HTTP状态码', - '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', - ], - ], + [ + '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/*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + '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}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B962390-D84B-5D44-8C11-79DF40299D41\\",\\n \\"success\\": true,\\n \\"data\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"regionName\\": \\"杭州\\",\\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', - ], - 'ListAvailableZones' => [ - 'summary' => 'Queries the supported zones.', - 'path' => '/zones', - 'methods' => [ - 'get', + [ + '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}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + '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}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + '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}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + '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}'], + ], + ], ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<List<ZoneDTO>>', - 'description' => 'Result<List<ZoneDTO>>', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - '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' => '可用区id', - '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', - ], - ], - ], - ], - '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' => 'HTTP状态码', - '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', - ], - ], + [ + '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}'], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + [ + '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}'], + ], + ], ], - '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', - ], - 'ListMetricMeta' => [ - 'summary' => 'Query Monitoring Items List', - 'path' => '/monitor/metrics/meta', - 'methods' => [ - 'get', + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rocketmq:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + '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}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + '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}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + '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/*'], + ], + ], ], - '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', + [ + '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}'], ], ], - [ - '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', + ], + [ + '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}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<MyPage<MetricMetaDTO>>', - 'description' => 'Result<MyPage<MetricMetaDTO>>', - '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', - ], - ], - ], - ], - ], - ], - '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', - ], - ], + [ + '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}'], ], ], ], - '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\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', - 'title' => 'ListMetricMeta', - 'translator' => 'machine', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'rocketmq.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'rocketmq.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'rocketmq.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhengzhou-jva', - 'endpoint' => 'rocketmq.cn-zhengzhou-jva.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'rocketmq.cn-huhehaote.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'rocketmq.cn-wulanchabu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'rocketmq.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'rocketmq.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-nanjing', - 'endpoint' => 'rocketmq.cn-nanjing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fuzhou', - 'endpoint' => 'rocketmq.cn-fuzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'rocketmq.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan', - 'endpoint' => 'rocketmq.cn-heyuan.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'rocketmq.cn-guangzhou.aliyuncs.com ', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'rocketmq.cn-chengdu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'rocketmq.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'rocketmq.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'rocketmq.ap-northeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'rocketmq.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'rocketmq.ap-southeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'rocketmq.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'rocketmq.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'rocketmq.ap-southeast-6.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'rocketmq.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'rocketmq.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'rocketmq.eu-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'rocketmq.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'rocketmq.ap-south-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'rocketmq.me-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'rocketmq.cn-hangzhou-finance.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'rocketmq.cn-shanghai-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'rocketmq.cn-shenzhen-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'rocketmq.ap-southeast-7.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'rocketmq.cn-beijing-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'rocketmq.me-central-1.aliyuncs.com', ], - [ - 'regionId' => 'na-south-1', - 'endpoint' => 'rocketmq.na-south-1.aliyuncs.com', + '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/*'], ], ], ]; |