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/zh_cn/rocketmq/2022-08-01/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/zh_cn/rocketmq/2022-08-01/api-docs.php')
| -rw-r--r-- | data/zh_cn/rocketmq/2022-08-01/api-docs.php | 18920 |
1 files changed, 6666 insertions, 12254 deletions
diff --git a/data/zh_cn/rocketmq/2022-08-01/api-docs.php b/data/zh_cn/rocketmq/2022-08-01/api-docs.php index 3d5d966..7faf5e5 100644 --- a/data/zh_cn/rocketmq/2022-08-01/api-docs.php +++ b/data/zh_cn/rocketmq/2022-08-01/api-docs.php @@ -1,186 +1,71 @@ <?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' => '实例', + 'children' => ['CreateTopic', 'UpdateTopic', 'DeleteTopic'], 'type' => 'directory', - 'children' => [ - 'CreateInstance', - 'UpdateInstance', - 'DeleteInstance', - 'ListInstances', - 'GetInstance', - ], - ], - [ - 'id' => 322715, 'title' => '主题', - 'type' => 'directory', - 'children' => [ - 'CreateTopic', - 'UpdateTopic', - 'DeleteTopic', - 'ListTopics', - 'GetTopic', - ], + 'id' => 90501, ], [ - 'id' => 322721, - 'title' => '消费者分组', + 'children' => ['ListConsumerGroups', 'GetConsumerGroup'], 'type' => 'directory', - 'children' => [ - 'CreateConsumerGroup', - 'UpdateConsumerGroup', - 'DeleteConsumerGroup', - 'ListConsumerGroups', - 'GetConsumerGroup', - ], + 'title' => '消费者分组', + 'id' => 90488, ], [ - 'id' => 322727, - 'title' => '订阅关系', + 'children' => ['ListTopicSubscriptions', 'ListConsumerGroupSubscriptions', 'GetConsumerGroupSubscription', 'DeleteConsumerGroupSubscription'], 'type' => 'directory', - 'children' => [ - 'ListTopicSubscriptions', - 'ListConsumerGroupSubscriptions', - 'GetConsumerGroupSubscription', - 'DeleteConsumerGroupSubscription', - ], + 'title' => '订阅关系', + 'id' => 90568, ], [ - 'id' => 322732, - 'title' => '消费', + 'children' => ['ListConsumerConnections', 'GetConsumerGroupLag', 'GetConsumerStack', 'ResetConsumeOffset'], 'type' => 'directory', - 'children' => [ - 'ListConsumerConnections', - 'GetConsumerGroupLag', - 'GetConsumerStack', - 'ResetConsumeOffset', - ], + 'title' => '消费', + 'id' => 90513, ], [ - 'id' => 322737, - 'title' => '消息', + 'children' => ['ListMessages', 'GetMessageDetail', 'VerifySendMessage', 'VerifyConsumeMessage'], 'type' => 'directory', - 'children' => [ - 'ListMessages', - 'GetMessageDetail', - 'VerifySendMessage', - 'VerifyConsumeMessage', - ], + 'title' => '消息', + 'id' => 90528, ], [ - 'id' => 322742, - 'title' => '轨迹', + 'children' => ['CreateInstanceAccount', 'UpdateInstanceAccount', 'DeleteInstanceAccount', 'ListInstanceAccount', 'GetInstanceAccount', 'CreateInstanceAcl', 'UpdateInstanceAcl', 'DeleteInstanceAcl', 'ListInstanceAcl', 'GetInstanceAcl', 'CreateInstanceIpWhitelist', 'DeleteInstanceIpWhitelist', 'ListInstanceIpWhitelist', 'GetInstanceIpWhitelist'], 'type' => 'directory', - 'children' => [ - 'ListTraces', - 'GetTrace', - ], - ], - [ - 'id' => 322745, 'title' => 'ACL', - 'type' => 'directory', - 'children' => [ - 'CreateInstanceAccount', - 'UpdateInstanceAccount', - 'DeleteInstanceAccount', - 'ListInstanceAccount', - 'GetInstanceAccount', - 'CreateInstanceAcl', - 'UpdateInstanceAcl', - 'DeleteInstanceAcl', - 'ListInstanceAcl', - 'GetInstanceAcl', - 'CreateInstanceIpWhitelist', - 'DeleteInstanceIpWhitelist', - 'ListInstanceIpWhitelist', - 'GetInstanceIpWhitelist', - ], - ], - [ - 'id' => 322760, - 'title' => '迁移上云', - 'type' => 'directory', - 'children' => [ - 'ListMigrations', - 'ListMigrationOperations', - 'ExecuteMigrationOperation', - 'FinishMigrationStage', - ], + 'id' => 90551, ], [ - 'id' => 322765, - 'title' => 'Global Replicator', + 'children' => ['ListMigrations', 'ListMigrationOperations', 'ExecuteMigrationOperation', 'FinishMigrationStage'], 'type' => 'directory', - 'children' => [ - 'CreateDisasterRecoveryPlan', - 'DeleteDisasterRecoveryPlan', - 'UpdateDisasterRecoveryPlan', - 'ListDisasterRecoveryPlans', - 'GetDisasterRecoveryPlan', - 'AddDisasterRecoveryItem', - 'UpdateDisasterRecoveryItem', - 'DeleteDisasterRecoveryItem', - 'StartDisasterRecoveryItem', - 'StopDisasterRecoveryItem', - 'ListDisasterRecoveryItems', - 'GetDisasterRecoveryItem', - 'ListDisasterRecoveryCheckpoints', - 'SyncDisasterRecoveryCheckpoint', - ], + 'title' => '迁移上云', + 'id' => 162078, ], [ - 'id' => 322780, - 'title' => '标签', + 'children' => ['CreateDisasterRecoveryPlan', 'DeleteDisasterRecoveryPlan', 'UpdateDisasterRecoveryPlan', 'ListDisasterRecoveryPlans', 'GetDisasterRecoveryPlan', 'AddDisasterRecoveryItem', 'UpdateDisasterRecoveryItem', 'DeleteDisasterRecoveryItem', 'StartDisasterRecoveryItem', 'StopDisasterRecoveryItem', 'ListDisasterRecoveryItems', 'GetDisasterRecoveryItem', 'ListDisasterRecoveryCheckpoints', 'SyncDisasterRecoveryCheckpoint'], 'type' => 'directory', - 'children' => [ - 'ListTagResources', - 'TagResources', - 'UntagResources', - ], + 'title' => 'Global Replicator', + 'id' => 90577, ], [ - 'id' => 322784, - 'title' => '资源组', + 'children' => ['GetConsumeTimespan', 'ListMetricMeta', 'ChangeResourceGroup', 'CreateConsumerGroup', 'CreateInstance', 'DeleteConsumerGroup', 'DeleteInstance', 'GetInstance', 'GetTopic', 'GetTrace', 'ListAvailableZones', 'ListInstances', 'ListRegions', 'ListTagResources', 'ListTopics', 'ListTraces', 'TagResources', 'UntagResources', 'UpdateConsumerGroup', 'UpdateInstance'], 'type' => 'directory', - 'children' => [ - 'ChangeResourceGroup', - ], - ], - [ - 'id' => 322786, 'title' => '其他', - 'type' => 'directory', - 'children' => [ - 'GetConsumeTimespan', - 'ListRegions', - 'ListAvailableZones', - 'ListMetricMeta', - ], + 'id' => 90507, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CreateInstance' => [ - 'summary' => '创建云消息队列 RocketMQ 版5.x系列实例。', - 'path' => '/instances', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddDisasterRecoveryItem' => [ + 'summary' => '添加备份映射任务', + 'path' => '/disaster_recovery/{planId}/items', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -189,91 +74,576 @@ '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' => '备份计划id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体结构。必填', + 'type' => 'object', + 'properties' => [ + 'topics' => [ + 'title' => '容灾Item所包含的容灾主题', + 'description' => '备份映射所包含的主题，必填', + 'type' => 'array', + 'items' => [ + 'description' => '备份映射所包含的主题', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => '区域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + 'instanceType' => [ + 'title' => '实例类型', + 'description' => '实例类型'."\n" + .' - ALIYUN_ROCKETMQ ：阿里云实例'."\n" + .' - EXTERNAL_ROCKETMQ ：外部实例，开源实例，开源集群', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['ALIYUN_ROCKETMQ' => '阿里云实例', 'EXTERNAL_ROCKETMQ' => '外部实例'], + 'example' => 'ALIYUN_ROCKETMQ'."\n", + ], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID，instanceType为EXTERNAL_ROCKETMQ会自动生成个实例ID，可以通过查询备份计划获取该ID。', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-em93y94xxx'], + 'topicName' => ['title' => '容灾主题名称', 'description' => '容灾主题名称,必填', 'type' => 'string', 'required' => false, 'example' => 'Topic_xxx'], + 'consumerGroupId' => ['title' => '消费者组ID', 'description' => '消费者组ID，ACTIVE_ACTIVE双向备份时必填', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'GID_xxx'], + 'deliveryOrderType' => [ + 'description' => '消息投递到目标实例的顺序性。'."\n" + ."\n" + .'参数取值如下：'."\n" + .'- Concurrently：并发投递'."\n" + .'- Orderly：顺序投递', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Concurrently' => '并发投递', 'Orderly' => '顺序投递'], + 'example' => 'Concurrently', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['description' => '返回结果,映射任务id', 'type' => 'integer', 'format' => 'int64', 'example' => '1300000016'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '200'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'xxx'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '添加备份映射任务', + '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' => [ + 'summary' => '修改实例所属的资源组。', + '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' => '资源ID，即云消息队列 RocketMQ 版实例的ID。表示需要为哪个实例修改所属的资源组。', 'type' => 'string', 'required' => true, 'example' => 'c2c5d1274a8d4317a13bc5b0d4******'], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => '实例所属的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'resourceType', 'in' => 'query', 'schema' => [ - 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', + 'description' => '资源类型。'."\n" + ."\n" + .'该参数固定取值为**instance**，表述资源的类型为实例。', 'type' => 'string', - 'required' => false, - 'example' => 'c2c5d1274a8d4317a13bc5b0d4******', + 'required' => true, + 'enumValueTitles' => ['instance' => '实例'], + 'example' => 'instance', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID，表示需要将指定实例转入到哪个资源组下。'."\n" + ."\n" + .'您可以通过<props="china">[ListResourceGroups](https://help.aliyun.com/document_detail/158855.html)</props><props="intl">[ListResourceGroups](https://www.alibabacloud.com/help/resource-management/latest/listresourcegroups)</props>接口查询已有资源组。', 'type' => 'string', 'required' => true, 'example' => 'rg-9gLOoK****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID，每个请求ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['description' => '动态错误码。', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['description' => '动态错误信息。', 'type' => 'string', 'example' => 'instanceId'], + ], + ], + ], + ], + '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' => '修改资源组', + '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' => '创建云消息队列 RocketMQ 版的消费者分组（ConsumerGroup）。消费者分组是云消息队列 RocketMQ 版系统中承载多个消费行为一致的消费者的负载均衡分组。消费者需要通过指定消费者分组订阅相关的主题来实现消息订阅。', + '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' => '实例ID', 'description' => '待创建的消费者分组所属的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => ['title' => '消费组ID', 'description' => '待创建的消费者分组的ID。用于标识消费者分组，全局唯一。'."\n" + ."\n" + .'取值说明如下：'."\n" + ."\n" + .'- 字符限制：支持字母a\\~z或A\\~Z、数字0\\~9以及下划线（_）、短划线（-）。'."\n" + .'- 长度限制：1~60个字符。'."\n" + ."\n" + .'保留字符限制，请参见[参数限制](~~440347~~)。', 'type' => 'string', 'required' => true, 'example' => 'GID_test_groupId'], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'body参数。', + 'description' => '请求体对象。', 'type' => 'object', 'properties' => [ - 'instanceName' => [ - 'title' => '实例名称', - 'description' => '待创建的实例名称。'."\n" + 'remark' => ['title' => '备注', 'description' => '待创建消费者分组的备注信息。', 'type' => 'string', 'required' => false, 'example' => 'This is the remark for test.'], + 'deliveryOrderType' => [ + 'title' => '投递顺序性', + 'description' => '待创建消费者分组的投递顺序性。'."\n" ."\n" - .'不填写则以实例ID作为实例名称', + .'参数取值如下：'."\n" + .'- Concurrently：并发投递'."\n" + .'- Orderly：顺序投递', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['Concurrently' => '并发投递', 'Orderly' => '顺序投递'], + 'example' => 'Concurrently', + 'enum' => ['Orderly', 'Concurrently'], + ], + 'consumeRetryPolicy' => [ + 'title' => '消费重试策略', + 'description' => '待创建消费者分组的消费重试策略。更多信息，请参见'."\n" + .'[消费重试](~~440356~~)。', + 'type' => 'object', + 'properties' => [ + 'maxRetryTimes' => ['title' => '最大重试次数', 'description' => '最大重试次数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16'], + 'retryPolicy' => [ + 'title' => '重试策略类型', + 'description' => '重试策略类型。更多信息，请参见[消息重试](~~440356~~)。'."\n" + ."\n" + .'参数取值如下：'."\n" + .'- FixedRetryPolicy：固定间隔重试，仅支持顺序投递'."\n" + .'- DefaultRetryPolicy：阶梯退避重试，仅支持并发投递', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['FixedRetryPolicy' => '固定间隔重试', 'DefaultRetryPolicy' => '阶梯退避重试'], + 'example' => 'DefaultRetryPolicy', + 'enum' => ['DefaultRetryPolicy', 'FixedRetryPolicy'], + ], + 'deadLetterTargetTopic' => ['description' => '死信Topic。'."\n" + ."\n" + .'消费者出现异常消费某条消息失败，且消息重试后依然未成功，消息将被投递至死信Topic中，以便后续进行业务恢复或回溯。更多信息，请参见[消费重试与死信](~~440356~~)。', 'type' => 'string', 'required' => false, 'example' => 'DLQ_mqtest'], + 'fixedIntervalRetryTime' => ['description' => '固定重试间隔，单位：秒。重试策略为FixedRetryPolicy固定间隔重试策略时生效'."\n" + .'取值范围：'."\n" + .' - 并发投递：10-1800'."\n" + .' - 顺序投递：1-600', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + 'required' => true, + ], + 'maxReceiveTps' => ['description' => '消费消息tps上限', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'], + 'messageModel' => [ + 'title' => '消费模式', + 'description' => '消费者对消息的消费模式：'."\n" + .' - CLUSTERING'."\n" + .' - LITE_SELECTIVE', 'type' => 'string', 'required' => false, - 'example' => 'rmq-cn-72u3048uxxx', + 'example' => 'LITE_SELECTIVE', + 'default' => 'CLUSTERING', + 'enum' => ['CLUSTERING', 'LITE_SELECTIVE'], ], - 'serviceCode' => [ - 'title' => '服务编码', - 'description' => '实例所属的服务编码。消息队列RocketMQ版的服务编码为rmq。', + 'topicName' => ['title' => 'lite类型的topicName', 'description' => 'LITE_SELECTIVE 消费模式时，需要订阅的lite类型的topic名称', 'type' => 'string', 'required' => false, 'example' => 'liteTopicTest'], + 'exclusive' => ['title' => '是否排他消费', 'type' => 'boolean'], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'InvalidConsumerGroupId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter consumerGroupId is invalid.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'ConsumerGroupId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'consumerGroupId'], + ], + ], + ], + ], + 'title' => '创建消费者分组', + 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></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' => [ + 'summary' => '创建备份计划。', + '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' => '请求体结构。', + 'type' => 'object', + 'properties' => [ + 'planName' => ['title' => '计划名称', 'description' => '计划名称，必填', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + 'planDesc' => ['title' => '计划描述', 'description' => '计划描述', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + 'planType' => [ + 'title' => '计划类型', + 'description' => '备份计划类型，必填。请参见[Global Replicator](~~2843187~~)。'."\n" + .'参数取值如下：'."\n" + .' - ACTIVE_PASSIVE：单向备份'."\n" + .' - ACTIVE_ACTIVE：双向备份', 'type' => 'string', - 'required' => true, - 'example' => 'rmq', - 'default' => 'rmq', + 'required' => false, + 'enumValueTitles' => ['ACTIVE_ACTIVE' => '双向备份', 'ACTIVE_PASSIVE' => '单向备份'], + 'example' => 'ACTIVE_ACTIVE', + ], + 'instances' => [ + 'title' => '容灾计划参与实例', + 'description' => '备份计划参与实例。必填', + 'type' => 'array', + 'items' => [ + 'description' => '备份计划参与实例', + 'type' => 'object', + 'properties' => [ + 'instanceType' => [ + 'title' => '实例类型', + 'description' => '实例类型'."\n" + .' - ALIYUN_ROCKETMQ ：阿里云实例'."\n" + .' - EXTERNAL_ROCKETMQ ：外部实例，开源实例，开源集群', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['ALIYUN_ROCKETMQ' => '阿里云mq实例', 'EXTERNAL_ROCKETMQ' => '外部实例'], + 'example' => 'ALIYUN_ROCKETMQ', + ], + 'regionId' => ['title' => '实例所在区域', 'description' => '实例所在区域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID，instanceType实例类型为EXTERNAL_ROCKETMQ无须填写，ALIYUN_ROCKETMQ必填', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-******'], + 'instanceRole' => [ + 'title' => '实例角色', + 'description' => '实例角色，主或者备'."\n" + .' - ACTIVE：主'."\n" + .' - PASSIVE：备', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['PASSIVE' => '备', 'ACTIVE' => '主'], + 'example' => 'PASSIVE', + ], + 'authType' => [ + 'title' => '认证方式', + 'description' => '认证方式。instanceType实例类型为ALIYUN_ROCKETMQ，实例版本为4.0无须填写'."\n" + .' - NO_AUTH：无需认证'."\n" + .' - ACL_AUTH：acl认证', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['NO_AUTH' => '无须认证', 'ACL_AUTH' => 'acl认证'], + 'example' => 'ACL_AUTH', + ], + 'username' => ['title' => '认证用户名', 'description' => '认证用户名，authType为ACL_AUTH时必填', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + 'password' => ['title' => '认证密码', 'description' => '认证密码，authType为ACL_AUTH时必填。instanceType实例类型为ALIYUN_ROCKETMQ无须填写', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + 'endpointUrl' => ['title' => '接入点地址', 'description' => '接入点地址，instanceType实例类型为ALIYUN_ROCKETMQ无须填写，EXTERNAL_ROCKETMQ需要填写', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + 'networkType' => [ + 'title' => '网络类型', + 'description' => '网络类型，instanceType实例类型为ALIYUN_ROCKETMQ无须填写，EXTERNAL_ROCKETMQ需要填写'."\n" + .'参数取值如下：'."\n" + .' - TCP_INTERNET：tcp公网'."\n" + .' - TCP_VPC：tcp专有网络', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['TCP_VPC' => 'tcp专有网络', 'TCP_INTERNET' => 'tcp公网'], + 'example' => 'TCP_INTERNET', + ], + 'vpcId' => ['title' => 'VPC ID', 'description' => '创建实例所关联的专有网络的ID，instanceType实例类型仅为EXTERNAL_ROCKETMQ，networkType为TCP_VPC时需要填写', 'type' => 'string', 'required' => false, 'example' => 'vpc-wz9qt50xhtj9krb******'."\n"], + 'vSwitchId' => ['title' => '交换机ID', 'description' => '实例所关联的交换机ID，instanceType实例类型仅为EXTERNAL_ROCKETMQ，networkType为TCP_VPC时需要填写', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6gwtbn6etadpv******'."\n"], + 'messageProperty' => [ + 'description' => '消息过滤属性，消息同步到目标集群时，会自动添加上该属性，用于消息消费时进行SQL过滤。', + 'type' => 'object', + 'properties' => [ + 'propertyKey' => ['description' => '属性key', 'type' => 'string', 'required' => false, 'example' => 'aaa'], + 'propertyValue' => ['description' => '属性value', 'type' => 'string', 'required' => false, 'example' => 'bbb'], + ], + 'required' => false, + ], + 'securityGroupId' => ['description' => '安全组id，instanceType实例类型仅为EXTERNAL_ROCKETMQ，networkType为TCP_VPC时需要填写', 'type' => 'string', 'required' => false, 'example' => 'sg-bp17hpmgz9******'], + 'consumerGroupId' => ['description' => '消费者组ID，用于从源实例拉取消息。'."\n" + .'<notice>自建实例必须填写，阿里云实例会自动生成。</notice>', 'type' => 'string', 'required' => false, 'example' => 'GID_DS_XXX_YYY'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'autoSyncCheckpoint' => [ + 'title' => '自动消费进度同步开关', + 'description' => '是否开启消费进度自动同步。'."\n" + ."\n" + .'> 只有在开启消费进度同步时有效。即 `syncCheckpointEnabled`字段值为true。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], + 'example' => 'true', ], + 'syncCheckpointEnabled' => [ + 'description' => '同步消费进度开关', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Long>', + 'description' => 'Result<Long>', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5xxxx'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果，备份计划id', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '200'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'xxx'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '创建备份计划', + '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' => '创建云消息队列 RocketMQ 版5.x系列实例。', + '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' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => 'c2c5d1274a8d4317a13bc5b0d4******'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'body参数。', + 'type' => 'object', + 'properties' => [ + 'instanceName' => ['title' => '实例名称', 'description' => '待创建的实例名称。'."\n" + ."\n" + .'不填写则以实例ID作为实例名称', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-72u3048uxxx'], + 'serviceCode' => ['title' => '服务编码', 'description' => '实例所属的服务编码。消息队列RocketMQ版的服务编码为rmq。', 'type' => 'string', 'required' => true, 'example' => 'rmq', 'default' => 'rmq'], 'seriesCode' => [ 'title' => '系列编码', 'description' => '实例的主系列编码。主系列间的具体差异，请参见[产品选型](~~444722~~)。'."\n" ."\n" - .'参数取值如下：'."\n" - .'- standard：标准版'."\n" - .'- ultimate：铂金版'."\n" - .'- professional：专业版'."\n" - .'- dedicated： 独享版'."\n" - .'- shared： 共享版'."\n" - ."\n" .'><notice>实例创建成功后，主系列只支持单向变更，只升不降，变更方向为：标准版 > 专业版 > 铂金版。例如，只支持从标准版变更到专业版，不支持从专业版降为标准版。></notice>', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'standard' => '标准版', - 'dedicated' => '独享版', - 'shared' => '共享版', - 'ultimate' => '铂金版', - 'professional' => '专业版', - ], + 'enumValueTitles' => ['standard' => '标准版', 'dedicated' => '独享版', 'shared' => '共享版', 'ultimate' => '铂金版', 'professional' => '专业版'], 'example' => 'standard', ], 'subSeriesCode' => [ 'title' => '子系列编码', 'description' => '实例的子系列编码。子系列间具体差异，请参见[产品选型](~~444722~~)。'."\n" ."\n" - .'参数取值如下：'."\n" - .'- cluster_ha：集群高可用版'."\n" - .'- single_node：单节点测试版'."\n" - .'- serverless：Serverless实例'."\n" - ."\n" .'主系列选择ultimate（铂金版）时，子系列只能选择为cluster_ha（集群高可用版）。'."\n" .'><notice>实例创建成功后，子系列不支持变更。></notice>', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'serverless' => 'Serverless版', - 'cluster_ha' => '集群高可用版', - 'single_node' => '单节点测试版', - ], + 'enumValueTitles' => ['serverless' => 'Serverless版', 'cluster_ha' => '集群高可用版', 'single_node' => '单节点测试版'], 'example' => 'cluster_ha', ], 'paymentType' => [ @@ -281,195 +651,102 @@ .'预付费：Subscription'."\n" .'后付费：PayAsYouGo', 'description' => '实例的付费类型。云消息队列 RocketMQ 版支持包年包月和按量付费两种类型。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- PayAsYouGo：按量付费，一种后付费模式，即先使用再付费。'."\n" - .'- Subscription：包年包月，一种预付费模式，即先付费再使用。'."\n" - ."\n" + ."\n\n" .'具体信息，请参见[计费方式](~~427234~~)。', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'PayAsYouGo' => '按量付费', - 'Subscription' => '包年包月', - ], + 'enumValueTitles' => ['PayAsYouGo' => '按量付费，一种后付费模式，即先使用再付费。', 'Subscription' => '包年包月，一种预付费模式，即先付费再使用。'], 'example' => 'Subscription', - 'enum' => [ - 'Subscription', - 'PayAsYouGo', - ], - ], - 'period' => [ - 'title' => '购买时长，只有预付费支持', - 'description' => '购买时长。仅当实例付费类型为Subscription（包年包月）时，该参数生效。'."\n" - ."\n" - .'取值范围如下：'."\n" - ."\n" - .'- 按月购买：1、2、3、4、5、6'."\n" - ."\n" - .'- 按年购买：1、2、3', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'enum' => ['Subscription', 'PayAsYouGo'], + ], + 'period' => ['title' => '购买时长，只有预付费支持', 'description' => '购买时长。仅当实例付费类型为Subscription（包年包月）时，该参数生效。'."\n" + ."\n" + .'取值范围如下：'."\n" + ."\n" + .'- 按月购买：1、2、3、4、5、6'."\n" + ."\n" + .'- 按年购买：1、2、3', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], 'periodUnit' => [ 'title' => '购买时长单位，只有预付费支持'."\n" .'月：Month'."\n" .'年：Year', - 'description' => '购买时长的最小周期单位。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- Month：按月购买'."\n" - .'- Year：按年购买', + 'description' => '购买时长的最小周期单位。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Month' => '按月购买', - 'Year' => '按年购买', - ], + 'enumValueTitles' => ['Month' => '按月购买', 'Year' => '按年购买'], 'example' => 'Month', - 'enum' => [ - 'Month', - 'Year', - ], + 'enum' => ['Month', 'Year'], ], 'autoRenew' => [ 'title' => '是否自动续费，只有预付费支持', - 'description' => '是否自动续费。仅当实例付费类型为Subscription（包年包月）时，该参数生效。'."\n" - ."\n" - .'- true：开启自动续费'."\n" - .'- false：不开启自动续费', + 'description' => '是否自动续费。仅当实例付费类型为Subscription（包年包月）时，该参数生效。', 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => '开启自动续费', - 'false' => '不开启自动续费', - ], + 'enumValueTitles' => ['true' => '开启自动续费', 'false' => '不开启自动续费'], 'example' => 'true', ], - 'autoRenewPeriod' => [ - 'title' => '自动续费周期，只有预付费支持', - 'description' => '自动续费周期。仅当开启自动续费时该参数有效。单位：月。'."\n" - ."\n" - .'取值范围：'."\n" - ."\n" - .'- 按月续费：1、2、3、6、12', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'remark' => [ - 'title' => '备注信息', - 'description' => '实例的备注信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is the remark for test.', - ], + 'autoRenewPeriod' => ['title' => '自动续费周期，只有预付费支持', 'description' => '自动续费周期。仅当开启自动续费时该参数有效。单位：月。'."\n" + ."\n" + .'取值范围：'."\n" + ."\n" + .'- 按月续费：1、2、3、6、12', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + 'remark' => ['title' => '备注信息', 'description' => '实例的备注信息。', 'type' => 'string', 'required' => false, 'example' => 'This is the remark for test.'], 'productInfo' => [ 'title' => '产品信息', 'description' => '实例规格信息。', 'type' => 'object', 'properties' => [ - 'msgProcessSpec' => [ - 'title' => '消息收发规格', - 'description' => '消息收发计算规格。具体消息收发TPS上限，请参见[实例规格](~~444715~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'rmq.s2.2xlarge', - ], - 'sendReceiveRatio' => [ - 'title' => '消息收发比例', - 'description' => '消息发送TPS占整个实例消息收发TPS总量的比例。'."\n" - ."\n" - .'例如，实例的消息收发TPS上限为1000次/秒，若消息发送占比为0.8，则消息发送TPS上限为800次/秒，消息接收TPS上限为200次/秒。'."\n" - ."\n" - .'取值范围：[0.05，0.95]，默认值为0.5。', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.5', - ], + 'msgProcessSpec' => ['title' => '消息收发规格', 'description' => '消息收发计算规格。具体消息收发TPS上限，请参见[实例规格](~~444715~~)。', 'type' => 'string', 'required' => false, 'example' => 'rmq.s2.2xlarge'], + 'sendReceiveRatio' => ['title' => '消息收发比例', 'description' => '消息发送TPS占整个实例消息收发TPS总量的比例。'."\n" + ."\n" + .'例如，实例的消息收发TPS上限为1000次/秒，若消息发送占比为0.8，则消息发送TPS上限为800次/秒，消息接收TPS上限为200次/秒。'."\n" + ."\n" + .'取值范围：[0.05，0.95]，默认值为0.5。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.5'], 'autoScaling' => [ 'title' => '是否开启弹性伸缩', 'description' => '是否开启规格外突发弹性能力。'."\n" ."\n" - .'参数取值如下：'."\n" - ."\n" - .'- true：开启弹性能力'."\n" - .'- false：不开启弹性能力'."\n" - ."\n" .'开启弹性突发能力后，云消息队列 RocketMQ 版允许该实例在一定范围内超过基础规格限制的TPS，且超过基础规格外的部分，需要收取额外的弹性规格费用。具体计费信息，请参见[计算能力费用](~~427237~~)。'."\n" ."\n\n" .'> 仅部分规格的实例支持开启弹性突发规格能力，具体支持的实例，请参见[实例规格](~~444715~~)。', 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => '开启弹性能力', - 'false' => '不开启弹性能力', - ], + 'enumValueTitles' => ['true' => '开启弹性能力', 'false' => '不开启弹性能力'], 'example' => 'true', ], - 'messageRetentionTime' => [ - 'title' => '消息保留时长', - 'description' => '消息保存时长。单位：小时。'."\n" - ."\n" - .'取值范围，请参见[使用限制](~~440347~~)>资源配额>消息保存时长的限制值。'."\n" - ."\n" - .'云消息队列 RocketMQ 版的消息存储完全实现Serverless弹性，按照实际存储空间收取费用，您可以通过调整消息保存时长来控制消息的存储容量。更多信息，请参见[存储费用](~~427238~~)。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '72', - ], - 'storageEncryption' => [ - 'title' => '是否开启存储加密', - 'description' => '是否开启存储加密', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'storageSecretKey' => [ - 'title' => '存储加密密钥Key', - 'description' => '存储加密密钥Key', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxx', - ], + 'messageRetentionTime' => ['title' => '消息保留时长', 'description' => '消息保存时长。单位：小时。'."\n" + ."\n" + .'取值范围，请参见[使用限制](~~440347~~)>资源配额>消息保存时长的限制值。'."\n" + ."\n" + .'云消息队列 RocketMQ 版的消息存储完全实现Serverless弹性，按照实际存储空间收取费用，您可以通过调整消息保存时长来控制消息的存储容量。更多信息，请参见[存储费用](~~427238~~)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '72'], + 'storageEncryption' => ['title' => '是否开启存储加密', 'description' => '是否开启存储加密', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'storageSecretKey' => ['title' => '存储加密密钥Key', 'description' => '存储加密密钥Key', 'type' => 'string', 'required' => false, 'example' => 'xxxxx'], 'capacityType' => [ 'title' => '容量模式。provisioned：预留+弹性；onDemand：按量付费', - 'description' => '容量模式。provisioned：预留+弹性；onDemand：按量付费', + 'description' => '容量模式。', 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['provisioned' => '预留+弹性', 'ondemand' => '按量付费'], 'example' => 'provisioned', - 'enum' => [ - 'provisioned', - 'ondemand', - ], - ], - 'provisionedCapacity' => [ - 'title' => '预留容量', - 'description' => '预留容量', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5000', + 'enum' => ['provisioned', 'ondemand'], ], - 'traceOn' => [ - 'title' => '是否开启消息轨迹功能。'."\n" - ."\n" - .'true：开启消息轨迹功能'."\n" - .'false：关闭消息轨迹功能'."\n" - .'该参数仅对 Serverless 类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见 Serverless 计费说明。 对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。', - 'description' => '是否开启消息轨迹功能。'."\n" - ."\n" - .'true：开启消息轨迹功能'."\n" - .'false：关闭消息轨迹功能'."\n" - .'该参数仅对 Serverless 类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见 Serverless 计费说明。 对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。', - 'type' => 'boolean', + 'provisionedCapacity' => ['title' => '预留容量', 'description' => '预留容量', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000'], + 'traceOn' => ['title' => '是否开启消息轨迹功能。'."\n" + ."\n" + .'true：开启消息轨迹功能'."\n" + .'false：关闭消息轨迹功能'."\n" + .'该参数仅对 Serverless 类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见 Serverless 计费说明。 对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。', 'description' => '是否开启消息轨迹功能。'."\n" + ."\n" + .'true：开启消息轨迹功能'."\n" + .'false：关闭消息轨迹功能'."\n" + .'该参数仅对 Serverless 类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见 Serverless 计费说明。 对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'drReplicationMode' => [ + 'title' => '跨地域复制模式', + 'description' => '跨地域复制模式', + 'type' => 'string', 'required' => false, - 'example' => 'true', + 'enumValueTitles' => ['async_cross_az' => '异步复制', 'sync_cross_az' => '同步复制'], + 'example' => 'async_cross_az', ], ], 'required' => false, @@ -484,33 +761,15 @@ 'description' => '专有网络配置信息。', 'type' => 'object', 'properties' => [ - 'vpcId' => [ - 'title' => '专有网络ID', - 'description' => '待创建实例所关联的专有网络的ID。'."\n" - ."\n" - .'> 云消息队列 RocketMQ 版实例创建后，选择的VPC不支持变更。若要修改关联的VPC，您需要先释放已购买的云消息队列 RocketMQ 版实例，再重新购买。', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-wz9qt50xhtj9krb******', - ], - 'vSwitchId' => [ - 'title' => '交换机ID', - 'description' => '实例所关联的交换机ID，当有多个交换机时，请以“|“进行拼接。'."\n" - ."\n" - .'> 云消息队列 RocketMQ 版实例创建后，选择的交换机不支持变更。若要修改关联的交换机，您需要先释放已购买的云消息队列 RocketMQ 版实例，再重新购买。'."\n" - ."\n" - .'<notice>该字段不推荐使用，请使用vSwitches字段></notice>', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'vsw-uf6gwtbn6etadpv*******', - ], - 'securityGroupIds' => [ - 'description' => '安全组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'sg-bp17hpmgz96tvnsdy6so', - ], + 'vpcId' => ['title' => '专有网络ID', 'description' => '待创建实例所关联的专有网络的ID。'."\n" + ."\n" + .'> 云消息队列 RocketMQ 版实例创建后，选择的VPC不支持变更。若要修改关联的VPC，您需要先释放已购买的云消息队列 RocketMQ 版实例，再重新购买。', 'type' => 'string', 'required' => true, 'example' => 'vpc-wz9qt50xhtj9krb******'], + 'vSwitchId' => ['title' => '交换机ID', 'description' => '实例所关联的交换机ID，当有多个交换机时，请以“|“进行拼接。'."\n" + ."\n" + .'> 云消息队列 RocketMQ 版实例创建后，选择的交换机不支持变更。若要修改关联的交换机，您需要先释放已购买的云消息队列 RocketMQ 版实例，再重新购买。'."\n" + ."\n" + .'<notice>该字段不推荐使用，请使用vSwitches字段></notice>', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'vsw-uf6gwtbn6etadpv*******'], + 'securityGroupIds' => ['description' => '安全组ID。', 'type' => 'string', 'required' => false, 'example' => 'sg-bp17hpmgz96tvnsdy6so'], 'vSwitches' => [ 'description' => '交换机列表。'."\n" ."\n" @@ -521,14 +780,10 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'vSwitchId' => [ - 'description' => '实例所关联的交换机ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-uf6gwtbn6etadpv*******', - ], + 'vSwitchId' => ['description' => '实例所关联的交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6gwtbn6etadpv*******'], ], 'required' => false, + 'description' => '', ], 'required' => false, ], @@ -546,49 +801,26 @@ .'关闭：disable', 'description' => '是否开通公网访问。'."\n" ."\n" - .'参数取值如下：'."\n" - .'- enable：开启公网访问'."\n" - .'- disable：关闭公网访问'."\n" - ."\n" .'实例默认支持VPC访问方式，若开启公网访问，云消息队列 RocketMQ 版会收取公网下行带宽费用。具体计费信息，请参见[公网访问费用](~~427240~~)。', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'enable' => '开启公网访问', - 'disable' => '关闭公网访问', - ], + 'enumValueTitles' => ['enable' => '开启公网访问', 'disable' => '关闭公网访问'], 'example' => 'disable', ], 'flowOutType' => [ 'title' => '公网计费类型'."\n" .'固定带宽计费：payByBandwidth', - 'description' => '公网计费类型。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- payByBandwidth：固定带宽计费。开启公网访问时，设置为该参数取值。'."\n" - .'- payByTraffic：按流量计费。开启公网访问时，设置为该参数取值。'."\n" - .'- uninvolved：不涉及。关闭公网访问时，设置为该参数取值。', + 'description' => '公网计费类型。', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'payByBandwidth' => '固定带宽计费', - 'payByTraffic' => '按流量计费', - 'uninvolved' => '不涉及', - ], + 'enumValueTitles' => ['payByBandwidth' => '固定带宽计费，开启公网访问时，设置为该参数取值。', 'payByTraffic' => '按流量计费，开启公网访问时，设置为该参数取值。', 'uninvolved' => '不涉及，关闭公网访问时，设置为该参数取值。'], 'example' => 'uninvolved', ], - 'flowOutBandwidth' => [ - 'title' => '公网带宽规格', - 'description' => '公网带宽规格。单位：Mb/s。'."\n" - ."\n" - .'只有在公网计费类型为按固定带宽计费的时候才需要填写。'."\n" - ."\n" - .'取值范围：[1 - 1000]。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'flowOutBandwidth' => ['title' => '公网带宽规格', 'description' => '公网带宽规格。单位：Mb/s。'."\n" + ."\n" + .'只有在公网计费类型为按固定带宽计费的时候才需要填写。'."\n" + ."\n" + .'取值范围：[1 - 1000]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], 'ipWhitelist' => [ 'title' => '公网IP白名单列表', 'description' => '公网访问IP白名单。仅公网接入点支持配置IP白名单，VPC接入点暂不支持。'."\n" @@ -596,13 +828,7 @@ .'- 若不配置IP白名单，则默认放通所有IP地址段通过公网访问云消息队列 RocketMQ 版服务端。'."\n" .'- 若配置IP白名单，则仅允许白名单内的IP地址通过公网访问云消息队列 RocketMQ 版服务端。', 'type' => 'array', - 'items' => [ - 'title' => '公网IP白名单', - 'description' => '公网访问白名单地址段。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.x.x/24', - ], + 'items' => ['title' => '公网IP白名单', 'description' => '公网访问白名单地址段。', 'type' => 'string', 'required' => false, 'example' => '192.168.x.x/24'], 'deprecated' => true, 'required' => false, ], @@ -612,31 +838,20 @@ ], 'required' => true, ], - 'commodityCode' => [ - 'description' => '商品编码。'."\n" - ."\n" - .'<props="china">- ons_rmqsub_public_cn：包年包月实例</props>'."\n" - ."\n" - .'<props="china">- ons_rmqpost_public_cn：按量付费实例</props>'."\n" - ."\n" - .'<props="china">- ons_rmqsrvlesspost_public_cn ：Serverless实例</props>'."\n" - ."\n" - .'<props="intl">- ons_rmqpost_public_intl：按量付费</props>'."\n" - ."\n" - .'<props="intl">- ons_rmqsub_public_intl：包年包月</props>'."\n" - .'<props="intl">- ons_rmqsrvlesspost_public_intl ：Serverless实例</props>'."\n" - .'serverless实例此参数必填', - 'type' => 'string', - 'required' => false, - 'example' => 'ons_ rmqpost_public_cn', - ], - 'resourceGroupId' => [ - 'title' => '资源组ID', - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzy6pist7uuna', - ], + 'commodityCode' => ['description' => '商品编码。'."\n" + ."\n" + .'<props="china">- ons_rmqsub_public_cn：包年包月实例</props>'."\n" + ."\n" + .'<props="china">- ons_rmqpost_public_cn：按量付费实例</props>'."\n" + ."\n" + .'<props="china">- ons_rmqsrvlesspost_public_cn ：Serverless实例</props>'."\n" + ."\n" + .'<props="intl">- ons_rmqpost_public_intl：按量付费</props>'."\n" + ."\n" + .'<props="intl">- ons_rmqsub_public_intl：包年包月</props>'."\n" + .'<props="intl">- ons_rmqsrvlesspost_public_intl ：Serverless实例</props>'."\n" + .'serverless实例此参数必填', 'type' => 'string', 'required' => false, 'example' => 'ons_ rmqpost_public_cn', 'deprecated' => true], + 'resourceGroupId' => ['title' => '资源组ID', 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzy6pist7uuna'], 'tags' => [ 'description' => '资源标签列表', 'type' => 'array', @@ -644,18 +859,8 @@ 'description' => '资源标签。', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => '资源标签key值。', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxKey', - ], - 'value' => [ - 'description' => '资源标签value值。', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxValue', - ], + 'key' => ['description' => '资源标签key值。', 'type' => 'string', 'required' => false, 'example' => 'xxxKey'], + 'value' => ['description' => '资源标签value值。', 'type' => 'string', 'required' => false, 'example' => 'xxxValue'], ], 'required' => false, ], @@ -666,15 +871,9 @@ 'description' => '访问控制信息。', 'type' => 'object', 'properties' => [ - 'defaultVpcAuthFree' => [ - 'title' => '是否支持vpc免密访问', - 'description' => '是否智能身份识别类型下，VPC接入免密访问'."\n" - .'- true 开启免密访问'."\n" - .'- false 关闭免密访问', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'defaultVpcAuthFree' => ['title' => '是否支持vpc免密访问', 'description' => '是否智能身份识别类型下，VPC接入免密访问'."\n" + .'- true 开启免密访问'."\n" + .'- false 关闭免密访问', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], 'required' => false, ], @@ -690,73 +889,46 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回已创建实例的ID。', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Success', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回已创建实例的ID。', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => '200'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Success'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], - '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' => '创建实例', 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>', - ], - 'UpdateInstance' => [ - 'summary' => '更新云消息队列 RocketMQ 版实例的基本信息和规格配置。', - 'path' => '/instances/{instanceId}', - 'methods' => [ - 'patch', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'rocketmq:CreateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + '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' => '创建实例的访问账号。', + 'path' => '/instances/{instanceId}/accounts', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -764,20 +936,12 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => '待更新实例的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'body', @@ -787,153 +951,9 @@ 'description' => '请求体结构。', 'type' => 'object', 'properties' => [ - 'instanceName' => [ - 'title' => '实例名称', - 'description' => '更新后的实例名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_instance', - ], - 'remark' => [ - 'title' => '实例备注', - 'description' => '更新后的实例备注信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is the remark for test.', - ], - 'networkInfo' => [ - 'title' => '网络信息', - 'description' => '更新后的实例网络信息。', - 'type' => 'object', - 'properties' => [ - 'internetInfo' => [ - 'title' => '公网信息', - 'description' => '公网信息，仅当实例开通公网访问功能时，该参数有效。', - 'type' => 'object', - 'properties' => [ - 'ipWhitelist' => [ - 'title' => '公网IP白名单列表', - 'description' => '公网访问IP白名单列表。'."\n" - ."\n" - .'- 若不配置IP白名单，则默认放通所有IP地址段通过公网访问云消息队列 RocketMQ 版服务端。'."\n" - .'- 若配置IP白名单，则仅允许白名单内的IP地址通过公网访问云消息队列 RocketMQ 版服务端。', - 'type' => 'array', - 'items' => [ - 'title' => '公网IP白名单', - 'description' => '公网访问IP白名单。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.x.x/24', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'productInfo' => [ - 'title' => '扩展配置', - 'description' => '实例的扩展配置。', - 'type' => 'object', - 'properties' => [ - 'sendReceiveRatio' => [ - 'title' => '消息收发比例', - 'description' => '消息发送和接收的比例。'."\n" - ."\n" - .'取值范围：[0.25，1]', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.5', - ], - 'autoScaling' => [ - 'title' => '自适应弹性伸缩', - 'description' => '是否开启规格外突发弹性能力。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- true：开启弹性'."\n" - .'- false：关闭弹性'."\n" - ."\n" - .'开启弹性突发能力后，云消息队列 RocketMQ 版允许该实例在一定范围内超过基础规格限制的TPS，且超过基础规格外的部分，需要收取额外的弹性规格费用。具体计费信息，请参见[计算能力费用](~~427237~~)。'."\n" - ."\n\n" - .'> 仅部分规格的实例支持开启弹性突发规格能力，具体支持的实例，请参见[实例规格](~~444715~~)。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '开启弹性', - 'false' => '关闭弹性', - ], - 'example' => 'true', - ], - 'messageRetentionTime' => [ - 'title' => '消息保留时长', - 'description' => '消息保存时长。单位：小时。'."\n" - ."\n" - .'取值范围，请参见[使用限制](~~440347~~)>资源配额>消息保存时长的限制值。'."\n" - ."\n" - .'云消息队列 RocketMQ 版的消息存储完全实现Serverless弹性，按照实际存储空间收取费用，您可以通过调整消息保存时长来控制消息的存储容量。更多信息，请参见[存储费用](~~427238~~)。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '72', - ], - 'traceOn' => [ - 'description' => '是否开启消息轨迹功能。'."\n" - .'- true：开启消息轨迹功能'."\n" - .'- false：关闭消息轨迹功能'."\n" - ."\n" - .'<props="intl">该参数暂不生效，不管参数是否开启，实例都默认支持轨迹功能。</props>'."\n" - .'<props="china">该参数仅对Serverless类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见[Serverless计费说明](~~2586280~~)。</props>'."\n" - .'<props="china">对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。</props>', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'false' => '关闭消息轨迹功能', - 'true' => '开启消息轨迹功能', - ], - 'example' => 'true', - ], - ], - 'required' => false, - ], - 'aclInfo' => [ - 'description' => '访问控制信息。', - 'type' => 'object', - 'properties' => [ - 'aclTypes' => [ - 'description' => '实例的鉴权类型。', - 'type' => 'array', - 'items' => [ - 'description' => '实例的鉴权类型。'."\n" - .'- default: 智能身份识别'."\n" - .'- apache_acl: Apache RocketMQ ACL', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'default' => '智能身份识别', - 'apache_acl' => 'Apache RocketMQ ACL', - ], - 'example' => 'apache_acl', - ], - 'required' => false, - ], - 'defaultVpcAuthFree' => [ - 'description' => '是否智能身份识别类型下，VPC接入免密访问'."\n" - .'- true 开启免密访问'."\n" - .'- false 关闭免密访问', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '开启免密访问', - 'false' => '关闭免密访问', - ], - 'example' => 'false', - ], - ], - 'required' => false, - ], + 'password' => ['title' => '用户密码', 'description' => '账号密码', 'type' => 'string', 'required' => true, 'example' => 'xxx'], + 'username' => ['description' => '账号名称', 'type' => 'string', 'required' => true, 'example' => 'xxx'], + 'remark' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => 'This is the remark for test.'], ], 'required' => false, ], @@ -946,73 +966,46 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'AA87DE09-DA44-52F4-9515-78B1B607****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '3AE0999C-8DBA-5CEE-8D9A-BE8D4A90DF8D'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'InstanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'type' => 'string', 'example' => 'xxx'], ], ], ], ], - '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' => '更新实例', - 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>', - ], - 'DeleteInstance' => [ - 'summary' => '释放实例。', - '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' => '创建访问账号', + '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' => '在指定实例下创建访问的权限信息。', + 'path' => '/instances/{instanceId}/acl/account/{username}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1021,1386 +1014,202 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', + 'abilityTreeCode' => '209893', + 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => '待删除实例的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody0129', - ], + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'username', + 'in' => 'path', + 'schema' => ['description' => '用户名称', 'type' => 'string', 'required' => true, 'example' => 'abc'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'description' => '请求体结构。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => '048242AA-BADA-5F29-B2CD-ED9FA344467F', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', + 'resourceType' => [ + 'title' => '授权的资源列表', + 'description' => '授权的资源类型', 'type' => 'string', - 'example' => 'MissingInstanceId', + 'required' => true, + 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], + 'example' => 'Topic', + 'enum' => ['Topic', 'Group'], ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', + 'resourceName' => ['title' => '授权资源名称', 'description' => '授权的资源名称', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'decision' => [ + 'title' => '决策,DecisionEnum[ALLOW,DENY,type,desc]', + 'description' => '授权的决策结果', 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', + 'required' => true, + 'enumValueTitles' => ['Deny' => '拒绝访问', 'Allow' => '允许访问'], + 'example' => 'Allow', + 'enum' => ['Allow', 'Deny'], ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'InstanceId', + 'actions' => [ + 'description' => '授权的操作类型。'."\n" + ."\n" + .'针对不同的资源类型，支持的操作类型如下：'."\n" + .'- 主题（Topic）：Pub、Sub、Pub|Sub'."\n" + .'- 消费者组（Group）: Sub', + 'type' => 'array', + 'items' => ['description' => '授权的操作类型。'."\n" + ."\n" + .'针对不同的资源类型，支持的操作类型如下：'."\n" + .'- 主题（Topic）：Pub、Sub、PubSub'."\n" + .'- 消费者组（Group）: Sub', 'type' => 'string', 'required' => false, 'example' => 'Pub'], + 'required' => true, + 'enumValueTitles' => ['Sub' => '订阅', 'Pub|Sub' => '发送订阅', 'Pub' => '发送'], + 'example' => 'Pub', ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'instanceId', + 'ipWhitelists' => [ + 'description' => 'IP白名单列表', + 'type' => 'array', + 'items' => ['description' => 'IP白名单，支持IP和IP段。', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0'], + 'required' => false, ], ], - ], - ], - ], - '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' => '删除实例', - 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>'."\n" - ."\n" - .'- 实例删除后将无法恢复，请慎重操作。'."\n" - ."\n" - .'- 本接口用于删除按量付费实例，对于包年包月实例，实例到期后自动释放，无需手动删除。', - ], - 'ListInstances' => [ - 'summary' => '查询指定地域下，所有的云消息队列 RocketMQ 版实例的列表信息。', - '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' => '查询的过滤条件，若不输入则查询所有实例。', - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-7e22ody****', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页页码', - 'description' => '分页页码，查询第几页的返回结果。'."\n" - ."\n" - .'取值范围：1~100000000。'."\n" - ."\n" - .'若您设置的参数值小于1，则系统默认按照参数值为1处理；若您设置的参数值大于100000000，则系统默认按照参数值为100000000处理。', - 'type' => 'integer', - 'format' => 'int32', 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => '分页大小，每页最多显示的返回结果数量。'."\n" - ."\n" - .'取值范围：10~200。'."\n" - ."\n" - .'若您设置的参数值小于10，则系统默认按照参数值为10处理；若您设置的参数值大于200，则系统默认按照参数值为200处理。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '10', - 'example' => '10', - ], - ], - [ - 'name' => 'resourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源组ID', - 'description' => '实例所属的资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmx7caj******', - ], - ], - [ - 'name' => 'tags', - 'in' => 'query', - 'schema' => [ - 'description' => '资源标签列表，用于筛选实例。', - 'type' => 'string', - 'required' => false, - 'example' => '[{"key": "rmq-test", "value": "test"}]', - ], - ], - [ - 'name' => 'seriesCodes', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '实例的主系列编码。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- standard：标准版'."\n" - .'- ultimate：铂金版'."\n" - .'- professional：专业版'."\n" - .'- dedicated： 独享版'."\n" - .'- shared： 共享版', - 'type' => 'array', - 'items' => [ - 'description' => '实例的主系列编码。', - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - ], - 'required' => false, - ], - ], - [ - 'name' => 'storageSecretKey', - 'in' => 'query', - 'schema' => [ - 'title' => '存储加密密钥Key', - 'description' => '存储加密密钥Key', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<MyPage<InstanceDTO>>', - 'description' => 'Result<MyPage<InstanceDTO>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => '84445A20-2B50-5306-A3C0-AF99FC1833C6', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果。', - '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' => '100', - ], - 'list' => [ - 'title' => '分页数据', - 'description' => '分页数据。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'instanceName' => [ - 'title' => '实例名称', - 'description' => '实例名称。', - 'type' => 'string', - 'example' => 'test instance', - ], - 'status' => [ - 'title' => '实例状态', - 'description' => '实例状态。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- RELEASED（已释放）'."\n" - .'- RUNNING（运行中）'."\n" - .'- STOPPED（已停服）'."\n" - .'- CHANGING（变更中）'."\n" - .'- CREATING（创建中）', - 'type' => 'string', - 'enumValueTitles' => [ - 'RELEASED' => '已释放', - 'RUNNING' => '运行中', - 'STOPPED' => '已停服', - 'CHANGING' => '变更中', - 'CREATING' => '创建中', - ], - 'example' => 'RUNNING', - 'enum' => [ - 'CREATING', - 'CHANGING', - 'RUNNING', - 'STOPPED', - 'RELEASED', - ], - ], - 'startTime' => [ - 'title' => '开服时间', - 'description' => '实例的创建时间。', - 'type' => 'string', - 'example' => '2022-08-01 00:00:00', - ], - 'expireTime' => [ - 'title' => '过期时间', - 'description' => '实例的到期时间。', - 'type' => 'string', - 'example' => '2022-09-01 00:00:00', - ], - 'releaseTime' => [ - 'title' => '释放时间', - 'description' => '实例的释放时间。', - 'type' => 'string', - 'example' => '2022-09-07 00:00:00', - ], - 'userId' => [ - 'title' => '所属人ID', - 'description' => '实例所属的用户ID。', - 'type' => 'string', - 'example' => '6W0xz2uPfiwp****', - ], - 'commodityCode' => [ - 'title' => '商品编码', - 'description' => '消息队列RocketMQ 5.x系列实例的商品代号，类似于ons_rmqsub_public_cn。', - 'type' => 'string', - 'example' => 'ons_rmqsub_public_cn', - ], - 'serviceCode' => [ - 'title' => '服务编码', - 'description' => '实例所属的服务编码。消息队列RocketMQ版的服务编码为rmq。', - 'type' => 'string', - 'example' => 'rmq', - ], - 'seriesCode' => [ - 'title' => '系列编码', - 'description' => '实例的主系列编码。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- standard：标准版'."\n" - .'- ultimate：铂金版'."\n" - .'- professional：专业版'."\n" - .'- shared: 共享版'."\n" - .'- dedicated：独享版', - 'type' => 'string', - 'enumValueTitles' => [ - 'standard' => '标准版', - 'ultimate' => '铂金版', - 'professional' => '专业版', - ], - 'example' => 'standard', - ], - 'subSeriesCode' => [ - 'title' => '子系列编码', - 'description' => '实例的子系列编码。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- cluster_ha：集群高可用版'."\n" - .'- single_node：单节点版'."\n" - .'- serverless： serverless版本', - 'type' => 'string', - 'enumValueTitles' => [ - 'cluster_ha' => '集群高可用版', - 'single_node' => '单节点版', - ], - 'example' => 'cluster_ha', - ], - 'paymentType' => [ - 'title' => '付费类型', - 'description' => '实例的付费类型。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- PayAsYouGo：按量付费（后付费）'."\n" - .'- Subscription：包年包月（预付费）', - 'type' => 'string', - 'enumValueTitles' => [ - 'PayAsYouGo' => '按量付费（后付费）', - 'Subscription' => '包年包月（预付费）', - ], - 'example' => 'Subscription', - 'enum' => [ - 'Subscription', - 'PayAsYouGo', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => '实例的备注信息。', - 'type' => 'string', - 'example' => 'This is remark for instance.', - ], - 'topicCount' => [ - 'title' => '主题数量', - 'description' => '实例中所创建的主题数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'groupCount' => [ - 'title' => '消费组数量', - 'description' => '实例中所创建的消费者分组的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '实例的版本更新时间。', - 'type' => 'string', - 'example' => '2022-08-01 00:00:00', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '实例的最后修改时间。', - 'type' => 'string', - 'example' => '2022-08-02 00:00:00', - ], - 'resourceGroupId' => [ - 'title' => '资源组ID', - 'description' => '实例所属的资源组ID。', - 'type' => 'string', - 'example' => 'rg-acfmx7caj******', - ], - 'tags' => [ - 'title' => '资源标签列表。', - 'description' => '资源标签列表。', - 'type' => 'array', - 'items' => [ - 'title' => '资源标签。', - 'description' => '资源标签。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '资源标签key值。', - 'description' => '资源标签key值。', - 'type' => 'string', - 'example' => 'key', - ], - 'value' => [ - 'title' => '资源标签value值。', - 'description' => '资源标签value值。', - 'type' => 'string', - 'example' => 'value', - ], - ], - ], - ], - 'productInfo' => [ - 'description' => '产品信息。', - 'type' => 'object', - 'properties' => [ - 'traceOn' => [ - 'description' => '是否开启消息轨迹功能。'."\n" - .'- true：开启消息轨迹功能'."\n" - .'- false：关闭消息轨迹功能'."\n" - ."\n" - .'<props="intl">该参数暂不生效，不管参数是否开启，实例都默认支持轨迹功能。</props>'."\n" - .'<props="china">该参数仅对Serverless类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见[Serverless计费说明](~~2586280~~)。</props>'."\n" - ."\n" - .'<props="china">对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。</props>', - 'type' => 'boolean', - 'example' => 'true', - ], - 'capacityType' => [ - 'description' => '容量模式:'."\n" - .' - provisioned： 预留+弹性'."\n" - .' - ondemand： 按量付费', - 'type' => 'string', - 'example' => 'provisioned', - ], - ], - ], - ], - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'MissingPageNumber', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Parameter pageNumber is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'PageNumber', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'pageNumber', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5F88833'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '查询实例列表', - 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>', - ], - 'GetInstance' => [ - 'summary' => '获取某个指定实例的详细信息。', - 'path' => '/instances/{instanceId}', - 'methods' => [ - 'get', + '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' => '创建访问权限', + '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}'], + ], + ], + ], ], + ], + 'CreateInstanceIpWhitelist' => [ + 'summary' => '创建访问控制IP白名单。', + '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' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例ID', - 'description' => '待查询实例的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', + 'description' => '请求体对象。', + 'type' => 'object', + 'properties' => [ + 'ipWhitelists' => [ + 'description' => 'IP白名单列表', + 'type' => 'array', + 'items' => ['description' => 'IP白名单', 'type' => 'string', 'required' => true, 'example' => '0.0.0.0/0'], + 'required' => true, + ], + ], + 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<InstanceDTO>', - 'description' => '返回数据。', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => '05AB7FBD-F1D3-5D87-BF78-BD782249****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'instanceName' => [ - 'title' => '实例名称', - 'description' => '实例名称。', - 'type' => 'string', - 'example' => 'test instance', - ], - 'status' => [ - 'title' => '实例状态', - 'description' => '实例状态。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- RELEASED：已释放'."\n" - .'- RUNNING：运行中'."\n" - .'- STOPPED：已停服'."\n" - .'- CHANGING：变更中'."\n" - .'- CREATING：创建中', - 'type' => 'string', - 'enumValueTitles' => [ - 'RELEASED' => '已释放', - 'RUNNING' => '运行中', - 'STOPPED' => '已停服', - 'CHANGING' => '变更中', - 'CREATING' => '创建中', - ], - 'example' => 'RUNNING', - 'enum' => [ - 'CREATING', - 'CHANGING', - 'RUNNING', - 'STOPPED', - 'RELEASED', - ], - ], - 'startTime' => [ - 'title' => '开服时间', - 'description' => '实例的启动时间。', - 'type' => 'string', - 'example' => '2022-08-01 00:00:00', - ], - 'expireTime' => [ - 'title' => '过期时间', - 'description' => '实例的到期时间。', - 'type' => 'string', - 'example' => '2022-09-01 00:00:00', - ], - 'releaseTime' => [ - 'title' => '释放时间', - 'description' => '实例的释放时间。', - 'type' => 'string', - 'example' => '2022-09-07 00:00:00', - ], - 'userId' => [ - 'title' => '所属人ID', - 'description' => '实例所属的用户ID。', - 'type' => 'string', - 'example' => '111111111111111', - ], - 'bid' => [ - 'title' => 'BID', - 'description' => '商品的售卖渠道BID。', - 'type' => 'string', - 'example' => '26842', - ], - 'commodityCode' => [ - 'title' => '商品编码', - 'description' => '消息队列RocketMQ 5.x系列实例的商品代号类似于ons_rmqsub_public_cn。', - 'type' => 'string', - 'example' => 'ons_rmqsub_public_cn', - ], - 'serviceCode' => [ - 'title' => '服务编码', - 'description' => '实例所属的服务编码。消息队列RocketMQ版的服务编码为rmq。', - 'type' => 'string', - 'example' => 'rmq', - ], - 'seriesCode' => [ - 'title' => '系列编码', - 'description' => '实例的主系列编码。主系列间的具体差异，请参见[产品选型](~~444722~~)。'."\n" - ."\n" - .' 参数取值如下：'."\n" - .'- standard：标准版'."\n" - .'- ultimate：铂金版'."\n" - .'- professional：专业版'."\n" - .'- shared: 共享版'."\n" - .'- dedicated：独享版', - 'type' => 'string', - 'enumValueTitles' => [ - 'standard' => '标准版', - 'shared' => '共享版', - 'dedicated' => '独享版', - 'ultimate' => '铂金版', - 'professional' => '专业版', - ], - 'example' => 'standard', - ], - 'subSeriesCode' => [ - 'title' => '子系列编码', - 'description' => '实例的子系列编码。子系列间的具体差异，请参见[产品选型](~~444722~~)。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- cluster_ha：集群高可用版'."\n" - .'- single_node：单节点版'."\n" - .'- serverless： serverless版本', - 'type' => 'string', - 'enumValueTitles' => [ - 'serverless' => 'serverless版本', - 'cluster_ha' => '集群高可用版', - 'single_node' => '单节点版', - ], - 'example' => 'cluster_ha', - ], - 'paymentType' => [ - 'title' => '付费类型', - 'description' => '实例的付费类型。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- PayAsYouGo：按量付费（后付费）'."\n" - .'- Subscription：包年包月（预付费）', - 'type' => 'string', - 'enumValueTitles' => [ - 'PayAsYouGo' => '按量付费（后付费）', - 'Subscription' => '包年包月（预付费）', - ], - 'example' => 'Subscription', - 'enum' => [ - 'Subscription', - 'PayAsYouGo', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => '实例的备注信息。', - 'type' => 'string', - 'example' => 'This is remark for instance.', - ], - 'networkInfo' => [ - 'title' => '网络信息', - 'description' => '网络信息。', - 'type' => 'object', - 'properties' => [ - 'vpcInfo' => [ - 'title' => '专有网络信息', - 'description' => '专有网络信息。', - 'type' => 'object', - 'properties' => [ - 'vpcId' => [ - 'title' => '专有网络ID', - 'description' => '实例所关联的专有网络的ID。', - 'type' => 'string', - 'example' => 'vpc-uf6of9452b2pba82c****', - ], - 'vSwitchId' => [ - 'title' => '交换机ID', - 'description' => '实例所关联的交换机ID。'."\n" - ."\n" - .'<notice>该字段不推荐使用，请使用vSwitches字段。此外，为了兼容，该字段目前只返回一个交换机。></notice>', - 'type' => 'string', - 'deprecated' => true, - 'example' => 'vsw-uf6gwtbn6etadpvz7****', - ], - 'vSwitches' => [ - 'title' => '交换机列表', - 'description' => '交换机列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'vSwitchId' => [ - 'title' => '交换机ID', - 'description' => '交换机ID', - 'type' => 'string', - 'example' => 'vsw-uf6gwtbn6etadpvz7****', - ], - 'zoneId' => [ - 'title' => '可用区ID', - 'description' => '可用区ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], - 'securityGroupIds' => [ - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-hp35r2hc3a3sv8q2sb16', - ], - ], - ], - 'endpoints' => [ - 'title' => '接入点列表', - 'description' => '接入点信息。', - 'type' => 'array', - 'items' => [ - 'description' => '接入点信息。', - 'type' => 'object', - 'properties' => [ - 'endpointType' => [ - 'title' => '接入点类型', - 'description' => '表示实例的接入点类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'TCP_VPC' => 'VPC接入点', - 'TCP_INTERNET' => '公网接入点', - ], - 'example' => 'TCP_INTERNET', - 'enum' => [ - 'TCP_INTERNET', - 'TCP_VPC', - ], - ], - 'endpointUrl' => [ - 'title' => '接入点地址', - 'description' => '实例的接入点。', - 'type' => 'string', - 'example' => 'rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080', - ], - 'ipWhitelist' => [ - 'description' => '公网访问IP白名单。仅公网接入点支持配置IP白名单，VPC接入点暂不支持。'."\n" - ."\n" - .'- 若不配置IP白名单，则默认放通所有IP地址段通过公网访问消息队列RocketMQ版服务端。'."\n" - .'- 若配置IP白名单，则仅允许白名单内的IP地址通过公网访问消息队列RocketMQ版服务端。'."\n" - ."\n" - .'该字段不再推荐使用，请使用internetInfo.ipWhitelist字段。', - 'type' => 'array', - 'items' => [ - 'description' => '公网访问IP白名单。', - 'type' => 'string', - 'example' => '192.168.x.x/24', - ], - 'example' => '192.168.x.x/24', - ], - 'endpointId' => [ - 'title' => '关联的pvl ep实例', - 'description' => '关联的pvl ep实例', - 'type' => 'string', - 'example' => 'ep-bpxxx', - ], - ], - ], - ], - 'internetInfo' => [ - 'title' => '公网信息', - 'description' => '实例公网信息。', - 'type' => 'object', - 'properties' => [ - 'internetSpec' => [ - 'title' => '是否开通公网', - 'description' => '是否开通公网访问。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- enable：开启公网访问'."\n" - .'- disable：关闭公网访问'."\n" - ."\n" - .'实例默认支持VPC访问方式，若开启公网访问，消息队列RocketMQ版会收取公网下行带宽费用。具体计费信息，请参见[公网访问费用](~~427240~~)。', - 'type' => 'string', - 'enumValueTitles' => [ - 'enable' => '开启公网访问', - 'disable' => '关闭公网访问', - ], - 'example' => 'enable', - ], - 'flowOutType' => [ - 'title' => '公网计费类型', - 'description' => '公网计费类型。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- payByBandwidth：固定带宽计费，开启公网访问时，设置为该参数值。'."\n" - .'- uninvolved：不涉及，未开启公网访问时，设置为该参数值。', - 'type' => 'string', - 'enumValueTitles' => [ - 'payByBandwidth' => '固定带宽计费', - 'uninvolved' => '不涉及', - ], - 'example' => 'payByBandwidth', - ], - 'flowOutBandwidth' => [ - 'title' => '公网带宽规格', - 'description' => '公网带宽规格。单位：1 Mb/s。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ipWhitelist' => [ - 'title' => '公网IP白名单列表', - 'description' => '公网访问IP白名单列表。'."\n" - ."\n" - .'- 若不配置IP白名单，则默认放通所有IP地址段通过公网访问消息队列RocketMQ版服务端。'."\n" - .'- 若配置IP白名单，则仅允许白名单内的IP地址通过公网访问消息队列RocketMQ版服务端。', - 'type' => 'array', - 'items' => [ - 'title' => '公网IP白名单', - 'description' => '公网访问IP白名单。', - 'type' => 'string', - 'example' => '192.168.x.x/24', - ], - ], - ], - ], - ], - ], - 'accountInfo' => [ - 'title' => '账号信息', - 'description' => '账号信息。', - 'type' => 'object', - 'properties' => [ - 'username' => [ - 'title' => '用户名', - 'description' => '实例的用户名。使用公网访问时，SDK代码中需要配置实例的用户名和密码，进行身份验证。', - 'type' => 'string', - 'example' => '6W0xz2uPfiwp****', - ], - ], - ], - 'instanceQuotas' => [ - 'title' => '容量信息', - 'description' => '容量信息。', - 'type' => 'array', - 'items' => [ - 'description' => '容量信息。', - 'type' => 'object', - 'properties' => [ - 'quotaName' => [ - 'title' => '配额名称', - 'description' => '实例的配额名称。'."\n" - ."\n" - .'参数取值如下：'."\n" - ."\n" - .'- TOPIC_COUNT：实例的Topic创建额度', - 'type' => 'string', - 'enumValueTitles' => [ - 'TOPIC_COUNT' => '实例的Topic创建额度', - ], - 'example' => 'TOPIC_COUNT', - ], - 'usedCount' => [ - 'title' => '已使用量', - 'description' => '已使用量。单位：个。', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'freeCount' => [ - 'title' => '免费', - 'description' => '免费额度。单位：个。', - 'type' => 'number', - 'format' => 'double', - 'example' => '20', - ], - 'totalCount' => [ - 'title' => '总配额', - 'description' => '总配额。单位：个。', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - ], - ], - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '实例的创建时间。', - 'type' => 'string', - 'example' => '2022-08-01 00:00:00 ', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '实例最后的修改时间。', - 'type' => 'string', - 'example' => '2022-08-02 00:00:00 ', - ], - 'extConfig' => [ - 'title' => '扩展配置，不再推荐使用，建议使用产品信息、网络信息中的字段替换', - 'description' => '扩展配置。该字段不再推荐使用，请使用productInfo、internetInfo、aclInfo等字段替代。', - 'type' => 'object', - 'properties' => [ - 'aclType' => [ - 'title' => '鉴权类型', - 'description' => '实例的鉴权类型。'."\n" - ."\n" - .'参数取值如下：'."\n" - .' '."\n" - .'- default：智能身份识别', - 'type' => 'string', - 'enumValueTitles' => [ - 'default' => '智能身份识别', - ], - 'example' => 'default', - 'enum' => [ - 'default', - 'aliyun_ram', - 'apache_acl', - ], - ], - 'sendReceiveRatio' => [ - 'title' => '消息收发比例', - 'description' => '消息发送和接收的比例。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'autoScaling' => [ - 'title' => '自适应弹性伸缩', - 'description' => '是否开启规格外突发弹性能力。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- true：开启弹性能力'."\n" - .'- false：不开启弹性能力'."\n" - ."\n" - .'仅当supportAutoScaling参数值为enable，即实例支持开启弹性能力，该参数才有效。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '开启弹性能力', - 'false' => '不开启弹性能力', - ], - 'example' => 'true', - ], - 'messageRetentionTime' => [ - 'title' => '消息保留时长', - 'description' => '消息保存时长。单位：小时。'."\n" - ."\n" - .'取值范围，请参见[使用限制](~~440347~~)>资源配额>消息保存时长的限制值。'."\n" - ."\n" - .'消息队列RocketMQ版的消息存储完全实现Serverless弹性，按照实际存储空间收取费用，您可以通过调整消息保存时长来控制消息的存储容量。更多信息，请参见[存储费用](~~427238~~)。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '72', - ], - 'supportAutoScaling' => [ - 'title' => '是否支持自适应弹性伸缩', - 'description' => '实例是否支持开启规格外突发弹性能力。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- true：支持开启弹性能力'."\n" - .'- false：不支持开启弹性能力'."\n" - ."\n" - .'开启弹性突发能力后，消息队列RocketMQ允许该实例在一定范围内超过基础规格限制的TPS，且超过基础规格外的部分，需要收取额外的弹性规格费用。具体计费信息，请参见[计算能力费用](~~427237~~)。'."\n" - ."\n\n" - .'> 仅部分规格的实例支持开启弹性突发规格能力，具体支持的实例，请参见[实例规格](~~444715~~)。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '支持开启弹性能力', - 'false' => '不支持开启弹性能力', - ], - 'example' => 'true', - ], - 'internetSpec' => [ - 'title' => '是否开通公网', - 'description' => '是否开通公网访问。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- enable：开通公网访问'."\n" - .'- disable：关闭公网访问'."\n" - ."\n" - .'实例默认支持VPC访问方式，若开启公网访问，消息队列RocketMQ版会收取公网下行带宽费用。具体计费信息，请参见[公网访问费用](~~427240~~)。', - 'type' => 'string', - 'enumValueTitles' => [ - 'enable' => '开通公网访问', - 'disable' => '关闭公网访问', - ], - 'example' => 'enable', - 'enum' => [ - 'enable', - 'disable', - ], - ], - 'flowOutType' => [ - 'title' => '公网计费类型', - 'description' => '公网计费类型。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- payByTraffic：按流量计费'."\n" - .'- payByBandwidth：按带宽计费'."\n" - .'- uninvolved：不涉及', - 'type' => 'string', - 'enumValueTitles' => [ - 'payByTraffic' => '按流量计费', - 'payByBandwidth' => '按带宽计费', - 'uninvolved' => '不涉及', - ], - 'example' => 'payByBandwidth', - 'enum' => [ - 'uninvolved', - 'payByTraffic', - 'payByBandwidth', - ], - ], - 'flowOutBandwidth' => [ - 'title' => '公网带宽规格', - 'description' => '公网带宽规格。单位：Mb/s。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'msgProcessSpec' => [ - 'title' => '消息收发计算规格', - 'description' => '消息收发计算规格。具体消息收发TPS上限，请参见[实例规格](~~444715~~)。', - 'type' => 'string', - 'example' => 'rmq.s2.2xlarge', - ], - ], - 'deprecated' => true, - ], - 'resourceGroupId' => [ - 'title' => '资源组ID', - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-acfm3tmjruyribi', - ], - 'productInfo' => [ - 'title' => '产品信息', - 'description' => '实例的扩展配置。', - 'type' => 'object', - 'properties' => [ - 'msgProcessSpec' => [ - 'title' => '消息收发规格', - 'description' => '消息收发计算规格。具体消息收发TPS上限，请参见[实例规格](~~444715~~)。', - 'type' => 'string', - 'example' => 'rmq.s2.2xlarge', - ], - 'sendReceiveRatio' => [ - 'title' => '消息收发比例', - 'description' => '消息发送和接收的比例。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'autoScaling' => [ - 'title' => '是否开启弹性伸缩', - 'description' => '是否开启规格外突发弹性能力。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- true：支持开启弹性能力'."\n" - .'- false：不支持开启弹性能力'."\n" - ."\n" - .'仅当supportAutoScaling参数值为enable，即实例支持开启弹性能力，该参数才有效。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '开启弹性能力', - 'false' => '不开启弹性能力', - ], - 'example' => 'true', - ], - 'messageRetentionTime' => [ - 'title' => '消息保留时长', - 'description' => '消息保存时长。单位：小时。'."\n" - ."\n" - .'取值范围，请参见[使用限制](~~440347~~)>资源配额>消息保存时长的限制值。'."\n" - ."\n" - .'消息队列RocketMQ版的消息存储完全实现Serverless弹性，按照实际存储空间收取费用，您可以通过调整消息保存时长来控制消息的存储容量。更多信息，请参见[存储费用](~~427238~~)。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '72', - ], - 'supportAutoScaling' => [ - 'title' => '是否支持弹性伸缩', - 'description' => '是否支持开启规格外突发弹性能力。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- true：支持开启弹性能力'."\n" - .'- false：不支持开启弹性能力'."\n" - ."\n" - .'开启弹性突发能力后，消息队列RocketMQ允许该实例在一定范围内超过基础规格限制的TPS，且超过基础规格外的部分，需要收取额外的弹性规格费用。具体计费信息，请参见[计算能力费用](~~427237~~)。'."\n" - ."\n\n" - .'> 仅部分规格的实例支持开启弹性突发规格能力，具体支持的实例，请参见[实例规格](~~444715~~)。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '支持开启弹性能力', - 'false' => '不支持开启弹性能力', - ], - 'example' => 'true', - ], - 'traceOn' => [ - 'description' => '是否开启消息轨迹功能。'."\n" - .'- true：开启消息轨迹功能'."\n" - .'- false：关闭消息轨迹功能'."\n" - ."\n" - .'<props="intl">该参数暂不生效，不管参数是否开启，实例都默认支持轨迹功能。</props>'."\n" - .'<props="china">该参数仅对Serverless类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见[Serverless计费说明](~~2586280~~)。</props>'."\n" - ."\n" - .'<props="china">对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。</props>', - 'type' => 'boolean', - 'example' => 'true', - ], - 'storageEncryption' => [ - 'title' => '是否开启存储加密', - 'description' => '是否开启存储加密', - 'type' => 'boolean', - 'example' => 'false', - ], - 'storageSecretKey' => [ - 'title' => '存储加密密钥Key', - 'description' => '存储加密密钥Key', - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'capacityType' => [ - 'description' => '容量模式:'."\n" - .' - provisioned： 预留+弹性'."\n" - .' - ondemand： 按量付费', - 'type' => 'string', - 'enumValueTitles' => [ - 'provisioned' => '预留+弹性', - 'ondemand' => '按量付费', - ], - 'example' => 'provisioned', - ], - 'provisionedCapacity' => [ - 'description' => '预留容量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3000', - ], - ], - ], - 'aclInfo' => [ - 'title' => '访问控制信息', - 'description' => '访问控制信息。', - 'type' => 'object', - 'properties' => [ - 'aclTypes' => [ - 'description' => '实例的鉴权类型列表。', - 'type' => 'array', - 'items' => [ - 'description' => '实例的鉴权类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'default' => '智能身份识别', - 'apache_acl' => 'ACL身份识别', - ], - 'example' => 'default', - ], - ], - 'defaultVpcAuthFree' => [ - 'description' => '内网免身份识别开关。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '开启', - 'false' => '关闭', - ], - 'example' => 'true', - ], - 'aclType' => [ - 'description' => '实例的鉴权类型。已废弃，推荐使用aclTypes字段', - 'type' => 'string', - 'deprecated' => true, - 'enumValueTitles' => [ - 'default' => '智能身份识别', - 'apache_acl' => 'ACL身份识别', - ], - 'example' => 'default', - ], - ], - ], - 'software' => [ - 'title' => '实例软件信息', - 'description' => '实例软件信息。', - 'type' => 'object', - 'properties' => [ - 'softwareVersion' => [ - 'title' => '软件版本', - 'description' => '软件版本。', - 'type' => 'string', - 'example' => '5.0-rmq-20230619-1', - ], - 'maintainTime' => [ - 'title' => '升级时间段', - 'description' => '升级时间段。', - 'type' => 'string', - 'example' => '02:00-06:00', - ], - 'upgradeMethod' => [ - 'title' => '升级方式，auto自动升级，manual手动升级', - 'description' => '升级方式。'."\n" - ."\n" - .'参数取值如下'."\n" - ."\n" - .'- auto：自动升级'."\n" - .'- manual：手动升级', - 'type' => 'string', - 'enumValueTitles' => [ - 'auto' => '自动升级', - 'maunal' => '手动升级', - ], - 'example' => 'auto', - ], - ], - ], - 'topicCount' => [ - 'title' => '主题数量', - 'description' => '主题数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'groupCount' => [ - 'title' => '消费组数量', - 'description' => '消费组数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'tags' => [ - 'title' => '资源标签列表。', - 'description' => '资源标签列表。', - 'type' => 'array', - 'items' => [ - 'title' => '资源标签。', - 'description' => '资源标签。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '资源标签key值。', - 'description' => '资源标签key值。', - 'type' => 'string', - 'example' => 'key', - ], - 'value' => [ - 'title' => '资源标签value值。', - 'description' => '资源标签value值。', - 'type' => 'string', - 'example' => 'value', - ], - ], - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'A07B41BD-6DD3-5349-9E76-00303DF04BBE'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'InstanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '创建IP白名单', + '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' => '获取指定实例的详情', - 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>', ], 'CreateTopic' => [ 'summary' => '创建云消息队列 RocketMQ 版的主题（Topic）。主题是云消息队列 RocketMQ 版中消息传输和存储的顶层容器，用于标识同一类业务逻辑的消息。在消息收发模型中，生产者将消息发送至主题，消费者通过订阅指定的主题来消费其中的消息。', 'path' => '/instances/{instanceId}/topics/{topicName}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2412,39 +1221,25 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREonsHZ457W', - ], + 'abilityTreeNodes' => ['FEATUREonsHZ457W'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => '待创建主题所属的实例的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['title' => '实例ID', 'description' => '待创建主题所属的实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'topicName', 'in' => 'path', - 'schema' => [ - 'title' => '主题名称', - 'description' => '待创建主题的名称，用于标识主题，全局唯一。'."\n" - ."\n" - .'取值规范如下：'."\n" - ."\n" - .'- 字符限制：支持字母a\\~z或A\\~Z、数字0~9以及下划线（_）、短划线（-）。'."\n" - .'- 长度限制：1~60个字符。'."\n" - ."\n" - .'保留字符限制，请参见[参数限制](~~440347~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'topic_test', - ], + 'schema' => ['title' => '主题名称', 'description' => '待创建主题的名称，用于标识主题，全局唯一。'."\n" + ."\n" + .'取值规范如下：'."\n" + ."\n" + .'- 字符限制：支持字母a\\~z或A\\~Z、数字0~9以及下划线（_）、短划线（-）。'."\n" + .'- 长度限制：1~60个字符。'."\n" + ."\n" + .'保留字符限制，请参见[参数限制](~~440347~~)。', 'type' => 'string', 'required' => true, 'example' => 'topic_test'], ], [ 'name' => 'body', @@ -2462,49 +1257,17 @@ .'><notice>主题的类型和发送消息的类型必须一致。例如，您创建的主题的类型为顺序消息，则该主题只能用于收发顺序消息，不能收发其他类型的消息。></notice>', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'TRANSACTION' => '事务消息', - 'FIFO' => '顺序消息', - 'DELAY' => '定时/延时消息', - 'LITE' => '轻量主题消息', - 'NORMAL' => '普通消息', - ], + 'enumValueTitles' => ['TRANSACTION' => '事务消息', 'FIFO' => '顺序消息', 'DELAY' => '定时/延时消息', 'LITE' => '轻量主题消息', 'NORMAL' => '普通消息'], 'example' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'FIFO', - 'DELAY', - 'TRANSACTION', - 'LITE', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => '待创建主题的备注信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is the remark for test.', - ], - 'maxSendTps' => [ - 'description' => '发送消息tps上限', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1500', - ], - 'liteTopicExpiration' => [ - 'title' => 'liteTopic过期时间，单位：分钟'."\n" - .'取值范围：15-720。'."\n" - .'默认-1，表示永久存在', - 'description' => 'lite类型的Topic过期时间，单位：分钟'."\n" - .'取值范围：30-720。'."\n" - .'默认-1，表示永久存在', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - 'default' => '-1', - ], + 'enum' => ['NORMAL', 'FIFO', 'DELAY', 'TRANSACTION', 'LITE'], + ], + 'remark' => ['title' => '备注', 'description' => '待创建主题的备注信息。', 'type' => 'string', 'required' => false, 'example' => 'This is the remark for test.'], + 'maxSendTps' => ['description' => '发送消息tps上限', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1500'], + 'liteTopicExpiration' => ['title' => 'liteTopic过期时间，单位：分钟'."\n" + .'取值范围：15-720。'."\n" + .'默认-1，表示永久存在', 'description' => 'lite类型的Topic过期时间，单位：分钟'."\n" + .'取值范围：30-720。'."\n" + .'默认-1，表示永久存在', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'default' => '-1'], ], 'required' => false, ], @@ -2517,72 +1280,45 @@ 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Topic.Existed', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'The topic already exists.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'TopicName', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'topicName', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'Topic.Existed'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'The topic already exists.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'TopicName'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'topicName'], ], ], ], ], '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' => '创建主题', - ], - 'UpdateTopic' => [ - 'summary' => '更新主题的备注信息。', - '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' => [ + 'summary' => '删除指定的消费者分组。', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', + 'methods' => ['delete'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], @@ -2590,76 +1326,104 @@ ], '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' => '实例ID', 'description' => '待删除的消费者分组所属的实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => ['title' => '消费组ID', 'description' => '待删除的消费者分组的ID。', 'type' => 'string', 'required' => true, 'example' => 'CID-TEST'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例ID', - 'description' => '待更新主题所属的实例的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'C7F94090-3358-506A-97DC-34BC803C****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'InvalidConsumerGroupId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter consumerGroupId is invalid.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'ConsumerGroupId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', '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' => '删除消费者分组', + 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>'."\n" + ."\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' => [ + 'summary' => '删除消费者组订阅关系。', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'topicName', + 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => ['description' => '待删除的消费者分组的ID。', 'type' => 'string', 'required' => true, 'example' => 'CID-TEST'], + ], + [ + 'name' => 'topicName', + 'in' => 'query', + 'schema' => ['description' => '主题名称。', 'type' => 'string', 'required' => true, 'example' => 'topic_test'], + ], + [ + 'name' => 'filterType', + 'in' => 'query', 'schema' => [ - 'title' => '主题名称', - 'description' => '待更新的主题的名称。', + 'description' => '过滤表达式类型。'."\n" + ."\n" + .'- SQL：SQL过滤'."\n" + .'- TAG：Tag过滤。', 'type' => 'string', 'required' => true, - 'example' => 'topic_test', + 'enumValueTitles' => ['TAG' => 'TAG过滤', 'SQL' => 'SQL过滤'], + 'example' => 'TAG', ], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '', - 'description' => '请求体结构。', - 'type' => 'object', - 'properties' => [ - 'remark' => [ - 'title' => '备注', - 'description' => '更新后的主题备注信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is the remark for test.', - ], - 'maxSendTps' => [ - 'description' => '发送消息tps上限', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], - 'liteTopicExpiration' => [ - 'title' => 'liteTopic过期时间，单位：分钟'."\n" - .'取值范围：15-720。'."\n" - .'默认-1，表示永久存在', - 'description' => 'lite类型的Topic过期时间，单位：分钟'."\n" - .'取值范围：15-720。'."\n" - .'默认-1，表示永久存在', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => false, - ], + 'name' => 'filterExpression', + 'in' => 'query', + 'schema' => ['description' => '过滤表达式', 'type' => 'string', 'required' => true, 'example' => '*'], ], ], 'responses' => [ @@ -2669,104 +1433,63 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'The topic cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'TopicName', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'topicName', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '723CDA5C-E25C-5EAF-9601-08C286DF8A4D'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '200'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => [ - 'summary' => '删除指定主题。', - 'path' => '/instances/{instanceId}/topics/{topicName}', - 'methods' => [ - 'delete', + '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' => '删除消费者组订阅关系', + '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' => [ + 'summary' => '删除备份映射任务。', + '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' => '待删除主题所属的实例的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '备份计划id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016'], ], [ - 'name' => 'topicName', + 'name' => 'itemId', 'in' => 'path', - 'schema' => [ - 'title' => '主题名称', - 'description' => '待删除主题的名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'topic_test', - ], + 'schema' => ['description' => '映射任务id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100000650'], ], ], 'responses' => [ @@ -2776,557 +1499,313 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'The topic cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'TopicName', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'topicName', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '0B962390-D84B-5D44-8C11-79DFxxxx'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DisasterRecoveryItemStatus.Error'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The current status of the disaster recovery item does not support this operation.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '删除主题', - 'description' => '删除主题将导致该主题下的所有发布订阅关系同时被清理，请慎重调用。', - ], - 'ListTopics' => [ - 'summary' => '查询指定实例下的主题列表信息。', - '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' => '删除备份映射任务', + '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' => [ + 'summary' => '删除备份计划。', + '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' => '备份计划id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例ID', - 'description' => '指定需要获取哪个实例下的主题列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'."\n"], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DisasterRecoveryPlanStatus.Error'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The current status of the disaster recovery plan does not support this operation.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '删除备份计划', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDisasterRecoveryPlan'], + ], + ], + 'ramActions' => [ [ - 'name' => 'filter', - 'in' => 'query', - 'schema' => [ - 'title' => '过滤条件', - 'description' => '查询的过滤条件，若不输入则查询该实例下所有的主题。', - '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' => [ + 'summary' => '释放实例。', + 'path' => '/instances/{instanceId}', + 'methods' => ['delete'], + 'schemes' => ['https', 'http'], + 'security' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页页码', - 'description' => '分页页码，查询第几页的返回结果。', - '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' => '实例ID', 'description' => '待删除实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody0129'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '分页大小', - 'description' => '分页大小，每页最多显示的返回结果数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '10', - 'example' => '3', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => '048242AA-BADA-5F29-B2CD-ED9FA344467F'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'instanceId'], + ], ], ], - [ - 'name' => 'messageTypes', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '主题的消息类型。', - 'type' => 'array', - 'items' => [ - 'description' => '需要查询实例下哪种类型的主题。若不输入，则查询实例下的所有主题。'."\n" - .'参数取值如下：'."\n" - .'- TRANSACTION：事务消息'."\n" - .'- FIFO：顺序消息'."\n" - .'- DELAY：定时/延时消息'."\n" - .'- NORMAL：普通消息'."\n" - .'- LITE: 轻量类型', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TRANSACTION' => '事务消息', - 'FIFO' => '顺序消息', - 'DELAY' => '定时/延时消息', - 'LITE' => '轻量类型', - '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' => '删除实例', + 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>'."\n" + ."\n" + .'- 实例删除后将无法恢复，请慎重操作。'."\n" + ."\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' => [ + 'summary' => '删除指定实例下的访问账号信息。', + '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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], + ], + [ + 'name' => 'username', + 'in' => 'path', + 'schema' => ['description' => '账号名称', 'type' => 'string', 'required' => true, 'example' => 'xxx'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<MyPage<TopicDTO>>', - 'description' => 'Result<MyPage<TopicDTO>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果。', - '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', - ], - 'list' => [ - 'title' => '分页数据', - 'description' => '分页数据。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'title' => 'Topic编码', - 'description' => '主题名称。', - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageType' => [ - 'title' => '消息类型,MessageTypeEnum[UNSPECIFIED,NORMAL(普通),FIFO(顺序),DELAY(延迟),TRANSACTION(事务),UNRECOGNIZED(无法识别),code,desc]', - 'description' => '主题的消息类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'TRANSACTION' => '事务消息', - 'FIFO' => '顺序消息', - 'DELAY' => '定时/延时消息', - 'NORMAL' => '普通消息', - ], - 'example' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'FIFO', - 'DELAY', - 'TRANSACTION', - ], - ], - 'status' => [ - 'title' => 'Topic状态,TopicStatusEnum[CREATING(创建中),RUNNING(运行中),code,desc]', - 'description' => '主题的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RUNNING' => '运行中', - 'CREATING' => '创建中', - ], - 'example' => 'RUNNING', - 'enum' => [ - 'CREATING', - 'RUNNING', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => '主题的备注信息。', - 'type' => 'string', - 'example' => 'This is the remark for test.', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '主题的最后修改时间。', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'maxSendTps' => [ - 'description' => '发送消息tps上限', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'liteTopicExpiration' => [ - 'title' => 'liteTopic过期时间，单位：分钟', - 'description' => 'lite类型Topic过期时间，单位：分钟', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - ], - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'The topic cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'TopicName', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'topicName', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '157DF7D4-53FB-58C6-BEBC-A9400E7EF68A'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'InstanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '查询主题列表', - ], - 'GetTopic' => [ - 'summary' => '获取某个指定主题的详细信息。', - 'path' => '/instances/{instanceId}/topics/{topicName}', - 'methods' => [ - 'get', + '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' => '删除访问账号', + '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' => [ + 'summary' => '删除指定实例下，指定账号和资源的权限。', + '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' => '待查询主题所属的实例的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'topicName', + 'name' => 'username', 'in' => 'path', + 'schema' => ['description' => '用户名称', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', 'schema' => [ - 'title' => '主题名称', - 'description' => '待查询主题的名称。', + 'description' => '授权的资源类型', 'type' => 'string', 'required' => true, - 'example' => 'topic_test', + 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], + 'example' => 'Topic', ], ], + [ + 'name' => 'resourceName', + 'in' => 'query', + 'schema' => ['description' => '授权的资源名称', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<TopicDTO>', - 'description' => 'Result<TopicDTO>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '主题所属实例的ID。', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'title' => 'Topic编码', - 'description' => '主题名称。', - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageType' => [ - 'title' => '消息类型,MessageTypeEnum[UNSPECIFIED,NORMAL(普通),FIFO(顺序),DELAY(延迟),TRANSACTION(事务),UNRECOGNIZED(无法识别),code,desc]', - 'description' => '主题的消息类型', - 'type' => 'string', - 'enumValueTitles' => [ - 'TRANSACTION' => '事务消息', - 'FIFO' => '顺序消息', - 'DELAY' => '定时消息/延时消息', - 'LITE' => '轻量主题消息', - 'NORMAL' => '普通消息', - ], - 'example' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'FIFO', - 'DELAY', - 'TRANSACTION', - ], - ], - 'status' => [ - 'title' => '主题状态', - 'description' => '主题的状态。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- RUNNING：运行中'."\n" - .'- CREATING：创建中', - 'type' => 'string', - 'enumValueTitles' => [ - 'RUNNING' => '运行中', - 'CREATING' => '创建中', - ], - 'example' => 'RUNNING', - 'enum' => [ - 'CREATING', - 'RUNNING', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => '主题的备注信息。', - 'type' => 'string', - 'example' => 'This is the remark for test.'."\n", - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '主题的创建时间。', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '主题的最后修改时间。', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'maxSendTps' => [ - 'description' => '发送消息tps上限', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'liteTopicExpiration' => [ - 'title' => 'liteTopic过期时间，单位：分钟', - 'description' => 'liteTopic过期时间，单位：分钟', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'The topic cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'TopicName', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'topicName', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '7358418D-83BD-507A-8079-611C63E05674'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '获取指定主题的详情', - ], - 'CreateConsumerGroup' => [ - 'summary' => '创建云消息队列 RocketMQ 版的消费者分组（ConsumerGroup）。消费者分组是云消息队列 RocketMQ 版系统中承载多个消费行为一致的消费者的负载均衡分组。消费者需要通过指定消费者分组订阅相关的主题来实现消息订阅。', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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' => '删除访问权限', + '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' => [ + 'summary' => '删除指定实例下的指定全局IP白名单。', + 'path' => '/instances/{instanceId}/ip/whitelist', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3335,164 +1814,95 @@ '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' => '待创建的消费者分组所属的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'consumerGroupId', - 'in' => 'path', + 'name' => 'ipWhitelist', + 'in' => 'query', + 'schema' => ['description' => 'IP白名单。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '0.0.0.0/0'], + ], + [ + 'name' => 'ipWhitelists', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'title' => '消费组ID', - 'description' => '待创建的消费者分组的ID。用于标识消费者分组，全局唯一。'."\n" - ."\n" - .'取值说明如下：'."\n" - ."\n" - .'- 字符限制：支持字母a\\~z或A\\~Z、数字0\\~9以及下划线（_）、短划线（-）。'."\n" - .'- 长度限制：1~60个字符。'."\n" - ."\n" - .'保留字符限制，请参见[参数限制](~~440347~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'GID_test_groupId', + 'description' => 'ip白名单列表', + 'type' => 'array', + 'items' => ['description' => 'ip白名单', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0'], + 'required' => false, ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体对象。', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'remark' => [ - 'title' => '备注', - 'description' => '待创建消费者分组的备注信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is the remark for test.', - ], - 'deliveryOrderType' => [ - 'title' => '投递顺序性', - 'description' => '待创建消费者分组的投递顺序性。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- Concurrently：并发投递'."\n" - .'- Orderly：顺序投递', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Concurrently' => '并发投递', - 'Orderly' => '顺序投递', - ], - 'example' => 'Concurrently', - 'enum' => [ - 'Orderly', - 'Concurrently', - ], - ], - 'consumeRetryPolicy' => [ - 'title' => '消费重试策略', - 'description' => '待创建消费者分组的消费重试策略。更多信息，请参见'."\n" - .'[消费重试](~~440356~~)。', - 'type' => 'object', - 'properties' => [ - 'maxRetryTimes' => [ - 'title' => '最大重试次数', - 'description' => '最大重试次数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '16', - ], - 'retryPolicy' => [ - 'title' => '重试策略类型', - 'description' => '重试策略类型。更多信息，请参见[消息重试](~~440356~~)。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- FixedRetryPolicy：固定间隔重试，仅支持顺序投递'."\n" - .'- DefaultRetryPolicy：阶梯退避重试，仅支持并发投递', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'FixedRetryPolicy' => '固定间隔重试', - 'DefaultRetryPolicy' => '阶梯退避重试', - ], - 'example' => 'DefaultRetryPolicy', - 'enum' => [ - 'DefaultRetryPolicy', - 'FixedRetryPolicy', - ], - ], - 'deadLetterTargetTopic' => [ - 'description' => '死信Topic。'."\n" - ."\n" - .'消费者出现异常消费某条消息失败，且消息重试后依然未成功，消息将被投递至死信Topic中，以便后续进行业务恢复或回溯。更多信息，请参见[消费重试与死信](~~440356~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'DLQ_mqtest', - ], - 'fixedIntervalRetryTime' => [ - 'description' => '固定重试间隔，单位：秒。重试策略为FixedRetryPolicy固定间隔重试策略时生效'."\n" - .'取值范围：'."\n" - .' - 并发投递：10-1800'."\n" - .' - 顺序投递：1-600', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => true, - ], - 'maxReceiveTps' => [ - 'description' => '消费消息tps上限', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], - 'messageModel' => [ - 'title' => '消费模式', - 'description' => '消费者对消息的消费模式：'."\n" - .' - CLUSTERING'."\n" - .' - LITE_SELECTIVE', - 'type' => 'string', - 'required' => false, - 'example' => 'LITE_SELECTIVE', - 'default' => 'CLUSTERING', - 'enum' => [ - 'CLUSTERING', - 'LITE_SELECTIVE', - ], - ], - 'topicName' => [ - 'title' => 'lite类型的topicName', - 'description' => 'LITE_SELECTIVE 消费模式时，需要订阅的lite类型的topic名称', - 'type' => 'string', - 'required' => false, - 'example' => 'liteTopicTest', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '16425867-C948-5A0C-9A24-5259727BE727'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'InstanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '删除IP白名单', + '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' => [ + 'summary' => '删除指定主题。', + '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' => '实例ID', 'description' => '待删除主题所属的实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => ['title' => '主题名称', 'description' => '待删除主题的名称。', 'type' => 'string', 'required' => true, 'example' => 'topic_test'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -3500,73 +1910,41 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'InvalidConsumerGroupId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Parameter consumerGroupId is invalid.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'ConsumerGroupId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'consumerGroupId', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'The topic cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'TopicName'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', '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' => '创建消费者分组', - 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>', - ], - 'UpdateConsumerGroup' => [ - 'summary' => '更新消费者分组的基础信息和消费重试策略。', - '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' => '删除主题', + 'description' => '删除主题将导致该主题下的所有发布订阅关系同时被清理，请慎重调用。', + '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' => '指定的迁移任务执行指定的操作。', + 'path' => '/migrations/{migrationId}/stages/{stageType}/operations/{operationId}/execute', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3574,126 +1952,66 @@ ], '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' => '迁移ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '44'], + ], + [ 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-x0r37kel***'], + ], + [ + 'name' => 'stageType', 'in' => 'path', 'schema' => [ - 'title' => '实例ID', - 'description' => '待更新消费者分组所属的实例的ID。', + 'description' => '迁移阶段类型。', 'type' => 'string', 'required' => true, - 'example' => 'rmq-cn-7e22on9****', + 'enumValueTitles' => ['MIGRATE_MESSAGE' => '消息迁移'], + 'example' => 'MIGRATE_MESSAGE', ], ], [ - 'name' => 'consumerGroupId', + 'name' => 'operationId', 'in' => 'path', - 'schema' => [ - 'title' => '消费组ID', - 'description' => '待更新的消费者分组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'CID-TEST', - ], + 'schema' => ['description' => '迁移操作ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2729'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体。', + 'description' => '请求体结构。', 'type' => 'object', 'properties' => [ - 'remark' => [ - 'title' => '备注', - 'description' => '更新后的消费者分组的备注信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is the remark for test.', - ], - 'deliveryOrderType' => [ - 'title' => '投递顺序性', - 'description' => '不支持修改', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Concurrently', - 'enum' => [ - 'Concurrently', - 'Orderly', - ], - ], - 'consumeRetryPolicy' => [ - 'title' => '消费重试策略', - 'description' => '更新后的消费者分组的消费重试策略。更多信息，请参见'."\n" - .'[消费重试](~~440356~~)。', + 'operationParam' => [ + 'title' => '操作参数', + 'description' => '操作参数', 'type' => 'object', 'properties' => [ - 'retryPolicy' => [ - 'title' => '重试策略类型', - 'description' => '重试策略类型。更多信息，请参见[消息重试](~~440356~~)。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- FixedRetryPolicy：固定间隔重试，仅支持顺序投递'."\n" - .'- DefaultRetryPolicy：阶梯退避重试，仅支持并发投递', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'FixedRetryPolicy' => '固定间隔重试', - 'DefaultRetryPolicy' => '阶梯退避重试', - ], - 'example' => 'DefaultRetryPolicy', - 'enum' => [ - 'DefaultRetryPolicy', - 'FixedRetryPolicy', - ], - ], - 'maxRetryTimes' => [ - 'title' => '最大重试次数', - 'description' => '最大重试次数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '16', - ], - 'deadLetterTargetTopic' => [ - 'description' => '死信Topic。'."\n" - ."\n" - .'消费者出现异常消费某条消息失败，且消息重试后依然未成功，消息将被投递至死信Topic中，以便后续进行业务恢复或回溯。更多信息，请参见[消费重试与死信](~~440356~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'DLQ_mqtest', - ], - 'fixedIntervalRetryTime' => [ - 'description' => '固定重试间隔，单位：秒。重试策略为FixedRetryPolicy固定间隔重试策略时生效'."\n" - .'取值范围：'."\n" - .' - 并发投递：10-1800'."\n" - .' - 顺序投递：1-600', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'paramData' => ['title' => '参数信息', 'description' => '参数信息，参数类型为json字符串，参考示例。'."\n" + ."\n" + .'action（操作）字段枚举值如下：'."\n" + .'- MIGRATE_FORWARD(迁移前进)'."\n" + .'- MIGRATE_BACKWARD(迁移回退)'."\n" + ."\n" + .'targetStage（目标阶段）字段枚举值如下：'."\n" + .' - MIGRATE_WAIT(读写源集群)'."\n" + .' - DOUBLE_READ(写源集群冗余读)'."\n" + .' - SWITCH_WRITE(写目标集群冗余读)'."\n" + .' - MIGRATE_FINISH(读写目标集群)'."\n" + ."\n\n" + .'> '."\n" + .'> - 关于迁移前进，只能按照顺序逐个阶段向前推进。'."\n" + .'> - 关于迁移回滚，可以回滚至之前的任何一个阶段。', 'type' => 'any', 'required' => false, 'example' => 'Migrate forward: {"action":"MIGRATE_FORWARD","targetStage":"MIGRATE_FINISH"}'."\n" + ."\n" + .'Migrate backward: {"action":"MIGRATE_BACKWARD","targetStage":"MIGRATE_WAIT"}'], ], - 'required' => true, - ], - 'maxReceiveTps' => [ - 'description' => '消费消息tps上限', - 'type' => 'integer', - 'format' => 'int64', 'required' => false, - 'example' => '1000', ], ], 'required' => false, @@ -3703,77 +2021,102 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<MigrationOperationDTO>', + 'description' => 'Result<MigrationOperationDTO>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'C7F94090-3358-506A-97DC-34BC803C****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '814BCD66-2D76-5080-AAD2-E50E5BDB0995'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', - 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'InvalidDeliveryOrderType', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Parameter deliveryOrderType is invalid.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'DeliveryOrderType', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'deliveryOrderType', + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'operationId' => ['title' => '迁移操作ID', 'description' => '迁移操作ID', 'type' => 'integer', 'format' => 'int64', 'example' => '110'], + 'migrationId' => ['title' => '迁移ID', 'description' => '迁移ID', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'stageType' => [ + 'title' => '迁移阶段类型', + 'description' => '迁移阶段类型', + 'type' => 'string', + 'enumValueTitles' => ['MIGRATE_MESSAGE' => '迁移消息'], + 'example' => 'MIGRATE_MESSAGE', + ], + 'operationType' => ['title' => '操作类型,MigrationOperationTypeEnum[IMPORT_TOPIC(导入主题),IMPORT_CONSUMER_GROUP(导入消费者组),CONNECT_NETWORK(网络打通),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(迁移消息),code(编码),desc(描述),param(参数类型),result(结果类型)]', 'description' => '操作类型。', 'type' => 'string', 'example' => 'MIGRATE_MESSAGE'], + 'operationStatus' => [ + 'title' => '操作状态,MigrationOperationStatusEnum[INIT(未开始),DOING(执行中),DONE(已完成),FAIL(已失败),code(编码),desc(描述)]', + 'description' => '操作状态。', + 'type' => 'string', + 'enumValueTitles' => ['INIT' => '未开始', 'DONE' => '已完成', 'DOING' => '执行中', 'FAIL' => '已失败'], + 'example' => 'DOING', + ], + 'operationKey' => ['title' => '操作对象主键', 'description' => '操作对象主键', 'type' => 'string', 'example' => 'normal-topic-1'], + 'businessStatus' => [ + 'title' => '操作业务状态,ConnectNetworkBusinessStatusEnum[CONNECT_PENDING(等待打通),CONNECT_DOING(打通中),CONNECT_SUCCESS(打通成功),CONNECT_FAILURE(打通失败),code,desc]', + 'description' => '操作业务状态。', + 'type' => 'string', + 'enumValueTitles' => ['MIGRATE_CHECK' => '读写源集群', 'SWITCH_WRITE' => '写目标集群冗余读', 'MIGRATE_FINISH' => '读写目标集群', 'DOUBLE_READ' => '写源集群冗余读', 'ALREADY_MIGRATED' => '已迁移'], + 'example' => 'MIGRATE_WAIT', + ], + 'operationParam' => [ + 'title' => '操作参数', + 'description' => '操作参数', + 'type' => 'object', + 'properties' => [ + 'paramData' => ['title' => '参数信息', 'description' => '参数信息', 'type' => 'any', 'example' => '{"action":"MIGRATE_FORWARD","targetStage":"MIGRATE_FINISH"}'], + ], + ], + 'operationResult' => [ + 'title' => '操作结果', + 'description' => '操作结果', + 'type' => 'object', + 'properties' => [ + 'resultData' => ['title' => '操作结果', 'description' => '操作结果', 'type' => 'any', 'example' => '{'."\n" + .' "checkStatus": "WAIT_CHECK",'."\n" + .' "sourceTopicStatus": "PERM_6",'."\n" + .' "targetTopicStatus": "PERM_4",'."\n" + .' "checkResult": {},'."\n" + .' "migrateStage": "DOUBLE_READ"'."\n" + .'}'], + ], + ], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'updateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + ], ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The topic already exists.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => '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' => '更新消费者分组', - 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>', - ], - 'DeleteConsumerGroup' => [ - 'summary' => '删除指定的消费者分组。', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - 'http', + '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' => '执行迁移操作', + '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}'], + ], + ], + ], ], + ], + 'FinishMigrationStage' => [ + 'summary' => '指定的迁移任务完成当前迁移阶段。', + 'path' => '/migrations/{migrationId}/stages/{stageType}/finish', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3781,30 +2124,27 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'migrationId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => '待删除的消费者分组所属的实例的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '迁移ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'consumerGroupId', + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-pe334f1nx04'], + ], + [ + 'name' => 'stageType', 'in' => 'path', 'schema' => [ - 'title' => '消费组ID', - 'description' => '待删除的消费者分组的ID。', + 'description' => '迁移阶段类型，消息迁移(MIGRATE_MESSAGE)', 'type' => 'string', 'required' => true, - 'example' => 'CID-TEST', + 'enumValueTitles' => ['MIGRATE_MESSAGE' => '消息迁移'], + 'example' => 'MIGRATE_MESSAGE', ], ], ], @@ -3815,75 +2155,42 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'C7F94090-3358-506A-97DC-34BC803C****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'InvalidConsumerGroupId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Parameter consumerGroupId is invalid.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'ConsumerGroupId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'consumerGroupId', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '16425867-C948-5A0C-9A24-5259727BE727'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + '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' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], - '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' => '删除消费者分组', - 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>'."\n" - ."\n" - .'删除指定消费者分组后，由该消费者分组标识的消费者客户端将无法消费消息，请慎重调用本接口。', - ], - 'ListConsumerGroups' => [ - 'summary' => '查询指定实例下消费者分组的列表信息。', - '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' => '完成当前迁移阶段', + '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' => [], @@ -3892,242 +2199,85 @@ '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' => '指定需要获取哪个实例下的消费者分组列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'filter', - 'in' => 'query', - 'schema' => [ - 'title' => '过滤条件', - 'description' => '查询的过滤条件，若不输入则查询指定实例下所有的消费者分组。', - 'type' => 'string', - 'required' => false, - 'example' => 'CID-TEST', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页页码', - 'description' => '分页页码，查询第几页的返回结果。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => ['description' => '消费者分组ID。', 'type' => 'string', 'required' => true, 'example' => 'CID-TEST'], ], [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => '分页大小，每页最多显示的返回结果数量。'."\n" - ."\n" - .'取值范围：[10,100]。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - ], + 'name' => 'topicName', + 'in' => 'path', + 'schema' => ['description' => '消费者分组订阅的主题名称。', 'type' => 'string', 'required' => true, 'example' => 'topicxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<MyPage<ConsumerGroupDTO>>', - 'description' => 'Result<MyPage<ConsumerGroupDTO>>', + 'title' => 'Schema of Response', + 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => '5503A460-98ED-5543-92CF-4853DE28****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80'], + 'success' => ['description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果。', + 'description' => '返回结果', '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' => '分页数据。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'consumerGroupId' => [ - 'title' => '消费组ID', - 'description' => '消费者分组ID。', - 'type' => 'string', - 'example' => 'GID-TEST', - ], - 'status' => [ - 'title' => '消费组状态', - 'description' => '消费者分组的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RUNNING' => '运行中', - 'CREATING' => '创建中', - ], - 'example' => 'RUNNING', - 'enum' => [ - 'CREATING', - 'RUNNING', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => '消费者分组的备注信息。', - 'type' => 'string', - 'example' => 'This is the remark for test.', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '消费者分组的创建时间。', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '消费者分组的最后更新时间。', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'maxReceiveTps' => [ - 'description' => '消费消息tps上限', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'messageModel' => [ - 'title' => '消费模式', - 'description' => '消费模式', - 'type' => 'string', - 'example' => 'LITE_SELECTIVE', - ], - 'topicName' => [ - 'title' => 'lite类型的topicName', - 'description' => 'lite类型的topicName', - 'type' => 'string', - 'example' => 'test1', - ], - ], - ], - ], + 'instanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'topicName' => ['description' => '指定消费者分组订阅的主题。', 'type' => 'string', 'example' => 'topic_test'], + 'consumerGroupId' => ['description' => '消费者分组的ID。', 'type' => 'string', 'example' => 'CID-TEST'], + 'minTimestamp' => ['description' => '整个 Topic 目前最早存储的消息的生产时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026222'], + 'maxTimestamp' => ['description' => '整个 Topic 目前最新存储的消息的生产时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026833'], + 'consumeTimestamp' => ['description' => '当前 Group 消费该 Topic 的最新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026400'], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Parameter InstanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['description' => '动态错误码。', 'type' => 'string', 'example' => 'xxx'], + 'dynamicMessage' => ['description' => '动态错误信息', 'type' => 'string', 'example' => 'xxx'], ], ], ], ], - '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' => '查询消费者分组列表', - 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询Topic可重置时间范围', + 'summary' => '查询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' => '获取某个指定消费者分组的详细信息。', 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4140,32 +2290,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '144684', - 'abilityTreeNodes' => [ - 'FEATUREonsJCXOZ6', - ], + 'abilityTreeNodes' => ['FEATUREonsJCXOZ6'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => '待查询消费者分组所属的实例的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['title' => '实例ID', 'description' => '待查询消费者分组所属的实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'consumerGroupId', 'in' => 'path', - 'schema' => [ - 'title' => '消费者组ID', - 'description' => '待查询消费者分组的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'CID-TEST', - ], + 'schema' => ['title' => '消费者组ID', 'description' => '待查询消费者分组的ID。', 'type' => 'string', 'required' => true, 'example' => 'CID-TEST'], ], ], 'responses' => [ @@ -4175,86 +2311,34 @@ 'description' => 'Result<ConsumerGroupDTO>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'C7F94090-3358-506A-97DC-34BC803C****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'C7F94090-3358-506A-97DC-34BC803C****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '消费者分组所属的实例的ID。', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'consumerGroupId' => [ - 'title' => '消费组ID', - 'description' => '消费者分组的ID。', - 'type' => 'string', - 'example' => 'CID-TEST', - ], + 'regionId' => ['title' => '区域ID', 'description' => '实例所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '消费者分组所属的实例的ID。', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'consumerGroupId' => ['title' => '消费组ID', 'description' => '消费者分组的ID。', 'type' => 'string', 'example' => 'CID-TEST'], 'status' => [ 'title' => '消费组状态', 'description' => '消费者分组的状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'RUNNING' => '运行中', - 'CREATING' => '创建中', - ], + 'enumValueTitles' => ['RUNNING' => '运行中', 'CREATING' => '创建中'], 'example' => 'RUNNING', - 'enum' => [ - 'CREATING', - 'RUNNING', - ], - ], - 'remark' => [ - 'title' => '备注', - 'description' => '消费者分组的备注信息。', - 'type' => 'string', - 'example' => 'This is the remark for test.', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '消费者分组的创建时间。', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '消费者分组的最后更新时间。', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', + 'enum' => ['CREATING', 'RUNNING'], ], + 'remark' => ['title' => '备注', 'description' => '消费者分组的备注信息。', 'type' => 'string', 'example' => 'This is the remark for test.'], + 'createTime' => ['title' => '创建时间', 'description' => '消费者分组的创建时间。', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'updateTime' => ['title' => '修改时间', 'description' => '消费者分组的最后更新时间。', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], 'deliveryOrderType' => [ 'title' => '投递顺序性', 'description' => '消费者分组的投递顺序性。', 'type' => 'string', - 'enumValueTitles' => [ - 'Concurrently' => '并发投递', - 'Orderly' => '顺序投递', - ], + 'enumValueTitles' => ['Concurrently' => '并发投递', 'Orderly' => '顺序投递'], 'example' => 'Concurrently', - 'enum' => [ - 'Orderly', - 'Concurrently', - ], + 'enum' => ['Orderly', 'Concurrently'], ], 'consumeRetryPolicy' => [ 'title' => '消费重试策略', @@ -4266,272 +2350,66 @@ 'title' => '重试策略类型', 'description' => '重试策略类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'FixedRetryPolicy' => '固定间隔重试', - 'DefaultRetryPolicy' => '阶梯退避重试', - ], + 'enumValueTitles' => ['FixedRetryPolicy' => '固定间隔重试', 'DefaultRetryPolicy' => '阶梯退避重试'], 'example' => 'DefaultRetryPolicy', - 'enum' => [ - 'DefaultRetryPolicy', - 'FixedRetryPolicy', - ], + 'enum' => ['DefaultRetryPolicy', 'FixedRetryPolicy'], ], - 'maxRetryTimes' => [ - 'title' => '最大重试次数', - 'description' => '最大重试次数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'deadLetterTargetTopic' => [ - 'description' => '死信Topic。'."\n" - ."\n" - .'消费者出现异常消费某条消息失败，且消息重试后依然未成功，消息将被投递至死信Topic中，以便后续进行业务恢复或回溯。更多信息，请参见[消费重试与死信](~~440356~~)。', - 'type' => 'string', - 'example' => 'DLQ_mqtest', - ], - 'fixedIntervalRetryTime' => [ - 'description' => '固定重试间隔，取之范围，单位：秒'."\n" - .' - Concurrently(并发投递)：10-1800'."\n" - .' - Orderly(顺序投递): 1-600', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - 'maxReceiveTps' => [ - 'description' => '消费消息tps上限', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2000', - ], - 'messageModel' => [ - 'title' => '消费模式：'."\n" - .' CLUSTERING：集群消费'."\n" - .' LITE_SELECTIVE：LITE_SELECTIVE', - 'description' => '消费模式：'."\n" - .' - CLUSTERING：集群消费 '."\n" - .' - LITE_SELECTIVE：LITE_SELECTIVE', - 'type' => 'string', - 'example' => 'LITE_SELECTIVE', - ], - 'topicName' => [ - 'title' => 'lite类型的topicName', - 'description' => 'lite类型的topicName', - 'type' => 'string', - 'example' => 'test1', - ], + 'maxRetryTimes' => ['title' => '最大重试次数', 'description' => '最大重试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'deadLetterTargetTopic' => ['description' => '死信Topic。'."\n" + ."\n" + .'消费者出现异常消费某条消息失败，且消息重试后依然未成功，消息将被投递至死信Topic中，以便后续进行业务恢复或回溯。更多信息，请参见[消费重试与死信](~~440356~~)。', 'type' => 'string', 'example' => 'DLQ_mqtest'], + 'fixedIntervalRetryTime' => ['description' => '固定重试间隔，取之范围，单位：秒'."\n" + .' - Concurrently(并发投递)：10-1800'."\n" + .' - Orderly(顺序投递): 1-600', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + ], + ], + 'maxReceiveTps' => ['description' => '消费消息tps上限', 'type' => 'integer', 'format' => 'int64', 'example' => '2000'], + 'messageModel' => ['title' => '消费模式：'."\n" + .' CLUSTERING：集群消费'."\n" + .' LITE_SELECTIVE：LITE_SELECTIVE', 'description' => '消费模式：'."\n" + .' - CLUSTERING：集群消费 '."\n" + .' - LITE_SELECTIVE：LITE_SELECTIVE', 'type' => 'string', 'example' => 'LITE_SELECTIVE'], + 'topicName' => ['title' => 'lite类型的topicName', 'description' => 'lite类型的topicName', 'type' => 'string', 'example' => 'test1'], + 'exclusive' => ['title' => '是否排他消费', 'description' => '是否排他消费', 'type' => 'boolean', 'example' => 'false'], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'InvalidConsumerGroupId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Parameter consumerGroupId is invalid.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'ConsumerGroupId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'consumerGroupId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'InvalidConsumerGroupId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter consumerGroupId is invalid.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'ConsumerGroupId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'consumerGroupId'], ], ], ], ], - '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' => '获取指定消费者分组详情', 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>', - ], - 'ListTopicSubscriptions' => [ - 'summary' => '查询主题订阅关系列表。', - 'path' => '/instances/{instanceId}/topics/{topicName}/subscriptions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConsumerGroup'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-zpr34udri0w', - ], - ], + 'ramActions' => [ [ - 'name' => 'topicName', - 'in' => 'path', - 'schema' => [ - 'description' => '主题名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'dev4-HMH_INSURANCE_NOMAL_TOPIC', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<List<SubscriptionDTO>>', - 'description' => 'Result<List<SubscriptionDTO>>', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '92A9BE4E-B794-50C8-979C-0456E4D32943', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'array', - 'items' => [ - 'description' => '主题订阅列表。', - 'type' => 'object', - 'properties' => [ - 'consumerGroupId' => [ - 'title' => '消费者组', - 'description' => '消费者组', - 'type' => 'string', - 'example' => 'CID-TEST', - ], - 'topicName' => [ - 'title' => '订阅主题', - 'description' => '订阅主题', - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageModel' => [ - 'title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', - 'description' => '消费者分组的消费模式。'."\n" - .'- BROADCASTING：广播模式'."\n" - .'- CLUSTERING：集群模式', - 'type' => 'string', - 'example' => 'BROADCASTING', - ], - 'subscriptionStatus' => [ - 'title' => '订阅状态,SubscriptionStatusEnum[ONLINE(在线),OFFLINE(离线),code,desc]', - 'description' => '订阅状态。'."\n" - .'- ONLINE：在线。消费者分组下如果有多个消费者，只要有一个消费者在线则显订阅状态为在线。'."\n" - .'- OFFLINE：离线。消费者分组下如果有多个消费者，所有消费者都处于离线时订阅状态才显示离线。', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'filterExpression' => [ - 'title' => '过滤表达式', - 'description' => '过滤表达式', - 'type' => 'string', - 'example' => '*', - ], - 'filterExpressionType' => [ - 'title' => '过滤表达式类型,SubscriptionExpressionTypeEnum[SQL(SQL过滤),TAG(TAG过滤),UNSPECIFIED(FILTER_TYPE_UNSPECIFIED 过滤类型未指定),code,desc]', - 'description' => '过滤表达式类型。'."\n" - .'- SQL：SQL过滤'."\n" - .'- TAG：Tag过滤。', - 'type' => 'string', - 'example' => 'SQL', - ], - 'consistency' => [ - 'description' => '订阅关系的一致性。'."\n" - .'- 订阅关系不一致为false。'."\n" - .'- 订阅关系一致为true。', - 'type' => 'string', - 'example' => 'true', - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'Topic', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + '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' => '查询主题订阅关系列表', ], - 'ListConsumerGroupSubscriptions' => [ - 'summary' => '查询消费组订阅关系列表。', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetConsumerGroupLag' => [ + 'summary' => '查询消费者组堆积信息。', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/lag', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4540,179 +2418,130 @@ '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' => '云消息队列 RocketMQ 版的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-tl32wwz1r05', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-2r42vrvde0j'], ], [ 'name' => 'consumerGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '消费者分组ID，表示需要查询哪个消费者分组的订阅关系。', - 'type' => 'string', - 'required' => true, - 'example' => 'PRINT_RETRY_CONSUMER', - ], + 'schema' => ['description' => '消费者分组ID。', 'type' => 'string', 'required' => true, 'example' => 'CID-TEST'], ], [ 'name' => 'topicName', 'in' => 'query', - 'schema' => [ - 'title' => '主题名称', - 'description' => '主题名称，不填则查询所有订阅关系。', - 'type' => 'string', - 'required' => false, - 'example' => 'topic_test', - ], + 'schema' => ['description' => '消费者分组订阅的主题名称。', 'type' => 'string', 'required' => false, 'example' => 'normal-topic-1'], + ], + [ + 'name' => 'liteTopicName', + 'in' => 'query', + 'schema' => ['title' => '轻量主题名称', 'description' => '轻量主题名称', 'type' => 'string', 'required' => false, 'example' => 'abc'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<SubscriptionDTO>>', - 'description' => 'Result<List<SubscriptionDTO>>', + 'title' => 'Result<ConsumerGroupLagDTO>', + 'description' => 'Result<ConsumerGroupLagDTO>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5F4D9D5F-625B-59FF-BD4F-DA8284575DB4', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'F5764C40-FB8C-53AE-B95D-96AB3D0E9375'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', - 'description' => '返回结果。', - 'type' => 'array', - 'items' => [ - 'description' => '消费者组订阅关系列表。', - 'type' => 'object', - 'properties' => [ - 'consumerGroupId' => [ - 'title' => '消费者组', - 'description' => '消费者分组ID。', - 'type' => 'string', - 'example' => 'CID-TEST', - ], - 'topicName' => [ - 'title' => '订阅主题', - 'description' => '指定消费者分组订阅的主题。', - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageModel' => [ - 'title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', - 'description' => '消费者分组的消费模式。'."\n" - .'- BROADCASTING：广播模式'."\n" - .'- CLUSTERING：集群模式', - 'type' => 'string', - 'example' => 'CLUSTERING', - ], - 'subscriptionStatus' => [ - 'title' => '订阅状态,SubscriptionStatusEnum[ONLINE(在线),OFFLINE(离线),code,desc]', - 'description' => '订阅状态。'."\n" - .'- ONLINE：在线。消费者分组下如果有多个消费者，只要有一个消费者在线则显订阅状态为在线。'."\n" - .'- OFFLINE：离线。消费者分组下如果有多个消费者，所有消费者都处于离线时订阅状态才显示离线。', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'filterExpression' => [ - 'title' => '过滤表达式', - 'description' => '过滤表达式。', - 'type' => 'string', - 'example' => '*', - ], - 'filterExpressionType' => [ - 'title' => '过滤表达式类型,SubscriptionExpressionTypeEnum[SQL(SQL过滤),TAG(TAG过滤),UNSPECIFIED(FILTER_TYPE_UNSPECIFIED 过滤类型未指定),code,desc]', - 'description' => '过滤表达式类型。'."\n" - .'- SQL：SQL过滤'."\n" - .'- TAG：Tag过滤。', - 'type' => 'string', - 'example' => 'SQL', + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['title' => '区域ID', 'description' => '区域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'consumerGroupId' => ['title' => '消费组ID', 'description' => '消费组ID', 'type' => 'string', 'example' => 'CID-TEST'], + 'totalLag' => [ + 'title' => '整体堆积量', + 'description' => '整体堆积量', + 'type' => 'object', + 'properties' => [ + 'readyCount' => ['title' => '就绪消息量', 'description' => '就绪消息量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'inflightCount' => ['title' => '处理中消息量', 'description' => '处理中消息量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'deliveryDuration' => ['title' => '投递延迟时间', 'description' => '投递延迟时间，单位：秒', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'lastConsumeTimestamp' => ['title' => '最新消费时间', 'description' => '最新消费时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1735629607846'], ], - 'topicCreated' => [ - 'description' => '是否创建了topic。', - 'type' => 'boolean', - 'example' => 'true', + ], + 'topicLagMap' => [ + 'title' => '各主题堆积量', + 'description' => '各主题堆积量', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'readyCount' => ['title' => '就绪消息量', 'description' => '就绪消息量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'inflightCount' => ['title' => '处理中消息量', 'description' => '处理中消息量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'deliveryDuration' => ['title' => '投递延迟时间', 'description' => '投递延迟时间，单位：秒', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'lastConsumeTimestamp' => ['type' => 'integer', 'format' => 'int64', 'example' => '1735629607846', 'description' => '最新消费时间'], + ], + 'description' => '整体消息量', ], - 'consistency' => [ - 'description' => '订阅关系的一致性。'."\n" - .'- 订阅关系不一致为false。'."\n" - .'- 订阅关系一致为true。', - 'type' => 'boolean', - 'example' => 'true', + ], + 'topicName' => ['title' => '订阅的topic名称', 'description' => '订阅的topic名称', 'type' => 'string', 'example' => 'test1'], + 'liteTopicLagMap' => [ + 'title' => '轻量主题的消费堆积', + 'description' => '轻量主题的消费堆积', + 'type' => 'object', + 'additionalProperties' => [ + 'title' => 'lite类型topic的消费堆积', + 'description' => 'lite类型topic的消费堆积', + 'type' => 'object', + 'properties' => [ + 'readyCount' => ['title' => '堆积消息量', 'description' => '堆积消息量', 'type' => 'integer', 'format' => 'int64', 'example' => '300'], + 'deliveryDuration' => ['title' => '投递延迟时间，单位：秒', 'description' => '投递延迟时间，单位：秒', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + ], ], ], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'InstanceId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + ], + ], + ], + ], + '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' => '查询消费者组堆积信息', + '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' => '查询消费者组订阅关系列表', ], 'GetConsumerGroupSubscription' => [ 'summary' => '获取消费组订阅关系详情，包括客户端分布等信息。', 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions/{topicName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'methods' => ['get'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], @@ -4720,39 +2549,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-uqm32kqyy11', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-uqm32kqyy11'], ], [ 'name' => 'consumerGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '消费者分组ID，表示需要查询哪个消费者分组的订阅关系。', - 'type' => 'string', - 'required' => true, - 'example' => 'common_dev', - ], + 'schema' => ['description' => '消费者分组ID，表示需要查询哪个消费者分组的订阅关系。', 'type' => 'string', 'required' => true, 'example' => 'common_dev'], ], [ 'name' => 'topicName', 'in' => 'path', - 'schema' => [ - 'description' => '消费者分组订阅的主题名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'mq003', - ], + 'schema' => ['description' => '消费者分组订阅的主题名称。', 'type' => 'string', 'required' => true, 'example' => 'mq003'], ], ], 'responses' => [ @@ -4762,18 +2574,8 @@ 'description' => 'Result<List<SubscriptionDetailDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '157DF7D4-53FB-58C6-BEBC-A9400E7EF68A', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '157DF7D4-53FB-58C6-BEBC-A9400E7EF68A'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', @@ -4786,292 +2588,171 @@ 'description' => '订阅信息', 'type' => 'object', 'properties' => [ - 'consumerGroupId' => [ - 'title' => '消费者组', - 'description' => '消费者组', - 'type' => 'string', - 'example' => 'GID_inspector_group', - ], - 'topicName' => [ - 'title' => '订阅主题', - 'description' => '订阅主题', - 'type' => 'string', - 'example' => 'Topic_normal_inspector', - ], - 'messageModel' => [ - 'title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', - 'description' => '消费者分组的消费模式。'."\n" - .'- BROADCASTING：广播模式'."\n" - .'- CLUSTERING：集群模式', - 'type' => 'string', - 'example' => 'BROADCASTING', - ], - 'subscriptionStatus' => [ - 'title' => '订阅状态,SubscriptionStatusEnum[ONLINE(在线),OFFLINE(离线),code,desc]', - 'description' => '订阅状态。'."\n" - .'- ONLINE：在线。消费者分组下如果有多个消费者，只要有一个消费者在线则显订阅状态为在线。'."\n" - .'- OFFLINE：离线。消费者分组下如果有多个消费者，所有消费者都处于离线时订阅状态才显示离线。', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'filterExpression' => [ - 'title' => '过滤表达式', - 'description' => '过滤表达式', - 'type' => 'string', - 'example' => '*', - ], - 'filterExpressionType' => [ - 'title' => '过滤表达式类型,SubscriptionExpressionTypeEnum[SQL(SQL过滤),TAG(TAG过滤),UNSPECIFIED(FILTER_TYPE_UNSPECIFIED 过滤类型未指定),code,desc]', - 'description' => '过滤表达式类型。'."\n" - .'- SQL：SQL过滤'."\n" - .'- TAG：Tag过滤。', - 'type' => 'string', - 'example' => 'UNSPECIFIED', - ], + 'consumerGroupId' => ['title' => '消费者组', 'description' => '消费者组', 'type' => 'string', 'example' => 'GID_inspector_group'], + 'topicName' => ['title' => '订阅主题', 'description' => '订阅主题', 'type' => 'string', 'example' => 'Topic_normal_inspector'], + 'messageModel' => ['title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', 'description' => '消费者分组的消费模式。'."\n" + .'- BROADCASTING：广播模式'."\n" + .'- CLUSTERING：集群模式', 'type' => 'string', 'example' => 'BROADCASTING'], + 'subscriptionStatus' => ['title' => '订阅状态,SubscriptionStatusEnum[ONLINE(在线),OFFLINE(离线),code,desc]', 'description' => '订阅状态。'."\n" + .'- ONLINE：在线。消费者分组下如果有多个消费者，只要有一个消费者在线则显订阅状态为在线。'."\n" + .'- OFFLINE：离线。消费者分组下如果有多个消费者，所有消费者都处于离线时订阅状态才显示离线。', 'type' => 'string', 'example' => 'ONLINE'], + 'filterExpression' => ['title' => '过滤表达式', 'description' => '过滤表达式', 'type' => 'string', 'example' => '*'], + 'filterExpressionType' => ['title' => '过滤表达式类型,SubscriptionExpressionTypeEnum[SQL(SQL过滤),TAG(TAG过滤),UNSPECIFIED(FILTER_TYPE_UNSPECIFIED 过滤类型未指定),code,desc]', 'description' => '过滤表达式类型。'."\n" + .'- SQL：SQL过滤'."\n" + .'- TAG：Tag过滤。', 'type' => 'string', 'example' => 'UNSPECIFIED'], ], ], 'connectionDTO' => [ 'description' => '连接详情信息', 'type' => 'object', 'properties' => [ - 'clientId' => [ - 'title' => '客户端ID', - 'description' => '客户端ID', - 'type' => 'string', - 'example' => '192.168.50.191@19908#-2093249153#1534215565#40385215750900', - ], - 'hostname' => [ - 'title' => '主机名', - 'description' => '主机名', - 'type' => 'string', - 'example' => 'nginx', - ], - 'egressIp' => [ - 'title' => '宿主机IP/公网出网IP', - 'description' => '宿主机IP/公网出网IP', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'language' => [ - 'title' => '客户端语言', - 'description' => '客户端语言', - 'type' => 'string', - 'example' => 'zh', - ], - 'version' => [ - 'title' => '客户端版本', - 'description' => '客户端版本', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'messageModel' => [ - 'title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', - 'description' => '消费者分组的消费模式。'."\n" - .'- BROADCASTING：广播模式'."\n" - .'- CLUSTERING：集群模式', - 'type' => 'string', - 'example' => 'BROADCASTING', - ], + 'clientId' => ['title' => '客户端ID', 'description' => '客户端ID', 'type' => 'string', 'example' => '192.168.50.191@19908#-2093249153#1534215565#40385215750900'], + 'hostname' => ['title' => '主机名', 'description' => '主机名', 'type' => 'string', 'example' => 'nginx'], + 'egressIp' => ['title' => '宿主机IP/公网出网IP', 'description' => '宿主机IP/公网出网IP', 'type' => 'string', 'example' => 'xx.xx.xx.xx'], + 'language' => ['title' => '客户端语言', 'description' => '客户端语言', 'type' => 'string', 'example' => 'zh'], + 'version' => ['title' => '客户端版本', 'description' => '客户端版本', 'type' => 'string', 'example' => '1.0.0'], + 'messageModel' => ['title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', 'description' => '消费者分组的消费模式。'."\n" + .'- BROADCASTING：广播模式'."\n" + .'- CLUSTERING：集群模式', 'type' => 'string', 'example' => 'BROADCASTING'], ], ], ], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', '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' => '获取消费者组订阅关系详情', - ], - 'DeleteConsumerGroupSubscription' => [ - 'summary' => '删除消费者组订阅关系。', - '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' => [ + 'summary' => '获取消费者堆栈信息。', + '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' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-tl32upjeb08'], ], [ 'name' => 'consumerGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '待删除的消费者分组的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'CID-TEST', - ], - ], - [ - 'name' => 'topicName', - 'in' => 'query', - 'schema' => [ - 'description' => '主题名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'topic_test', - ], + 'schema' => ['description' => '消费者分组ID。', 'type' => 'string', 'required' => true, 'example' => 'GID_TT_TASK'], ], [ - 'name' => 'filterType', - 'in' => 'query', - 'schema' => [ - 'description' => '过滤表达式类型。'."\n" - ."\n" - .'- SQL：SQL过滤'."\n" - .'- TAG：Tag过滤。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'TAG' => 'TAG过滤', - 'SQL' => 'SQL过滤', - ], - 'example' => 'TAG', - ], - ], - [ - 'name' => 'filterExpression', + 'name' => 'clientId', 'in' => 'query', - 'schema' => [ - 'description' => '过滤表达式', - 'type' => 'string', - 'required' => true, - 'example' => '*', - ], + 'schema' => ['description' => '客户端ID', 'type' => 'string', 'required' => true, 'example' => '172.26.76.48@Lqd7dImlp9KJ5V84'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<ConsumerJstackDTO>', + 'description' => 'Result<ConsumerJstackDTO>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '723CDA5C-E25C-5EAF-9601-08C286DF8A4D', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '30F2CBC7-F69D-5D78-9661-0254C9E1FBFA'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['title' => '区域ID', 'description' => '区域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'consumerGroupId' => ['title' => '主题名称', 'description' => '消费者组ID', 'type' => 'string', 'example' => 'CID-TEST'], + 'stacks' => [ + 'title' => '堆栈信息', + 'description' => '堆栈信息', + 'type' => 'array', + 'items' => [ + 'description' => '消费堆栈信息', + 'type' => 'object', + 'properties' => [ + 'thread' => ['title' => '线程ID', 'description' => '线程ID', 'type' => 'string', 'example' => '123'], + 'tracks' => [ + 'title' => '堆栈信息', + 'description' => '堆栈信息', + 'type' => 'array', + 'items' => ['description' => '堆栈信息', 'type' => 'string', 'example' => 'xxx'], + ], + ], + ], + ], + ], ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', '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' => '删除消费者组订阅关系', - ], - 'ListConsumerConnections' => [ - 'summary' => '获取指定消费者客户端的连接信息。', - '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' => '获取消费者堆栈信息', + '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' => [ + 'summary' => '查询备份计划映射详情。', + 'path' => '/disaster_recovery/{planId}/items/{itemId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5080,199 +2761,119 @@ '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' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-uax32mf9h1f', - ], + 'schema' => ['description' => '备份计划id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016'], ], [ - 'name' => 'consumerGroupId', + 'name' => 'itemId', 'in' => 'path', - 'schema' => [ - 'description' => '消费者分组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'GID_TEST_STOCK_OPEND_GW', - ], - ], - [ - 'name' => 'topicName', - 'in' => 'query', - 'schema' => [ - 'title' => 'lite类型的topic名称', - 'description' => 'lite类型的topic名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], - ], - [ - 'name' => 'liteTopicName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Lite消息队列主题名称', - 'description' => 'Lite消息队列主题名称', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => '映射任务id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100070284'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<ConsumerConnectionsDTO>', - 'description' => 'Result<ConsumerConnectionsDTO>', + 'title' => 'Result<DisasterRecoveryItemDTO>', + 'description' => 'Result<DisasterRecoveryItemDTO>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => '区域ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'consumerGroupId' => [ - 'title' => '主题名称', - 'description' => '消费者组ID', - 'type' => 'string', - 'example' => 'CID-TEST', - ], - 'connections' => [ - 'title' => '客户端连接列表', - 'description' => '客户端连接列表', + 'itemId' => ['description' => '备份计划id', 'type' => 'integer', 'format' => 'int64', 'example' => '100070284'], + 'planId' => ['title' => '容灾Item所在容灾计划ID', 'description' => '映射id', 'type' => 'integer', 'format' => 'int64', 'example' => '1300000016'], + 'itemStatus' => ['title' => '容灾Item状态,DisasterRecoveryItemStatusEnum[CREATING(创建中),CHANGING(变更中),RUNNING(运行中),MANUAL_STOPPED(人工停用),OVERDUE_STOPPED(欠费停用),code,desc]', 'description' => '备份映射状态：'."\n" + .' - CREATING(创建中)'."\n" + .' - CHANGING(变更中)'."\n" + .' - RUNNING(运行中)'."\n" + .' - MANUAL_STOPPED(人工停用)'."\n" + .' - OVERDUE_STOPPED(欠费停用)', 'type' => 'string', 'example' => 'RUNNING'], + 'topics' => [ + 'title' => '容灾Item所包含的容灾主题', + 'description' => '备份映射所包含的主题', 'type' => 'array', 'items' => [ - 'description' => '客户端连接列表。', + 'description' => '备份映射所包含的主题', 'type' => 'object', 'properties' => [ - 'clientId' => [ - 'title' => '客户端ID', - 'description' => '客户端ID', - 'type' => 'string', - 'example' => '172.17.135.197@17392#1936705963#551717232#9873695589062458', - ], - 'hostname' => [ - 'title' => '客户端IP', - 'description' => '客户端IP', - 'type' => 'string', - 'example' => 'vos', - ], - 'egressIp' => [ - 'title' => '宿主机IP/公网出网IP', - 'description' => '宿主机IP/公网出网IP', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'language' => [ - 'title' => '客户端语言', - 'description' => '客户端语言', - 'type' => 'string', - 'example' => 'java', - ], - 'version' => [ - 'title' => '客户端版本', - 'description' => '客户端版本', - 'type' => 'string', - 'example' => '1.0', - ], - 'messageModel' => [ - 'title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', - 'description' => '消费者对消息的消费模式：'."\n" - .' - CLUSTERING'."\n" - .' - LITE_SELECTIVE'."\n" - .' - BROADCASTING', + 'regionId' => ['description' => 'regionId', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceType' => ['title' => '实例类型', 'description' => '实例类型', 'type' => 'string', 'example' => 'ALIYUN_ROCKETMQ'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-wwo3xxx'], + 'topicName' => ['title' => '容灾主题名称', 'description' => '主题名称', 'type' => 'string', 'example' => 'order_push_xxx'], + 'consumerGroupId' => ['title' => '消费者组ID', 'description' => '消费者组ID', 'type' => 'string', 'deprecated' => true, 'example' => 'xxx_reserve_group'], + 'deliveryOrderType' => [ + 'description' => '消息投递到目标实例的顺序性。'."\n" + ."\n" + .'参数取值如下：'."\n" + .'- Concurrently：并发投递'."\n" + .'- Orderly：顺序投递', 'type' => 'string', - 'example' => 'BROADCASTING', + 'enumValueTitles' => ['Concurrently' => '并发投递', 'Orderly' => '顺序投递'], + 'example' => 'Concurrently', ], ], ], ], + 'extInfo' => [ + 'title' => '扩展信息', + 'description' => '扩展信息', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{}', 'description' => '扩展信息'], + ], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-06-24 02:57:31'], + 'updateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2024-09-26 02:13:10'], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingPageNumber', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '200'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'xxx'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '获取消费者客户端连接信息', - ], - 'GetConsumerGroupLag' => [ - 'summary' => '查询消费者组堆积信息。', - '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' => '查询备份映射详情', + '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' => [ + 'summary' => '查询备份计划详情。', + 'path' => '/disaster_recovery/{planId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5284,251 +2885,133 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '145824', - 'abilityTreeNodes' => [ - 'FEATUREonsJCXOZ6', - ], + 'abilityTreeCode' => '225054', + 'abilityTreeNodes' => ['FEATUREonsOVRH1R'], ], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-2r42vrvde0j', - ], - ], - [ - 'name' => 'consumerGroupId', + 'name' => 'planId', 'in' => 'path', - 'schema' => [ - 'description' => '消费者分组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'CID-TEST', - ], - ], - [ - 'name' => 'topicName', - 'in' => 'query', - 'schema' => [ - 'description' => '消费者分组订阅的主题名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'normal-topic-1', - ], - ], - [ - 'name' => 'liteTopicName', - 'in' => 'query', - 'schema' => [ - 'title' => '轻量主题名称', - 'description' => '轻量主题名称', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => '备份计划id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<ConsumerGroupLagDTO>', - 'description' => 'Result<ConsumerGroupLagDTO>', + 'title' => 'Result<DisasterRecoveryPlanDTO>', + 'description' => 'Result<DisasterRecoveryPlanDTO>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'F5764C40-FB8C-53AE-B95D-96AB3D0E9375', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '7358418D-83BD-507A-8079-611C63E0xxx'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => '区域ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'consumerGroupId' => [ - 'title' => '消费组ID', - 'description' => '消费组ID', - 'type' => 'string', - 'example' => 'CID-TEST', - ], - 'totalLag' => [ - 'title' => '整体堆积量', - 'description' => '整体堆积量', + 'planId' => ['title' => '计划ID', 'description' => '计划ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1300000016'], + 'planName' => ['title' => '计划名称', 'description' => '计划名称', 'type' => 'string', 'example' => 'xxx'], + 'planDesc' => ['title' => '计划描述', 'description' => '计划描述', 'type' => 'string', 'example' => 'xxxx'], + 'planType' => ['title' => '计划类型,DisasterRecoveryTypeEnum[ACTIVE_PASSIVE(灾备),ACTIVE_ACTIVE(双活),code,desc]', 'description' => '计划类型：'."\n" + .' - ACTIVE_PASSIVE(单向备份)'."\n" + .' - ACTIVE_ACTIVE(双向备份)', 'type' => 'string', 'example' => 'ACTIVE_PASSIVE'], + 'planStatus' => ['title' => '计划状态,DisasterRecoveryStatusEnum[CREATED(已创建),DELETED(已删除),code,desc]', 'description' => '计划状态：'."\n" + .' - CREATED(已创建)'."\n" + .' - RUNNING(运行中)'."\n" + .' - DELETED(已删除)', 'type' => 'string', 'example' => 'RUNNING'], + 'extInfo' => [ + 'title' => '扩展信息', + 'description' => '扩展信息', 'type' => 'object', - 'properties' => [ - 'readyCount' => [ - 'title' => '就绪消息量', - 'description' => '就绪消息量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'inflightCount' => [ - 'title' => '处理中消息量', - 'description' => '处理中消息量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'deliveryDuration' => [ - 'title' => '投递延迟时间', - 'description' => '投递延迟时间，单位：秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'lastConsumeTimestamp' => [ - 'title' => '最新消费时间', - 'description' => '最新消费时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1735629607846', - ], - ], + 'additionalProperties' => ['type' => 'string', 'example' => 'xxxx', 'description' => '扩展信息'], ], - 'topicLagMap' => [ - 'title' => '各主题堆积量', - 'description' => '各主题堆积量', - 'type' => 'object', - 'additionalProperties' => [ + 'instances' => [ + 'title' => '容灾计划参与实例', + 'description' => '备份计划参与实例', + 'type' => 'array', + 'items' => [ + 'description' => '备份计划参与实例', 'type' => 'object', 'properties' => [ - 'readyCount' => [ - 'title' => '就绪消息量', - 'description' => '就绪消息量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'inflightCount' => [ - 'title' => '处理中消息量', - 'description' => '处理中消息量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'deliveryDuration' => [ - 'title' => '投递延迟时间', - 'description' => '投递延迟时间，单位：秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'lastConsumeTimestamp' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1735629607846', - 'description' => '最新消费时间', + 'instanceType' => ['title' => '实例类型', 'description' => '实例类型', 'type' => 'string', 'example' => 'ALIYUN_ROCKETMQ'], + 'regionId' => ['title' => '实例所在区域', 'description' => '实例所在区域', 'type' => 'string', 'example' => 'cn-shanghai'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-gpz3qtcdxxx'], + 'instanceRole' => ['title' => '实例角色', 'description' => '实例角色', 'type' => 'string', 'example' => 'ACTIVE'], + 'authType' => ['title' => '认证方式', 'description' => '认证方式', 'type' => 'string', 'example' => 'ACL_AUTH'], + 'username' => ['title' => '认证用户名', 'description' => '认证用户名', 'type' => 'string', 'example' => 'xxx'], + 'password' => ['title' => '认证密码', 'description' => '认证密码', 'type' => 'string', 'example' => 'xxx'], + 'endpointUrl' => ['title' => '接入点地址', 'description' => '接入点地址', 'type' => 'string', 'example' => 'xxx'], + 'networkType' => ['title' => '网络类型', 'description' => '网络类型', 'type' => 'string', 'example' => 'TCP_INTERNET'], + 'vpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-wz9qt50xhtj9krb******'."\n"], + 'vSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID', 'type' => 'string', 'example' => 'vsw-uf6gwtbn6etadpv******'."\n"], + 'messageProperty' => [ + 'description' => '消息过滤属性', + 'type' => 'object', + 'properties' => [ + 'propertyKey' => ['description' => '属性key', 'type' => 'string', 'example' => 'xxx'], + 'propertyValue' => ['description' => '属性value', 'type' => 'string', 'example' => 'xxx'], + ], ], + 'securityGroupId' => ['description' => '安全组id', 'type' => 'string', 'example' => 'sg-bp17hpmgz9******'."\n"], + 'consumerGroupId' => ['description' => '消费者组ID，用于从源实例拉取消息。', 'type' => 'string', 'example' => 'GID_DS_XXX_YYY'], ], - 'description' => '整体消息量', ], ], - 'topicName' => [ - 'title' => '订阅的topic名称', - 'description' => '订阅的topic名称', - 'type' => 'string', - 'example' => 'test1', + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'updateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'autoSyncCheckpoint' => [ + 'description' => '是否开启消费进度自动同步。'."\n" + ."\n" + .'> 只有在开启消费进度同步时有效。即 `syncCheckpointEnabled`字段值为true。', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], + 'example' => 'true', ], - 'liteTopicLagMap' => [ - 'title' => '轻量主题的消费堆积', - 'description' => '轻量主题的消费堆积', - 'type' => 'object', - 'additionalProperties' => [ - 'title' => 'lite类型topic的消费堆积', - 'description' => 'lite类型topic的消费堆积', - 'type' => 'object', - 'properties' => [ - 'readyCount' => [ - 'title' => '堆积消息量', - 'description' => '堆积消息量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', - ], - 'deliveryDuration' => [ - 'title' => '投递延迟时间，单位：秒', - 'description' => '投递延迟时间，单位：秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - ], - ], + 'syncCheckpointEnabled' => [ + 'description' => '同步消费进度开关', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], + 'example' => 'true', ], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '200'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'xxx'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '查询消费者组堆积信息', - ], - 'GetConsumerStack' => [ - 'summary' => '获取消费者堆栈信息。', - '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' => '查询备份计划详情', + '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' => '获取某个指定实例的详细信息。', + 'path' => '/instances/{instanceId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5538,311 +3021,508 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147017', + 'abilityTreeNodes' => ['FEATUREonsHF2FLP'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-tl32upjeb08', - ], - ], - [ - 'name' => 'consumerGroupId', - 'in' => 'path', - 'schema' => [ - 'description' => '消费者分组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'GID_TT_TASK', - ], - ], - [ - 'name' => 'clientId', - 'in' => 'query', - 'schema' => [ - 'description' => '客户端ID', - 'type' => 'string', - 'required' => true, - 'example' => '172.26.76.48@Lqd7dImlp9KJ5V84', - ], + 'schema' => ['title' => '实例ID', 'description' => '待查询实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<ConsumerJstackDTO>', - 'description' => 'Result<ConsumerJstackDTO>', + 'title' => 'Result<InstanceDTO>', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '30F2CBC7-F69D-5D78-9661-0254C9E1FBFA', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => '05AB7FBD-F1D3-5D87-BF78-BD782249****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', - 'description' => '返回结果', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => '区域ID', + 'regionId' => ['title' => '区域ID', 'description' => '实例所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'instanceName' => ['title' => '实例名称', 'description' => '实例名称。', 'type' => 'string', 'example' => 'test instance'], + 'status' => [ + 'title' => '实例状态', + 'description' => '实例状态。', + 'type' => 'string', + 'enumValueTitles' => ['RELEASED' => '已释放', 'RUNNING' => '运行中', 'STOPPED' => '已停服', 'CHANGING' => '变更中', 'CREATING' => '创建中'], + 'example' => 'RUNNING', + 'enum' => ['CREATING', 'CHANGING', 'RUNNING', 'STOPPED', 'RELEASED'], + ], + 'startTime' => ['title' => '开服时间', 'description' => '实例的启动时间。', 'type' => 'string', 'example' => '2022-08-01 00:00:00'], + 'expireTime' => ['title' => '过期时间', 'description' => '实例的到期时间。', 'type' => 'string', 'example' => '2022-09-01 00:00:00'], + 'releaseTime' => ['title' => '释放时间', 'description' => '实例的释放时间。', 'type' => 'string', 'example' => '2022-09-07 00:00:00'], + 'userId' => ['title' => '所属人ID', 'description' => '实例所属的用户ID。', 'type' => 'string', 'example' => '111111111111111'], + 'bid' => ['title' => 'BID', 'description' => '商品的售卖渠道BID。', 'type' => 'string', 'example' => '26842'], + 'commodityCode' => ['title' => '商品编码', 'description' => '消息队列RocketMQ 5.x系列实例的商品代号类似于ons_rmqsub_public_cn。', 'type' => 'string', 'example' => 'ons_rmqsub_public_cn'], + 'serviceCode' => ['title' => '服务编码', 'description' => '实例所属的服务编码。消息队列RocketMQ版的服务编码为rmq。', 'type' => 'string', 'example' => 'rmq'], + 'seriesCode' => [ + 'title' => '系列编码', + 'description' => '实例的主系列编码。主系列间的具体差异，请参见[产品选型](~~444722~~)。', 'type' => 'string', - 'example' => 'cn-hangzhou', + 'enumValueTitles' => ['standard' => '标准版', 'shared' => '共享版', 'dedicated' => '独享版', 'ultimate' => '铂金版', 'professional' => '专业版'], + 'example' => 'standard', ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', + 'subSeriesCode' => [ + 'title' => '子系列编码', + 'description' => '实例的子系列编码。子系列间的具体差异，请参见[产品选型](~~444722~~)。', 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', + 'enumValueTitles' => ['serverless' => 'serverless版本', 'cluster_ha' => '集群高可用版', 'single_node' => '单节点版'], + 'example' => 'cluster_ha', ], - 'consumerGroupId' => [ - 'title' => '主题名称', - 'description' => '消费者组ID', + 'paymentType' => [ + 'title' => '付费类型', + 'description' => '实例的付费类型。', 'type' => 'string', - 'example' => 'CID-TEST', + 'enumValueTitles' => ['PayAsYouGo' => '按量付费（后付费）', 'Subscription' => '包年包月（预付费）'], + 'example' => 'Subscription', + 'enum' => ['Subscription', 'PayAsYouGo'], ], - 'stacks' => [ - 'title' => '堆栈信息', - 'description' => '堆栈信息', + 'remark' => ['title' => '备注', 'description' => '实例的备注信息。', 'type' => 'string', 'example' => 'This is remark for instance.'], + 'networkInfo' => [ + 'title' => '网络信息', + 'description' => '网络信息。', + 'type' => 'object', + 'properties' => [ + 'vpcInfo' => [ + 'title' => '专有网络信息', + 'description' => '专有网络信息。', + 'type' => 'object', + 'properties' => [ + 'vpcId' => ['title' => '专有网络ID', 'description' => '实例所关联的专有网络的ID。', 'type' => 'string', 'example' => 'vpc-uf6of9452b2pba82c****'], + 'vSwitchId' => ['title' => '交换机ID', 'description' => '实例所关联的交换机ID。'."\n" + ."\n" + .'<notice>该字段不推荐使用，请使用vSwitches字段。此外，为了兼容，该字段目前只返回一个交换机。></notice>', 'type' => 'string', 'deprecated' => true, 'example' => 'vsw-uf6gwtbn6etadpvz7****'], + 'vSwitches' => [ + 'title' => '交换机列表', + 'description' => '交换机列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'vSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID', 'type' => 'string', 'example' => 'vsw-uf6gwtbn6etadpvz7****'], + 'zoneId' => ['title' => '可用区ID', 'description' => '可用区ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], + 'description' => '', + ], + ], + 'securityGroupIds' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-hp35r2hc3a3sv8q2sb16'], + ], + ], + 'endpoints' => [ + 'title' => '接入点列表', + 'description' => '接入点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '接入点信息。', + 'type' => 'object', + 'properties' => [ + 'endpointType' => [ + 'title' => '接入点类型', + 'description' => '表示实例的接入点类型。', + 'type' => 'string', + 'enumValueTitles' => ['TCP_VPC' => 'VPC接入点', 'TCP_INTERNET' => '公网接入点'], + 'example' => 'TCP_INTERNET', + 'enum' => ['TCP_INTERNET', 'TCP_VPC'], + ], + 'endpointUrl' => ['title' => '接入点地址', 'description' => '实例的接入点。', 'type' => 'string', 'example' => 'rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080'], + 'ipWhitelist' => [ + 'description' => '公网访问IP白名单。仅公网接入点支持配置IP白名单，VPC接入点暂不支持。'."\n" + ."\n" + .'- 若不配置IP白名单，则默认放通所有IP地址段通过公网访问消息队列RocketMQ版服务端。'."\n" + .'- 若配置IP白名单，则仅允许白名单内的IP地址通过公网访问消息队列RocketMQ版服务端。'."\n" + ."\n" + .'该字段不再推荐使用，请使用internetInfo.ipWhitelist字段。', + 'type' => 'array', + 'items' => ['description' => '公网访问IP白名单。', 'type' => 'string', 'example' => '192.168.x.x/24'], + 'example' => '192.168.x.x/24', + ], + 'endpointId' => ['title' => '关联的pvl ep实例', 'description' => '关联的pvl ep实例', 'type' => 'string', 'example' => 'ep-bpxxx'], + ], + ], + ], + 'internetInfo' => [ + 'title' => '公网信息', + 'description' => '实例公网信息。', + 'type' => 'object', + 'properties' => [ + 'internetSpec' => [ + 'title' => '是否开通公网', + 'description' => '是否开通公网访问。'."\n" + ."\n" + .'实例默认支持VPC访问方式，若开启公网访问，消息队列RocketMQ版会收取公网下行带宽费用。具体计费信息，请参见[公网访问费用](~~427240~~)。', + 'type' => 'string', + 'enumValueTitles' => ['enable' => '开启公网访问', 'disable' => '关闭公网访问'], + 'example' => 'enable', + ], + 'flowOutType' => [ + 'title' => '公网计费类型', + 'description' => '公网计费类型。', + 'type' => 'string', + 'enumValueTitles' => ['payByBandwidth' => '固定带宽计费，开启公网访问时，设置为该参数值。', 'uninvolved' => '不涉及，未开启公网访问时，设置为该参数值。'], + 'example' => 'payByBandwidth', + ], + 'flowOutBandwidth' => ['title' => '公网带宽规格', 'description' => '公网带宽规格。单位：1 Mb/s。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ipWhitelist' => [ + 'title' => '公网IP白名单列表', + 'description' => '公网访问IP白名单列表。'."\n" + ."\n" + .'- 若不配置IP白名单，则默认放通所有IP地址段通过公网访问消息队列RocketMQ版服务端。'."\n" + .'- 若配置IP白名单，则仅允许白名单内的IP地址通过公网访问消息队列RocketMQ版服务端。', + 'type' => 'array', + 'items' => ['title' => '公网IP白名单', 'description' => '公网访问IP白名单。', 'type' => 'string', 'example' => '192.168.x.x/24'], + ], + ], + ], + ], + ], + 'accountInfo' => [ + 'title' => '账号信息', + 'description' => '账号信息。', + 'type' => 'object', + 'properties' => [ + 'username' => ['title' => '用户名', 'description' => '实例的用户名。使用公网访问时，SDK代码中需要配置实例的用户名和密码，进行身份验证。', 'type' => 'string', 'example' => '6W0xz2uPfiwp****'], + ], + ], + 'instanceQuotas' => [ + 'title' => '容量信息', + 'description' => '容量信息。', 'type' => 'array', 'items' => [ - 'description' => '消费堆栈信息', + 'description' => '容量信息。', 'type' => 'object', 'properties' => [ - 'thread' => [ - 'title' => '线程ID', - 'description' => '线程ID', + 'quotaName' => [ + 'title' => '配额名称', + 'description' => '实例的配额名称。', 'type' => 'string', - 'example' => '123', + 'enumValueTitles' => ['TOPIC_COUNT' => '实例的Topic创建额度'], + 'example' => 'TOPIC_COUNT', ], - 'tracks' => [ - 'title' => '堆栈信息', - 'description' => '堆栈信息', - 'type' => 'array', - 'items' => [ - 'description' => '堆栈信息', - 'type' => 'string', - 'example' => 'xxx', - ], + 'usedCount' => ['title' => '已使用量', 'description' => '已使用量。单位：个。', 'type' => 'number', 'format' => 'double', 'example' => '10'], + 'freeCount' => ['title' => '免费', 'description' => '免费额度。单位：个。', 'type' => 'number', 'format' => 'double', 'example' => '20'], + 'totalCount' => ['title' => '总配额', 'description' => '总配额。单位：个。', 'type' => 'number', 'format' => 'double', 'example' => '100'], + ], + ], + ], + 'createTime' => ['title' => '创建时间', 'description' => '实例的创建时间。', 'type' => 'string', 'example' => '2022-08-01 00:00:00 '], + 'updateTime' => ['title' => '修改时间', 'description' => '实例最后的修改时间。', 'type' => 'string', 'example' => '2022-08-02 00:00:00 '], + 'extConfig' => [ + 'title' => '扩展配置，不再推荐使用，建议使用产品信息、网络信息中的字段替换', + 'description' => '扩展配置。该字段不再推荐使用，请使用productInfo、internetInfo、aclInfo等字段替代。', + 'type' => 'object', + 'properties' => [ + 'aclType' => [ + 'title' => '鉴权类型', + 'description' => '实例的鉴权类型。', + 'type' => 'string', + 'enumValueTitles' => ['default' => '智能身份识别', 'apache_acl' => 'Apache RocketMQ ACL'], + 'example' => 'default', + 'enum' => ['default', 'aliyun_ram', 'apache_acl'], + ], + 'sendReceiveRatio' => ['title' => '消息收发比例', 'description' => '消息发送和接收的比例。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'autoScaling' => [ + 'title' => '自适应弹性伸缩', + 'description' => '是否开启规格外突发弹性能力。'."\n" + ."\n" + .'仅当supportAutoScaling参数值为enable，即实例支持开启弹性能力，该参数才有效。', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '开启弹性能力', 'false' => '不开启弹性能力'], + 'example' => 'true', + ], + 'messageRetentionTime' => ['title' => '消息保留时长', 'description' => '消息保存时长。单位：小时。'."\n" + ."\n" + .'取值范围，请参见[使用限制](~~440347~~)>资源配额>消息保存时长的限制值。'."\n" + ."\n" + .'消息队列RocketMQ版的消息存储完全实现Serverless弹性，按照实际存储空间收取费用，您可以通过调整消息保存时长来控制消息的存储容量。更多信息，请参见[存储费用](~~427238~~)。', 'type' => 'integer', 'format' => 'int32', 'example' => '72'], + 'supportAutoScaling' => [ + 'title' => '是否支持自适应弹性伸缩', + 'description' => '实例是否支持开启规格外突发弹性能力。'."\n" + ."\n\n" + .'开启弹性突发能力后，消息队列RocketMQ允许该实例在一定范围内超过基础规格限制的TPS，且超过基础规格外的部分，需要收取额外的弹性规格费用。具体计费信息，请参见[计算能力费用](~~427237~~)。'."\n" + ."\n\n" + .'> 仅部分规格的实例支持开启弹性突发规格能力，具体支持的实例，请参见[实例规格](~~444715~~)。', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '支持开启弹性能力', 'false' => '不支持开启弹性能力'], + 'example' => 'true', + ], + 'internetSpec' => [ + 'title' => '是否开通公网', + 'description' => '是否开通公网访问。'."\n" + ."\n\n" + .'实例默认支持VPC访问方式，若开启公网访问，消息队列RocketMQ版会收取公网下行带宽费用。具体计费信息，请参见[公网访问费用](~~427240~~)。', + 'type' => 'string', + 'enumValueTitles' => ['enable' => '开通公网访问', 'disable' => '关闭公网访问'], + 'example' => 'enable', + 'enum' => ['enable', 'disable'], + ], + 'flowOutType' => [ + 'title' => '公网计费类型', + 'description' => '公网计费类型。', + 'type' => 'string', + 'enumValueTitles' => ['payByTraffic' => '按流量计费', 'payByBandwidth' => '按带宽计费', 'uninvolved' => '不涉及'], + 'example' => 'payByBandwidth', + 'enum' => ['uninvolved', 'payByTraffic', 'payByBandwidth'], + ], + 'flowOutBandwidth' => ['title' => '公网带宽规格', 'description' => '公网带宽规格。单位：Mb/s。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'msgProcessSpec' => ['title' => '消息收发计算规格', 'description' => '消息收发计算规格。具体消息收发TPS上限，请参见[实例规格](~~444715~~)。', 'type' => 'string', 'example' => 'rmq.s2.2xlarge'], + ], + 'deprecated' => true, + ], + 'resourceGroupId' => ['title' => '资源组ID', 'description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfm3tmjruyribi'], + 'productInfo' => [ + 'title' => '产品信息', + 'description' => '实例的扩展配置。', + 'type' => 'object', + 'properties' => [ + 'msgProcessSpec' => ['title' => '消息收发规格', 'description' => '消息收发计算规格。具体消息收发TPS上限，请参见[实例规格](~~444715~~)。', 'type' => 'string', 'example' => 'rmq.s2.2xlarge'], + 'sendReceiveRatio' => ['title' => '消息收发比例', 'description' => '消息发送和接收的比例。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'autoScaling' => [ + 'title' => '是否开启弹性伸缩', + 'description' => '是否开启规格外突发弹性能力。'."\n" + ."\n" + .'仅当supportAutoScaling参数值为enable，即实例支持开启弹性能力，该参数才有效。', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '开启弹性能力', 'false' => '不开启弹性能力'], + 'example' => 'true', + ], + 'messageRetentionTime' => ['title' => '消息保留时长', 'description' => '消息保存时长。单位：小时。'."\n" + ."\n" + .'取值范围，请参见[使用限制](~~440347~~)>资源配额>消息保存时长的限制值。'."\n" + ."\n" + .'消息队列RocketMQ版的消息存储完全实现Serverless弹性，按照实际存储空间收取费用，您可以通过调整消息保存时长来控制消息的存储容量。更多信息，请参见[存储费用](~~427238~~)。', 'type' => 'integer', 'format' => 'int32', 'example' => '72'], + 'supportAutoScaling' => [ + 'title' => '是否支持弹性伸缩', + 'description' => '是否支持开启规格外突发弹性能力。'."\n" + ."\n\n" + .'开启弹性突发能力后，消息队列RocketMQ允许该实例在一定范围内超过基础规格限制的TPS，且超过基础规格外的部分，需要收取额外的弹性规格费用。具体计费信息，请参见[计算能力费用](~~427237~~)。'."\n" + ."\n\n" + .'> 仅部分规格的实例支持开启弹性突发规格能力，具体支持的实例，请参见[实例规格](~~444715~~)。', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '支持开启弹性能力', 'false' => '不支持开启弹性能力'], + 'example' => 'true', + ], + 'traceOn' => ['description' => '是否开启消息轨迹功能。'."\n" + .'- true：开启消息轨迹功能'."\n" + .'- false：关闭消息轨迹功能'."\n" + ."\n" + .'<props="intl">该参数暂不生效，不管参数是否开启，实例都默认支持轨迹功能。</props>'."\n" + .'<props="china">该参数仅对Serverless类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见[Serverless计费说明](~~2586280~~)。</props>'."\n" + ."\n" + .'<props="china">对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。</props>', 'type' => 'boolean', 'example' => 'true'], + 'storageEncryption' => ['title' => '是否开启存储加密', 'description' => '是否开启存储加密', 'type' => 'boolean', 'example' => 'false'], + 'storageSecretKey' => ['title' => '存储加密密钥Key', 'description' => '存储加密密钥Key', 'type' => 'string', 'example' => 'xxxxx'], + 'capacityType' => [ + 'description' => '容量模式', + 'type' => 'string', + 'enumValueTitles' => ['provisioned' => '预留+弹性', 'ondemand' => '按量付费'], + 'example' => 'provisioned', + ], + 'provisionedCapacity' => ['description' => '预留容量', 'type' => 'integer', 'format' => 'int64', 'example' => '3000'], + 'drReplicationMode' => ['title' => '跨地域复制模式', 'description' => '跨地域复制模式', 'type' => 'string', 'example' => 'async_cross_az'], + 'maxDelayTime' => ['description' => '定时消息最大间隔，单位：秒', 'type' => 'integer', 'format' => 'int32', 'example' => '3456000'], + ], + ], + 'aclInfo' => [ + 'title' => '访问控制信息', + 'description' => '访问控制信息。', + 'type' => 'object', + 'properties' => [ + 'aclTypes' => [ + 'description' => '实例的鉴权类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的鉴权类型。', + 'type' => 'string', + 'enumValueTitles' => ['default' => '智能身份识别', 'apache_acl' => 'ACL身份识别'], + 'example' => 'default', ], ], + 'defaultVpcAuthFree' => [ + 'description' => '内网免身份识别开关。', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], + 'example' => 'true', + ], + 'aclType' => [ + 'description' => '实例的鉴权类型。已废弃，推荐使用aclTypes字段', + 'type' => 'string', + 'deprecated' => true, + 'enumValueTitles' => ['default' => '智能身份识别', 'apache_acl' => 'ACL身份识别'], + 'example' => 'default', + ], + ], + ], + 'software' => [ + 'title' => '实例软件信息', + 'description' => '实例软件信息。', + 'type' => 'object', + 'properties' => [ + 'softwareVersion' => ['title' => '软件版本', 'description' => '软件版本。', 'type' => 'string', 'example' => '5.0-rmq-20230619-1'], + 'maintainTime' => ['title' => '升级时间段', 'description' => '升级时间段。', 'type' => 'string', 'deprecated' => true, 'example' => '02:00-06:00'], + 'upgradeMethod' => [ + 'title' => '升级方式，auto自动升级，manual手动升级', + 'description' => '升级方式。', + 'type' => 'string', + 'enumValueTitles' => ['auto' => '自动升级', 'maunal' => '手动升级'], + 'example' => 'auto', + ], + ], + ], + 'topicCount' => ['title' => '主题数量', 'description' => '主题数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'groupCount' => ['title' => '消费组数量', 'description' => '消费组数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'tags' => [ + 'title' => '资源标签列表。', + 'description' => '资源标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => '资源标签。', + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '资源标签key值。', 'description' => '资源标签key值。', 'type' => 'string', 'example' => 'key'], + 'value' => ['title' => '资源标签value值。', 'description' => '资源标签value值。', 'type' => 'string', 'example' => 'value'], + ], ], ], + 'autoRenew' => ['title' => '是否自动续费', 'description' => '是否自动续费', 'type' => 'boolean', 'example' => 'false'], + 'autoRenewPeriod' => ['title' => '是否自动续费', 'description' => '是否自动续费', 'type' => 'integer', 'format' => 'int32', 'example' => 'false'], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"30F2CBC7-F69D-5D78-9661-0254C9E1FBFA\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"stacks\\": [\\n {\\n \\"thread\\": \\"123\\",\\n \\"tracks\\": [\\n \\"xxx\\"\\n ]\\n }\\n ]\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', - 'title' => '获取消费者堆栈信息', - ], - 'ResetConsumeOffset' => [ - 'summary' => '重置指定消费者分组的消费位点。重置消费位点是指改变订阅者当前的消费位置。当消费者出现故障或者消费错误数据时，您可通过重置消费位点将消费位置回滚到之前的某个位点重新开始消费，您也可以将消费位置移动至最新位点，暂时不处理堆积的消息。', - 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeOffsets/{topicName}', - 'methods' => [ - 'patch', + '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' => '获取指定实例的详情', + 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], + ], ], - 'schemes' => [ - 'https', - 'http', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rocketmq:GetInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'GetInstanceAccount' => [ + 'summary' => '获取指定实例的账号。', + 'path' => '/instances/{instanceId}/account', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '150942', + 'abilityTreeNodes' => ['FEATUREonsGA7IC4'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '云消息队列 RocketMQ 版的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-tl32ue44x0g', - ], - ], - [ - 'name' => 'consumerGroupId', - 'in' => 'path', - 'schema' => [ - 'description' => '消费者分组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'dolphin_status', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-20p36ja4m0y'], ], [ - 'name' => 'topicName', - 'in' => 'path', - 'schema' => [ - 'description' => '消费者分组订阅的主题名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'AMZN_REPORT_TOPIC', - ], + 'name' => 'username', + 'in' => 'query', + 'schema' => ['description' => '账号名称。'."\n" + ."\n" + .'不传则返回默认账号。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体对象。', + 'title' => 'Schema of Response', + 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'resetType' => [ - 'title' => '重置方式,ConsumeOffsetResetTypeEnum[LATEST_OFFSET(最新位点),SPECIFIED_TIME(指定时间),code,desc]', - 'description' => '重置方式。'."\n" - .'- LATEST_OFFSET：从最新位点开始消费。'."\n" - ."\n" - .' Group ID消费指定Topic中的消息时，会跳过当前堆积（未被消费）的所有消息，从重置操作时间后发送的最新消息开始消费。'."\n" - .'- SPECIFIED_TIME：从指定时间的位点开始消费。'."\n" - .' '."\n" - .' - 消费者将从重置时间对应的消费位点之后的消息进行消费，不管这些消息是否已被消费过。'."\n" - ."\n" - .' - 可选时间范围中的起始和终止时间分别是该Topic中储存的最早的和最晚的一条消息的生产时间，不能选择超过可选时间范围的时间点。'."\n" - ."\n" - .' - 重置到某一时刻对应的消费位点，匹配位点时，服务端会根据自动匹配到该时刻最接近的消费位点。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SPECIFIED_TIME' => '从指定时间的位点开始消费', - 'LATEST_OFFSET' => '从最新位点开始消费', + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'B5C59E80-FCFC-5796-ABE4-D39EAAE578E4'], + 'success' => ['description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'username' => ['description' => '账号名称。', 'type' => 'string', 'example' => 'xxx'], + 'password' => ['description' => '账号密码。', 'type' => 'string', 'example' => '*************'], + 'accountStatus' => [ + 'description' => '账号状态', + 'type' => 'string', + 'enumValueTitles' => ['DISABLE' => '禁用', 'ENABLE' => '启用'], + 'example' => 'ENABLE', + ], + 'remark' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'example' => 'test'], ], - 'example' => 'LATEST_OFFSET', - ], - 'resetTime' => [ - 'title' => '重置时间', - 'description' => '指定重置时间。表示消费者将从该时间点对应的消费位点重新开始消费消息。'."\n" - ."\n" - .'仅当resetType（重置方式）选择SPECIFIED_TIME（指定时间）时需要填写该参数。'."\n" - ."\n" - .'格式为YYYY-MM-DD HH:mm:ss，例如：2023-11-23 10:00:00。', - 'type' => 'string', - 'required' => false, - 'example' => '2023-03-22 12:17:08', ], + 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['description' => '动态错误码。', 'type' => 'string', 'example' => 'ConsumerGroupId'], + 'dynamicMessage' => ['description' => '动态错误信息。', 'type' => 'string', 'example' => 'instanceId'], ], - 'required' => false, ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<Void>', - 'description' => 'Result<Void>', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'F9A95891-EAD4-5A2B-8A30-676CD18921AF', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + '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' => '获取实例账号', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceAccount'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rocketmq:GetInstanceAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Instance', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], - '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' => '重置消费位点', ], - 'ListMessages' => [ - 'summary' => '查询消息列表。', - 'path' => '/instances/{instanceId}/topics/{topicName}/messages', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetInstanceAcl' => [ + 'summary' => '查询访问权限信息详情。', + 'path' => '/instances/{instanceId}/acl/account/{username}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5851,347 +3531,200 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREonsNPGYUW', - 'FEATUREonsKQSI06', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '263406', + 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-zvp2vtypu05', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'topicName', + 'name' => 'username', 'in' => 'path', - 'schema' => [ - 'description' => '主题名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_delay_queue', - ], + 'schema' => ['description' => '用户名称', 'type' => 'string', 'required' => true, 'example' => 'abc'], ], [ - 'name' => 'messageId', + 'name' => 'resourceType', 'in' => 'query', 'schema' => [ - 'description' => '消息ID。', + 'description' => '授权的资源类型', 'type' => 'string', - 'required' => false, - 'example' => '7F00000100207A4F0F294A938F7807AE', + 'required' => true, + 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], + 'example' => 'Topic', ], ], [ - 'name' => 'messageKey', + 'name' => 'resourceName', 'in' => 'query', - 'schema' => [ - 'description' => '消息key。', - 'type' => 'string', - 'required' => false, - 'example' => 'XSCBillResult', - ], + 'schema' => ['description' => '授权的资源名称', 'type' => 'string', 'required' => true, 'example' => 'test'], ], - [ - 'name' => 'startTime', - 'in' => 'query', - 'allowEmptyValue' => true, + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '查询时间范围：开始时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2024-09-09 08:00:00', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => '区域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'aclType' => ['description' => '实例的鉴权类型。'."\n" + ."\n" + .'参数取值如下：'."\n" + .' '."\n" + .'- apache_acl：开源ACL'."\n" + .'- default：实例默认账号', 'type' => 'string', 'example' => 'apache_acl'], + 'username' => ['description' => '用户名称', 'type' => 'string', 'example' => 'abc'], + 'resourceType' => ['description' => '授权的资源类型', 'type' => 'string', 'example' => 'Topic'], + 'resourceName' => ['description' => '授权的资源名称', 'type' => 'string', 'example' => 'test'], + 'decision' => ['description' => '授权的决策结果', 'type' => 'string', 'example' => 'Allow'], + 'actions' => [ + 'description' => '授权的操作类型列表。', + 'type' => 'array', + 'items' => ['description' => '授权的操作类型。', 'type' => 'string', 'example' => 'Pub'], + ], + 'ipWhitelists' => [ + 'description' => 'IP白名单列表', + 'type' => 'array', + 'items' => ['description' => 'IP白名单，支持IP和IP段。', 'type' => 'string', 'example' => '0.0.0.0/0'], + ], + ], + ], + 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + ], ], ], - [ - 'name' => 'endTime', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '查询时间范围：结束时间', - 'type' => 'string', - 'required' => false, - 'example' => '2024-09-09 09:00:00', - ], + ], + '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' => '查询访问权限详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceAcl'], ], + ], + 'ramActions' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '当前页码，从1开始。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rocketmq:GetInstanceAcl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'Acl', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], + ], + ], + 'GetInstanceIpWhitelist' => [ + 'summary' => '查询访问控制IP白名单详情。', + 'path' => '/instances/{instanceId}/ip/whitelists', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'pageSize', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '分页大小，每页最多显示的返回结果数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '20', - 'minimum' => '1', - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '260123', + 'abilityTreeNodes' => ['FEATUREonsO60XBD'], + ], + 'parameters' => [ [ - 'name' => 'scrollId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '请求滚动ID。'."\n" - ."\n" - .'第一页请求无需传递，后续分页请求根据第一页返回结果，带上该字段。', - 'type' => 'string', - 'required' => false, - 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00', - ], + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'liteTopicName', + 'name' => 'ipWhitelists', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'title' => '轻量主题名称', - 'description' => '轻量主题名称', - 'type' => 'string', + 'description' => 'IP白名单过滤列表', + 'type' => 'array', + 'items' => ['description' => 'IP白名单', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0'], 'required' => false, - 'example' => 'abc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<MyPage<MessageDTO>>', + 'title' => 'Schema of Response', 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '0B962390-D84B-5D44-8C11-79DF40299D41'], + 'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', + 'description' => '返回数据对象', 'type' => 'object', 'properties' => [ - 'pageNumber' => [ - 'title' => '当前页码', - 'description' => '当前页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'title' => '分页大小', - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'totalCount' => [ - 'title' => '总记录数', - 'description' => '总记录数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'list' => [ - 'title' => '分页数据', - 'description' => '分页数据', + 'regionId' => ['description' => '区域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'ipWhitelists' => [ + 'description' => 'IP白名单列表', 'type' => 'array', - 'items' => [ - 'description' => '消息信息', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => '区域ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'title' => '主题名称', - 'description' => '主题名称', - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageId' => [ - 'title' => '消息ID', - 'description' => '消息ID', - 'type' => 'string', - 'example' => '7F000001000114B4340C5ABF94500079', - ], - 'bornTime' => [ - 'title' => '生成时间', - 'description' => '生成时间', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'storeTime' => [ - 'title' => '存储时间', - 'description' => '存储时间', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'body' => [ - 'title' => '消息体', - 'description' => '消息体', - 'type' => 'string', - 'example' => '{}', - ], - 'bodySize' => [ - 'description' => '消息体大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'bornHost' => [ - 'title' => '消息来自哪里', - 'description' => '消息生产客户端', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'storeHost' => [ - 'title' => '消息存储位置', - 'description' => '消息存储服务端', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'messageType' => [ - 'title' => '消息类型', - 'description' => '消息类型', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'messageTag' => [ - 'title' => '标签列表', - 'description' => '消息标签', - 'type' => 'string', - 'example' => 'xx', - ], - 'messageGroup' => [ - 'title' => '以前的shardingkey，顺序消息独有', - 'description' => '消息分组，顺序消息独有。', - 'type' => 'string', - 'example' => 'xx', - ], - 'messageKeys' => [ - 'title' => '业务标识', - 'description' => '业务标识', - 'type' => 'array', - 'items' => [ - 'description' => '业务标识。', - 'type' => 'string', - 'example' => 'xx', - ], - ], - 'userProperties' => [ - 'title' => '用户属性', - 'description' => '用户属性', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '用户属性。', - 'example' => 'xx', - ], - ], - 'liteTopicName' => [ - 'title' => '轻量主题名称', - 'description' => '轻量主题名称', - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], - ], - 'scrollId' => [ - 'description' => '请求滚动ID。'."\n" - ."\n" - .'系统自动生成，后续分页请求需要带上该返回结果，才能持续分页。', - 'type' => 'string', - 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00', + 'items' => ['description' => 'IP白名单', 'type' => 'string', 'example' => '0.0.0.0/0'], ], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'xxx'], + 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['description' => '动态错误信息。', 'type' => 'string', 'example' => 'instanceId'], + ], + ], + ], + ], + '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' => '查询IP白名单详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceIpWhitelist'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rocketmq:GetInstanceIpWhitelist', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => 'IpWhitelist', 'arn' => 'acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], - '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' => '查询消息列表', ], 'GetMessageDetail' => [ 'summary' => '获取指定消息的详情。', 'path' => '/instances/{instanceId}/topics/{topicName}/messages/{messageId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6203,40 +3736,23 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREonsNPGYUW', - ], + 'abilityTreeNodes' => ['FEATUREonsNPGYUW'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-lbj31fs790d', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-lbj31fs790d'], ], [ 'name' => 'topicName', 'in' => 'path', - 'schema' => [ - 'description' => '主题名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'flink_test', - ], + 'schema' => ['description' => '主题名称。', 'type' => 'string', 'required' => true, 'example' => 'flink_test'], ], [ 'name' => 'messageId', 'in' => 'path', - 'schema' => [ - 'description' => '消息ID', - 'type' => 'string', - 'required' => true, - 'example' => '0A792FDB001F7591083D30ADB1DA11D5', - ], + 'schema' => ['description' => '消息ID', 'type' => 'string', 'required' => true, 'example' => '0A792FDB001F7591083D30ADB1DA11D5'], ], ], 'responses' => [ @@ -6246,479 +3762,82 @@ 'description' => 'Result<MessageDTO>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'FAEBD71F-E839-52F9-BD7B-8F1290525841', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'FAEBD71F-E839-52F9-BD7B-8F1290525841'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => '区域ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'title' => '主题名称', - 'description' => '主题名称', - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageId' => [ - 'title' => '消息ID', - 'description' => '消息ID', - 'type' => 'string', - 'example' => '01BE87E485F0C7808C04543CAF00000001', - ], - 'bornTime' => [ - 'title' => '生成时间', - 'description' => '生成时间', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'storeTime' => [ - 'title' => '存储时间', - 'description' => '存储时间', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'body' => [ - 'title' => '消息体', - 'description' => '消息体', - 'type' => 'string', - 'example' => '{}', - ], - 'bodySize' => [ - 'description' => '消息体大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'bornHost' => [ - 'title' => '消息来自哪里', - 'description' => '消息来自哪里', - 'type' => 'string', - 'example' => 'xxx.xx.xxx.xx', - ], - 'storeHost' => [ - 'title' => '消息存储位置', - 'description' => '消息存储位置', - 'type' => 'string', - 'example' => 'xxx.xx.xxx.xx', - ], - 'messageType' => [ - 'title' => '消息类型', - 'description' => '消息类型', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'messageTag' => [ - 'title' => '标签列表', - 'description' => '标签列表', - 'type' => 'string', - 'example' => 'xx', - ], - 'messageGroup' => [ - 'title' => '以前的shardingkey，顺序消息独有', - 'description' => '以前的shardingkey，顺序消息独有', - 'type' => 'string', - 'example' => 'xx', - ], + 'regionId' => ['title' => '区域ID', 'description' => '区域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'topicName' => ['title' => '主题名称', 'description' => '主题名称', 'type' => 'string', 'example' => 'topic_test'], + 'messageId' => ['title' => '消息ID', 'description' => '消息ID', 'type' => 'string', 'example' => '01BE87E485F0C7808C04543CAF00000001'], + 'bornTime' => ['title' => '生成时间', 'description' => '生成时间', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], + 'storeTime' => ['title' => '存储时间', 'description' => '存储时间', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], + 'body' => ['title' => '消息体', 'description' => '消息体', 'type' => 'string', 'example' => '{}'], + 'bodySize' => ['description' => '消息体大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'bornHost' => ['title' => '消息来自哪里', 'description' => '消息来自哪里', 'type' => 'string', 'example' => 'xxx.xx.xxx.xx'], + 'storeHost' => ['title' => '消息存储位置', 'description' => '消息存储位置', 'type' => 'string', 'example' => 'xxx.xx.xxx.xx'], + 'messageType' => ['title' => '消息类型', 'description' => '消息类型', 'type' => 'string', 'example' => 'NORMAL'], + 'messageTag' => ['title' => '标签列表', 'description' => '标签列表', 'type' => 'string', 'example' => 'xx'], + 'messageGroup' => ['title' => '以前的shardingkey，顺序消息独有', 'description' => '以前的shardingkey，顺序消息独有', 'type' => 'string', 'example' => 'xx'], 'messageKeys' => [ 'title' => '业务标识', 'description' => '业务标识', 'type' => 'array', - 'items' => [ - 'description' => '标识', - 'type' => 'string', - 'example' => 'xx', - ], + 'items' => ['description' => '标识', 'type' => 'string', 'example' => 'xx'], ], 'userProperties' => [ 'title' => '用户属性', 'description' => '用户属性', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'xxx', - 'description' => '用户属性', - ], + 'additionalProperties' => ['type' => 'string', 'example' => 'xxx', 'description' => '用户属性'], ], 'systemProperties' => [ 'description' => '系统默认属性', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'xx', - 'description' => '系统默认属性', - ], - ], - 'liteTopicName' => [ - 'title' => '轻量主题名称', - 'description' => '轻量主题名称', - 'type' => 'string', - 'example' => 'abc', + 'additionalProperties' => ['type' => 'string', 'example' => 'xx', 'description' => '系统默认属性'], ], + 'liteTopicName' => ['title' => '轻量主题名称', 'description' => '轻量主题名称', 'type' => 'string', 'example' => 'abc'], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], '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' => '获取消息详情', - ], - 'VerifySendMessage' => [ - 'summary' => '验证指定实例下指定主题的消息发送功能。', - 'path' => '/instances/{instanceId}/topics/{topicName}/messages', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMessageDetail'], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREonsB0E8FD', - ], - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-wwo32kqfm10', - ], - ], - [ - 'name' => 'topicName', - 'in' => 'path', - 'schema' => [ - 'description' => '主题名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'card_status_topic', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体结构。', - 'type' => 'object', - 'properties' => [ - 'message' => [ - 'title' => '消息内容', - 'description' => '消息内容', - 'type' => 'string', - 'required' => false, - 'example' => 'successful', - ], - 'messageTag' => [ - 'title' => '消息标签', - 'description' => '消息标签', - 'type' => 'string', - 'required' => false, - 'example' => 'xx', - ], - 'messageKey' => [ - 'title' => '业务标识', - 'description' => '业务标识', - 'type' => 'string', - 'required' => false, - 'example' => 'xx', - ], - 'liteTopicName' => [ - 'title' => '轻量主题名称', - 'description' => 'Lite消息队列主题名称', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + '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}'], ], - 'required' => false, ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<String>', - 'description' => 'Result<String>', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '3BD2C19B-66DE-59C7-B2F6-FD1BE21DC8C1', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'string', - 'example' => '0A64228900207A4F0F2931A4E0D40BE5', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'InvalidConsumerGroupId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'ConsumerGroupId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'consumerGroupId', - ], - ], - ], - ], - ], - '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' => '消息发送验证', ], - 'VerifyConsumeMessage' => [ - 'summary' => '验证指定实例下指定主题的消息消费状态。', - 'path' => '/instances/{instanceId}/topics/{topicName}/messages/{messageId}/action/verifyConsume', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-i7m2vc1vx01', - ], - ], - [ - 'name' => 'topicName', - 'in' => 'path', - 'schema' => [ - 'description' => '主题名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'delay_topic', - ], - ], - [ - 'name' => 'messageId', - 'in' => 'path', - 'schema' => [ - 'description' => '消息ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'A9FE190A59AA421ED014743DFDBF017D', - ], - ], - [ - 'name' => 'consumerGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '消费者分组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'TEST_FINANCE_STOCK_OUT_GROUP', - ], - ], - [ - 'name' => 'clientId', - 'in' => 'query', - 'schema' => [ - 'description' => '客户端ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'zeekr-settlement-server-dc555456f-v2lcg@1@1@qfvorazqns', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5304143F-AB0E-5AB4-A227-7C5489216FD5', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - ], - ], - ], - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5304143F-AB0E-5AB4-A227-7C5489216FD5\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', - 'title' => '消息消费验证', - ], - 'ListTraces' => [ - 'summary' => '查询指定主题下的轨迹消息列表。', - 'path' => '/instances/{instanceId}/topics/{topicName}/traces', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetTopic' => [ + 'summary' => '获取某个指定主题的详细信息。', + 'path' => '/instances/{instanceId}/topics/{topicName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6730,271 +3849,101 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREonsNKYZ9K', - 'FEATUREonsJEU5XG', - 'FEATUREonsYT2OK3', - ], + 'abilityTreeCode' => '144800', + 'abilityTreeNodes' => ['FEATUREons8BETJT'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-tl32upjeb08', - ], + 'schema' => ['title' => '实例ID', 'description' => '待查询主题所属的实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'topicName', 'in' => 'path', - 'schema' => [ - 'description' => '主题名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'topic_hpms_product_price_change', - ], - ], - [ - 'name' => 'startTime', - 'in' => 'query', - 'schema' => [ - 'description' => '开始时间。', - 'type' => 'string', - 'required' => true, - 'example' => '2023-05-10 10:42:11', - ], - ], - [ - 'name' => 'endTime', - 'in' => 'query', - 'schema' => [ - 'description' => '结束时间。', - 'type' => 'string', - 'required' => true, - 'example' => '2023-05-19 10:10:09', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页页码，查询第几页的返回结果。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，每页做多显示的返回结果数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '10', - ], - ], - [ - 'name' => 'queryType', - 'in' => 'query', - 'schema' => [ - 'description' => '查询类型。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'MESSAGE_ID' => 'MESSAGE_ID', - 'MESSAGE_KEY' => 'MESSAGE_KEY', - 'TOPIC' => 'TOPIC', - ], - 'example' => 'MESSAGE_ID', - ], - ], - [ - 'name' => 'messageId', - 'in' => 'query', - 'schema' => [ - 'description' => '消息ID。'."\n" - ."\n" - .'queryType选择MESSAGE_ID时必填。', - 'type' => 'string', - 'required' => false, - 'example' => '0100163E0EC1F1965C04C7906700000000', - ], - ], - [ - 'name' => 'messageKey', - 'in' => 'query', - 'schema' => [ - 'description' => '消息key。'."\n" - ."\n" - .'queryType选择MESSAGE_KEY时必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'order_ceating', - ], - ], - [ - 'name' => 'liteTopicName', - 'in' => 'query', - 'schema' => [ - 'title' => '轻量主题名称', - 'description' => '轻量主题名称', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['title' => '主题名称', 'description' => '待查询主题的名称。', 'type' => 'string', 'required' => true, 'example' => 'topic_test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'Result<TopicDTO>', + 'description' => 'Result<TopicDTO>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'EDFF77E1-1ED1-5389-B6A8-651D9433BBE5', - ], - 'success' => [ - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], 'data' => [ + 'title' => '返回结果', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'pageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'totalCount' => [ - 'description' => '返回结果的总数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'regionId' => ['title' => '区域ID', 'description' => '实例所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '主题所属实例的ID。', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'topicName' => ['title' => 'Topic编码', 'description' => '主题名称。', 'type' => 'string', 'example' => 'topic_test'], + 'messageType' => [ + 'title' => '消息类型,MessageTypeEnum[UNSPECIFIED,NORMAL(普通),FIFO(顺序),DELAY(延迟),TRANSACTION(事务),UNRECOGNIZED(无法识别),code,desc]', + 'description' => '主题的消息类型', + 'type' => 'string', + 'enumValueTitles' => ['TRANSACTION' => '事务消息', 'FIFO' => '顺序消息', 'DELAY' => '定时消息/延时消息', 'LITE' => '轻量主题消息', 'NORMAL' => '普通消息'], + 'example' => 'NORMAL', + 'enum' => ['NORMAL', 'FIFO', 'DELAY', 'TRANSACTION'], ], - 'list' => [ - 'description' => '分页数据。', - 'type' => 'array', - 'items' => [ - 'description' => '分页数据。', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'description' => '主题名称。', - 'type' => 'string', - 'example' => 'topic_test', - ], - 'messageId' => [ - 'description' => '消息ID。', - 'type' => 'string', - 'example' => '7F00000100207A4F0F294A938F7807AE', - ], - 'bornTime' => [ - 'description' => '生成时间。', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'messageTag' => [ - 'description' => '标签列表。', - 'type' => 'string', - 'example' => 'xx', - ], - 'messageKeys' => [ - 'description' => '业务标识。', - 'type' => 'array', - 'items' => [ - 'description' => '业务标识。', - 'type' => 'string', - 'example' => 'xx', - ], - ], - ], - ], + 'status' => [ + 'title' => '主题状态', + 'description' => '主题的状态。'."\n" + ."\n" + .'参数取值如下：'."\n" + .'- RUNNING：运行中'."\n" + .'- CREATING：创建中', + 'type' => 'string', + 'enumValueTitles' => ['RUNNING' => '运行中', 'CREATING' => '创建中'], + 'example' => 'RUNNING', + 'enum' => ['CREATING', 'RUNNING'], ], + 'remark' => ['title' => '备注', 'description' => '主题的备注信息。', 'type' => 'string', 'example' => 'This is the remark for test.'."\n"], + 'createTime' => ['title' => '创建时间', 'description' => '主题的创建时间。', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'updateTime' => ['title' => '修改时间', 'description' => '主题的最后修改时间。', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'maxSendTps' => ['description' => '发送消息tps上限', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'liteTopicExpiration' => ['title' => 'liteTopic过期时间，单位：分钟', 'description' => 'liteTopic过期时间，单位：分钟', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], ], ], - 'httpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'InstanceId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'The topic cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'TopicName'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'topicName'], ], ], ], ], - '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' => '获取指定主题的详情', + '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' => '查询轨迹消息列表', ], 'GetTrace' => [ 'summary' => '获取指定主题下的指定消息轨迹。', 'path' => '/instances/{instanceId}/topics/{topicName}/traces/{messageId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7007,60 +3956,33 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '172963', - 'abilityTreeNodes' => [ - 'FEATUREonsNKYZ9K', - ], + 'abilityTreeNodes' => ['FEATUREonsNKYZ9K'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '待查询实例的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-zvp2vtypu05', - ], + 'schema' => ['description' => '待查询实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-zvp2vtypu05'], ], [ 'name' => 'topicName', 'in' => 'path', - 'schema' => [ - 'description' => '待查询主题的名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'linkedcare-image', - ], + 'schema' => ['description' => '待查询主题的名称。', 'type' => 'string', 'required' => true, 'example' => 'linkedcare-image'], ], [ 'name' => 'messageId', 'in' => 'path', - 'schema' => [ - 'description' => '消息 id', - 'type' => 'string', - 'required' => true, - 'example' => '012A5AB0BBEC8A000104C6342B00001ECF', - ], + 'schema' => ['description' => '消息 id', 'type' => 'string', 'required' => true, 'example' => '012A5AB0BBEC8A000104C6342B00001ECF'], ], [ 'name' => 'startTime', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-05-10 10:42:11', - ], + 'schema' => ['description' => '开始时间', 'type' => 'string', 'required' => false, 'example' => '2023-05-10 10:42:11'], ], [ 'name' => 'endTime', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2024-09-09 09:00:00', - ], + 'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => false, 'example' => '2024-09-09 09:00:00'], ], ], 'responses' => [ @@ -7070,129 +3992,43 @@ 'description' => 'result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => '7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49', - ], - 'success' => [ - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => '7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49'], + 'success' => ['description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => '区域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'description' => '主题名称。', - 'type' => 'string', - 'example' => 'topic_test', - ], + 'regionId' => ['description' => '区域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'topicName' => ['description' => '主题名称。', 'type' => 'string', 'example' => 'topic_test'], 'messageInfo' => [ 'description' => '消息信息。', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => '区域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'instanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'rmq-cn-u0t2ygjq505', - ], - 'topicName' => [ - 'description' => '主题名称。', - 'type' => 'string', - 'example' => 'Topic_normal_inspector', - ], - 'messageId' => [ - 'description' => '消息 id', - 'type' => 'string', - 'example' => '0A79275A00207A4F0F2916C92F9A0B94', - ], - 'bornTime' => [ - 'description' => '生成时间', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'storeTime' => [ - 'description' => '存储时间', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'body' => [ - 'description' => '消息体。', - 'type' => 'string', - 'example' => '{}', - ], - 'bornHost' => [ - 'description' => '消息来自哪里。', - 'type' => 'string', - 'example' => 'x.x.x.x', - ], - 'storeHost' => [ - 'description' => '消息存储位置', - 'type' => 'string', - 'example' => 'x.x.x.x', - ], - 'messageType' => [ - 'description' => '消息类型。', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'messageTag' => [ - 'description' => '标签列表。', - 'type' => 'string', - 'example' => 'xx', - ], - 'messageGroup' => [ - 'description' => '以前的shardingkey，顺序消息独有。', - 'type' => 'string', - 'example' => 'xx', - ], + 'regionId' => ['description' => '区域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'instanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rmq-cn-u0t2ygjq505'], + 'topicName' => ['description' => '主题名称。', 'type' => 'string', 'example' => 'Topic_normal_inspector'], + 'messageId' => ['description' => '消息 id', 'type' => 'string', 'example' => '0A79275A00207A4F0F2916C92F9A0B94'], + 'bornTime' => ['description' => '生成时间', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], + 'storeTime' => ['description' => '存储时间', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], + 'body' => ['description' => '消息体。', 'type' => 'string', 'example' => '{}'], + 'bornHost' => ['description' => '消息来自哪里。', 'type' => 'string', 'example' => 'x.x.x.x'], + 'storeHost' => ['description' => '消息存储位置', 'type' => 'string', 'example' => 'x.x.x.x'], + 'messageType' => ['description' => '消息类型。', 'type' => 'string', 'example' => 'NORMAL'], + 'messageTag' => ['description' => '标签列表。', 'type' => 'string', 'example' => 'xx'], + 'messageGroup' => ['description' => '以前的shardingkey，顺序消息独有。', 'type' => 'string', 'example' => 'xx'], 'messageKeys' => [ 'description' => '业务标识。', 'type' => 'array', - 'items' => [ - 'description' => '业务标识。', - 'type' => 'string', - 'example' => 'xx', - ], + 'items' => ['description' => '业务标识。', 'type' => 'string', 'example' => 'xx'], ], 'userProperties' => [ 'description' => '用户属性。', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'xx', - 'description' => '用户属性。', - ], - ], - 'transactionId' => [ - 'description' => '事务标识。', - 'type' => 'string', - 'example' => 'xx', - ], - 'liteTopicName' => [ - 'title' => '轻量主题名称', - 'description' => '轻量主题名称', - 'type' => 'string', - 'example' => 'abc', + 'additionalProperties' => ['type' => 'string', 'example' => 'xx', 'description' => '用户属性。'], ], + 'transactionId' => ['description' => '事务标识。', 'type' => 'string', 'example' => 'xx'], + 'liteTopicName' => ['title' => '轻量主题名称', 'description' => '轻量主题名称', 'type' => 'string', 'example' => 'abc'], ], ], 'producerInfo' => [ @@ -7206,57 +4042,16 @@ 'description' => '生产记录列表。', 'type' => 'object', 'properties' => [ - 'userName' => [ - 'description' => '生产者名称。', - 'type' => 'string', - 'example' => 'xxx', - ], - 'clientHost' => [ - 'description' => '主机名。', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'produceTime' => [ - 'description' => '发送时间。', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'produceDuration' => [ - 'description' => '发送耗时。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'produceStatus' => [ - 'description' => '发送状态。', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'arriveTime' => [ - 'description' => '到达时间。', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'messageSource' => [ - 'description' => '消息来源。', - 'type' => 'string', - 'example' => 'CONSOLE', - ], - 'dlqOriginTopic' => [ - 'description' => '死信队列主题。', - 'type' => 'string', - 'example' => 'test_topic', - ], - 'dlqOriginMessageId' => [ - 'description' => '死信队列消息ID。', - 'type' => 'string', - 'example' => '0A79275A00207A4F0F2916C92F9A0B94', - ], - 'recallTime' => [ - 'description' => '撤回请求发起的时间。当messageSource为“recall”时，该字段非空。', - 'type' => 'string', - 'example' => '空 | 2023-03-22 12:17:08', - ], + 'userName' => ['description' => '生产者名称。', 'type' => 'string', 'example' => 'xxx'], + 'clientHost' => ['description' => '主机名。', 'type' => 'string', 'example' => 'xx.xx.xx.xx'], + 'produceTime' => ['description' => '发送时间。', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], + 'produceDuration' => ['description' => '发送耗时。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'produceStatus' => ['description' => '发送状态。', 'type' => 'string', 'example' => 'SUCCESS'], + 'arriveTime' => ['description' => '到达时间。', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], + 'messageSource' => ['description' => '消息来源。', 'type' => 'string', 'example' => 'CONSOLE'], + 'dlqOriginTopic' => ['description' => '死信队列主题。', 'type' => 'string', 'example' => 'test_topic'], + 'dlqOriginMessageId' => ['description' => '死信队列消息ID。', 'type' => 'string', 'example' => '0A79275A00207A4F0F2916C92F9A0B94'], + 'recallTime' => ['description' => '撤回请求发起的时间。当messageSource为“recall”时，该字段非空。', 'type' => 'string', 'example' => 'Empty | 2023-03-22 12:17:08'], ], ], ], @@ -7266,16 +4061,8 @@ 'description' => 'Broker轨迹信息。', 'type' => 'object', 'properties' => [ - 'presetDelayTime' => [ - 'description' => '预设投递时间。', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'delayStatus' => [ - 'description' => '定时状态。', - 'type' => 'string', - 'example' => 'SUCCESS', - ], + 'presetDelayTime' => ['description' => '预设投递时间。', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], + 'delayStatus' => ['description' => '定时状态。', 'type' => 'string', 'example' => 'SUCCESS'], 'operations' => [ 'description' => '操作列表。', 'type' => 'array', @@ -7283,24 +4070,12 @@ 'description' => '操作列表。', 'type' => 'object', 'properties' => [ - 'operateType' => [ - 'description' => '操作类型。', - 'type' => 'string', - 'example' => 'ADD', - ], - 'operateTime' => [ - 'description' => '操作时间。', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], + 'operateType' => ['description' => '操作类型。', 'type' => 'string', 'example' => 'ADD'], + 'operateTime' => ['description' => '操作时间。', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], ], ], ], - 'recallResult' => [ - 'description' => '撤回结果。当存在撤回记录时，该字段非空。', - 'type' => 'string', - 'example' => '空 | RECALL_OK | RECALL_FAIL', - ], + 'recallResult' => ['description' => '撤回结果。当存在撤回记录时，该字段非空。', 'type' => 'string', 'example' => 'Empty | RECALL_OK | RECALL_FAIL'], ], ], 'consumerInfos' => [ @@ -7310,11 +4085,7 @@ 'description' => '消费者轨迹信息。', 'type' => 'object', 'properties' => [ - 'consumerGroupId' => [ - 'description' => '消费组ID。', - 'type' => 'string', - 'example' => 'GID_inspector_group', - ], + 'consumerGroupId' => ['description' => '消费组ID。', 'type' => 'string', 'example' => 'GID_inspector_group'], 'records' => [ 'description' => '消费记录列表。', 'type' => 'array', @@ -7322,26 +4093,10 @@ 'description' => '消费记录列表。', 'type' => 'object', 'properties' => [ - 'userName' => [ - 'description' => '消费者名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'clientHost' => [ - 'description' => '主机名。', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'fifoEnable' => [ - 'description' => '是否顺序消费。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'consumeStatus' => [ - 'description' => '消费状态。', - 'type' => 'string', - 'example' => 'SUCCESS', - ], + 'userName' => ['description' => '消费者名称。', 'type' => 'string', 'example' => 'test'], + 'clientHost' => ['description' => '主机名。', 'type' => 'string', 'example' => 'xx.xx.xx.xx'], + 'fifoEnable' => ['description' => '是否顺序消费。', 'type' => 'boolean', 'example' => 'true'], + 'consumeStatus' => ['description' => '消费状态。', 'type' => 'string', 'example' => 'SUCCESS'], 'operations' => [ 'description' => '操作列表。', 'type' => 'array', @@ -7349,67 +4104,26 @@ 'description' => '操作列表。', 'type' => 'object', 'properties' => [ - 'operateType' => [ - 'description' => '操作类型。', - 'type' => 'string', - 'example' => 'ADD', - ], - 'operateTime' => [ - 'description' => '操作时间。', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], - 'invisibleTime' => [ - 'description' => '不可见时间，毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'deadMessage' => [ - 'description' => '是否为死信。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'operateType' => ['description' => '操作类型。', 'type' => 'string', 'example' => 'ADD'], + 'operateTime' => ['description' => '操作时间。', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], + 'invisibleTime' => ['description' => '不可见时间，毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'deadMessage' => ['description' => '是否为死信。', 'type' => 'boolean', 'example' => 'true'], ], ], ], - 'popCk' => [ - 'description' => 'POP_CK', - 'type' => 'string', - 'example' => '123', - ], + 'popCk' => ['description' => 'POP_CK', 'type' => 'string', 'example' => '123'], ], ], ], - 'consumeStatus' => [ - 'description' => '消费状态。', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'deadMessage' => [ - 'description' => '是否为死信。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'consumeStatus' => ['description' => '消费状态。', 'type' => 'string', 'example' => 'SUCCESS'], + 'deadMessage' => ['description' => '是否为死信。', 'type' => 'boolean', 'example' => 'true'], 'deadLetterInfo' => [ 'description' => '死信信息。', 'type' => 'object', 'properties' => [ - 'topicName' => [ - 'description' => '主题名称。', - 'type' => 'string', - 'example' => 'Register_Sync', - ], - 'messageId' => [ - 'description' => '消息ID。', - 'type' => 'string', - 'example' => '7F000001001F7A4F0F29463F0376047D', - ], - 'toDlqTime' => [ - 'description' => '到达死信队列时间。', - 'type' => 'string', - 'example' => '2023-03-22 12:17:08', - ], + 'topicName' => ['description' => '主题名称。', 'type' => 'string', 'example' => 'Register_Sync'], + 'messageId' => ['description' => '消息ID。', 'type' => 'string', 'example' => '7F000001001F7A4F0F29463F0376047D'], + 'toDlqTime' => ['description' => '到达死信队列时间。', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], ], ], ], @@ -7417,424 +4131,316 @@ ], ], ], - 'code' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'InvalidConsumerGroupId', - ], - 'message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidConsumerGroupId'], + 'message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['description' => '动态错误码。', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['description' => '动态错误信息。', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], - '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' => '获取消息轨迹', - ], - 'CreateInstanceAccount' => [ - 'summary' => '创建实例的访问账号。', - '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' => '实例ID。', - '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}'], + ], ], ], + ], + ], + 'ListAvailableZones' => [ + 'summary' => '查询支持的可用区。', + 'path' => '/zones', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体结构。', - 'type' => 'object', - 'properties' => [ - 'password' => [ - 'title' => '用户密码', - 'description' => '账号密码', - 'type' => 'string', - 'required' => true, - 'example' => 'xxx', - ], - 'username' => [ - 'description' => '账号名称', - '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' => '请求ID', - 'type' => 'string', - 'example' => '3AE0999C-8DBA-5CEE-8D9A-BE8D4A90DF8D', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', - 'type' => 'boolean', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'zoneId' => ['title' => '可用区id', 'description' => '可用区id', 'type' => 'string', 'example' => 'cn-qingdao-b'], + 'zoneName' => ['title' => '可用区名称', 'description' => '可用区名称', 'type' => 'string', 'example' => 'ha-cn-t9b30w902vm_qrs'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'updateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + ], + ], ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', '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' => '创建访问账号', - ], - 'UpdateInstanceAccount' => [ - 'summary' => '更新指定实例下指定账号的信息。', - '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' => '查询支持的可用区', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAvailableZones'], + ], ], + 'ramActions' => [], + ], + 'ListConsumerConnections' => [ + 'summary' => '获取指定消费者客户端的连接信息。', + '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' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-uax32mf9h1f'], ], [ - 'name' => 'username', + 'name' => 'consumerGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '消费者分组ID。', 'type' => 'string', 'required' => true, 'example' => 'GID_TEST_STOCK_OPEND_GW'], ], [ - 'name' => 'accountStatus', + 'name' => 'topicName', 'in' => 'query', - 'schema' => [ - 'description' => '账号状态。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DISABLE' => '禁用', - 'ENABLE' => '启用', - ], - 'example' => 'ENABLE', - ], + 'schema' => ['title' => 'lite类型的topic名称', 'description' => 'lite类型的topic名称', 'type' => 'string', 'required' => false, 'example' => 'test1'], ], [ - 'name' => 'password', + 'name' => 'liteTopicName', 'in' => 'query', - 'schema' => [ - 'description' => '账号密码。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => 'Lite消息队列主题名称', 'description' => 'Lite消息队列主题名称', 'type' => 'string', 'required' => false, 'example' => 'abc'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<ConsumerConnectionsDTO>', + 'description' => 'Result<ConsumerConnectionsDTO>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['title' => '区域ID', 'description' => '区域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'consumerGroupId' => ['title' => '主题名称', 'description' => '消费者组ID', 'type' => 'string', 'example' => 'CID-TEST'], + 'connections' => [ + 'title' => '客户端连接列表', + 'description' => '客户端连接列表', + 'type' => 'array', + 'items' => [ + 'description' => '客户端连接列表。', + 'type' => 'object', + 'properties' => [ + 'clientId' => ['title' => '客户端ID', 'description' => '客户端ID', 'type' => 'string', 'example' => '172.17.135.197@17392#1936705963#551717232#9873695589062458'], + 'hostname' => ['title' => '客户端IP', 'description' => '客户端IP', 'type' => 'string', 'example' => 'vos'], + 'egressIp' => ['title' => '宿主机IP/公网出网IP', 'description' => '宿主机IP/公网出网IP', 'type' => 'string', 'example' => 'xx.xx.xx.xx'], + 'language' => ['title' => '客户端语言', 'description' => '客户端语言', 'type' => 'string', 'example' => 'java'], + 'version' => ['title' => '客户端版本', 'description' => '客户端版本', 'type' => 'string', 'example' => '1.0'], + 'messageModel' => ['title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', 'description' => '消费者对消息的消费模式：'."\n" + .' - CLUSTERING'."\n" + .' - LITE_SELECTIVE'."\n" + .' - BROADCASTING', 'type' => 'string', 'example' => 'BROADCASTING'], + ], + ], + ], + ], ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingPageNumber'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => '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\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', - 'title' => '更新访问账号', - ], - 'DeleteInstanceAccount' => [ - 'summary' => '删除指定实例下的访问账号信息。', - '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' => '获取消费者客户端连接信息', + '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' => '查询消费组订阅关系列表。', + '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' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '云消息队列 RocketMQ 版的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-tl32wwz1r05'], ], [ - 'name' => 'username', + 'name' => 'consumerGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '账号名称', - 'type' => 'string', - 'required' => true, - 'example' => 'xxx', - ], + 'schema' => ['description' => '消费者分组ID，表示需要查询哪个消费者分组的订阅关系。', 'type' => 'string', 'required' => true, 'example' => 'PRINT_RETRY_CONSUMER'], + ], + [ + 'name' => 'topicName', + 'in' => 'query', + 'schema' => ['title' => '主题名称', 'description' => '主题名称，不填则查询所有订阅关系。', 'type' => 'string', 'required' => false, 'example' => 'topic_test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<SubscriptionDTO>>', + 'description' => 'Result<List<SubscriptionDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '157DF7D4-53FB-58C6-BEBC-A9400E7EF68A', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '5F4D9D5F-625B-59FF-BD4F-DA8284575DB4'], + 'success' => ['title' => '是否成功', 'description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '消费者组订阅关系列表。', + 'type' => 'object', + 'properties' => [ + 'consumerGroupId' => ['title' => '消费者组', 'description' => '消费者分组ID。', 'type' => 'string', 'example' => 'CID-TEST'], + 'topicName' => ['title' => '订阅主题', 'description' => '指定消费者分组订阅的主题。', 'type' => 'string', 'example' => 'topic_test'], + 'messageModel' => ['title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', 'description' => '消费者分组的消费模式。'."\n" + .'- BROADCASTING：广播模式'."\n" + .'- CLUSTERING：集群模式', 'type' => 'string', 'example' => 'CLUSTERING'], + 'subscriptionStatus' => ['title' => '订阅状态,SubscriptionStatusEnum[ONLINE(在线),OFFLINE(离线),code,desc]', 'description' => '订阅状态。'."\n" + .'- ONLINE：在线。消费者分组下如果有多个消费者，只要有一个消费者在线则显订阅状态为在线。'."\n" + .'- OFFLINE：离线。消费者分组下如果有多个消费者，所有消费者都处于离线时订阅状态才显示离线。', 'type' => 'string', 'example' => 'ONLINE'], + 'filterExpression' => ['title' => '过滤表达式', 'description' => '过滤表达式。', 'type' => 'string', 'example' => '*'], + 'filterExpressionType' => ['title' => '过滤表达式类型,SubscriptionExpressionTypeEnum[SQL(SQL过滤),TAG(TAG过滤),UNSPECIFIED(FILTER_TYPE_UNSPECIFIED 过滤类型未指定),code,desc]', 'description' => '过滤表达式类型。'."\n" + .'- SQL：SQL过滤'."\n" + .'- TAG：Tag过滤。', 'type' => 'string', 'example' => 'SQL'], + 'topicCreated' => ['description' => '是否创建了topic。', 'type' => 'boolean', 'example' => 'true'], + 'consistency' => ['description' => '订阅关系的一致性。'."\n" + .'- 订阅关系不一致为false。'."\n" + .'- 订阅关系一致为true。', 'type' => 'boolean', 'example' => 'true'], + ], + ], ], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'InstanceId'], ], ], ], ], - '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' => '删除访问账号', - ], - 'ListInstanceAccount' => [ - 'summary' => '查询指定实例下访问账号的列表。', - 'path' => '/instances/{instanceId}/accounts', - 'methods' => [ - 'get', + 'title' => '查询消费者组订阅关系列表', + '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' => '查询指定实例下消费者分组的列表信息。', + 'path' => '/instances/{instanceId}/consumerGroups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7844,237 +4450,118 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '209888', - 'abilityTreeNodes' => [ - 'FEATUREonsGA7IC4', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '144685', + 'abilityTreeNodes' => ['FEATUREonsYVMMCL'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '当前页码，从1开始。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['title' => '实例ID', 'description' => '指定需要获取哪个实例下的消费者分组列表。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'pageSize', + 'name' => 'filter', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，每页最多显示的返回结果数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '10', - 'example' => '10', - ], + 'schema' => ['title' => '过滤条件', 'description' => '查询的过滤条件，若不输入则查询指定实例下所有的消费者分组。', 'type' => 'string', 'required' => false, 'example' => 'CID-TEST'], ], [ - 'name' => 'username', + 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '分页页码', 'description' => '分页页码，查询第几页的返回结果。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'accountType', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '账号类型', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CUSTOMER' => '自定义账号', - 'DEFAULT' => '默认账号', - ], - 'example' => 'CUSTOMER', - ], - ], - [ - 'name' => 'accountStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '账号状态', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DISABLE' => '禁用', - 'ENABLE' => '启用', - ], - 'example' => 'ENABLE', - ], + 'schema' => ['title' => '分页大小', 'description' => '分页大小，每页最多显示的返回结果数量。'."\n" + ."\n" + .'取值范围：[10,100]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<MyPage<InstanceAccountDTO>>', - 'description' => 'Result<MyPage<InstanceAccountDTO>>', + 'title' => 'Result<MyPage<ConsumerGroupDTO>>', + 'description' => 'Result<MyPage<ConsumerGroupDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => '5503A460-98ED-5543-92CF-4853DE28****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', - 'description' => '返回结果', + 'description' => '返回结果。', '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' => '24', - ], + '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' => '分页数据', + 'description' => '分页数据。', 'type' => 'array', 'items' => [ - 'description' => '账号信息', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => 'regionId', - 'description' => '区域ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例id', - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'username' => [ - 'title' => '用户名', - 'description' => '账号名称', - 'type' => 'string', - 'example' => 'test', - ], - 'accountType' => [ - 'title' => '账号类型', - 'description' => '账号类型', - 'type' => 'string', - 'enumValueTitles' => [ - 'CUSTOMER' => '自定义账号', - 'DEFAULT' => '默认账号', - ], - 'example' => 'CUSTOMER', - ], - 'accountStatus' => [ - 'title' => '账号状态', - 'description' => '账号状态', + 'regionId' => ['title' => '区域ID', 'description' => '实例所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'consumerGroupId' => ['title' => '消费组ID', 'description' => '消费者分组ID。', 'type' => 'string', 'example' => 'GID-TEST'], + 'status' => [ + 'title' => '消费组状态', + 'description' => '消费者分组的状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'DISABLE' => '禁用', - 'ENABLE' => '启用', - ], - 'example' => 'ENABLE', - ], + 'enumValueTitles' => ['RUNNING' => '运行中', 'CREATING' => '创建中'], + 'example' => 'RUNNING', + 'enum' => ['CREATING', 'RUNNING'], + ], + 'remark' => ['title' => '备注', 'description' => '消费者分组的备注信息。', 'type' => 'string', 'example' => 'This is the remark for test.'], + 'createTime' => ['title' => '创建时间', 'description' => '消费者分组的创建时间。', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'updateTime' => ['title' => '修改时间', 'description' => '消费者分组的最后更新时间。', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'maxReceiveTps' => ['description' => '消费消息tps上限', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'messageModel' => ['title' => '消费模式', 'description' => '消费模式', 'type' => 'string', 'example' => 'LITE_SELECTIVE'], + 'topicName' => ['title' => 'lite类型的topicName', 'description' => 'lite类型的topicName', 'type' => 'string', 'example' => 'test1'], ], ], ], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter InstanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], - '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' => '查询访问账号列表', - ], - 'GetInstanceAccount' => [ - 'summary' => '获取指定实例的账号。', - 'path' => '/instances/{instanceId}/account', - 'methods' => [ - 'get', + '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' => '查询消费者分组列表', + 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConsumerGroups'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [ + 'summary' => '查询消费进度同步列表。', + 'path' => '/disaster_recovery/{planId}/items/{itemId}/checkpoints', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8083,651 +4570,600 @@ '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' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-20p36ja4m0y', - ], + 'schema' => ['title' => '备份计划ID', 'description' => '备份计划ID', 'type' => 'string', 'required' => true, 'example' => '1300000016'], ], [ - 'name' => 'username', + 'name' => 'itemId', + 'in' => 'path', + 'schema' => ['title' => '备份映射ID', 'description' => '备份映射ID', 'type' => 'string', 'required' => true, 'example' => '100070284'], + ], + [ + 'name' => 'instanceId', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。'."\n" - ."\n" - .'不传则返回默认账号。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '源实例ID', 'description' => '源实例ID', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => ['title' => '过滤条件', 'description' => '过滤条件', 'type' => 'string', 'required' => false, 'example' => 'topic_test'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Result', + 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'B5C59E80-FCFC-5796-ABE4-D39EAAE578E4', - ], - 'success' => [ - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ - 'description' => '返回结果。', + 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'username' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'example' => 'xxx', - ], - 'password' => [ - 'description' => '账号密码。', - 'type' => 'string', - 'example' => '*************', - ], - 'accountStatus' => [ - 'description' => '账号状态'."\n" - .' - ENABLE(启用)'."\n" - .' - DISABLE(禁用)', - 'type' => 'string', - 'enumValueTitles' => [ - 'DISABLE' => '禁用', - 'ENABLE' => '启用', + 'pageNumber' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'pageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'totalCount' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'list' => [ + 'description' => '分页数据', + 'type' => 'array', + 'items' => [ + 'description' => '分页数据', + 'type' => 'object', + 'properties' => [ + 'planId' => ['description' => '备份计划ID', 'type' => 'integer', 'format' => 'int64', 'example' => '13000000xx'], + 'itemId' => ['description' => '备份映射ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000xx'], + 'checkpointId' => ['description' => '消费进度ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000xx'], + 'lastSyncTime' => ['description' => '最近同步时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1740724080343'], + 'sourceProgress' => [ + 'description' => '源消费进度', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => '区域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-3mp3vblzxxx'], + 'instanceType' => ['description' => '实例类型'."\n" + .' - ALIYUN_ROCKETMQ ：阿里云实例'."\n" + .' - EXTERNAL_ROCKETMQ ：外部实例，开源实例，开源集群', 'type' => 'string', 'example' => 'ALIYUN_ROCKETMQ'], + 'consumerGroupId' => ['description' => '消费者组ID', 'type' => 'string', 'example' => 'GID_TEST'], + 'topicName' => ['description' => '主题名称', 'type' => 'string', 'example' => 'TOPIC_TEST'], + 'lastFetchTime' => ['description' => '最近获取时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1740724080343'], + 'progressData' => [ + 'description' => '消费进度数据', + 'type' => 'object', + 'properties' => [ + 'consumeTimestamp' => ['description' => '最新消费时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1740724080343'], + ], + ], + ], + ], + 'targetProgress' => [ + 'description' => '目标消费进度', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => '区域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-nwy3i065xxx'], + 'instanceType' => ['description' => '实例类型'."\n" + .' - ALIYUN_ROCKETMQ ：阿里云实例'."\n" + .' - EXTERNAL_ROCKETMQ ：外部实例，开源实例，开源集群', 'type' => 'string', 'example' => 'ALIYUN_ROCKETMQ'], + 'consumerGroupId' => ['description' => '消费者组ID', 'type' => 'string', 'example' => 'GID_TEST'], + 'topicName' => ['description' => '主题名称', 'type' => 'string', 'example' => 'TOPIC_TEST'], + 'lastFetchTime' => ['description' => '最新获取时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1740724080343'], + 'progressData' => [ + 'description' => '消费进度数据', + 'type' => 'object', + 'properties' => [ + 'consumeTimestamp' => ['description' => '最新消费时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1740724080343'], + ], + ], + ], + ], + ], ], - 'example' => 'ENABLE', ], ], ], - 'code' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'ConsumerGroupId', - ], - 'dynamicMessage' => [ - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['description' => '错误码', 'type' => 'string', 'example' => '200'], + 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], - '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' => '获取实例账号', - ], - 'CreateInstanceAcl' => [ - 'summary' => '在指定实例下创建访问的权限信息。', - 'path' => '/instances/{instanceId}/acl/account/{username}', - 'methods' => [ - 'post', + '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' => '查询消费进度同步列表', + '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' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListDisasterRecoveryItems' => [ + 'summary' => '查询备份映射任务列表。', + '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' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '备份计划id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], ], [ - 'name' => 'username', - 'in' => 'path', - 'schema' => [ - 'description' => '用户名称', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', - ], + 'name' => 'topicName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => '主题名称。', 'type' => 'string', 'required' => false, 'example' => 'topic-test284'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体结构。', - 'type' => 'object', - 'properties' => [ - 'resourceType' => [ - 'title' => '授权的资源列表', - 'description' => '授权的资源类型', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Group' => '消费者组', - 'Topic' => '主题', - ], - 'example' => 'Topic', - 'enum' => [ - 'Topic', - 'Group', - ], - ], - 'resourceName' => [ - 'title' => '授权资源名称', - 'description' => '授权的资源名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'decision' => [ - 'title' => '决策,DecisionEnum[ALLOW,DENY,type,desc]', - 'description' => '授权的决策结果', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Deny' => '拒绝访问', - 'Allow' => '允许访问', - ], - 'example' => 'Allow', - 'enum' => [ - 'Allow', - 'Deny', - ], - ], - 'actions' => [ - 'description' => '授权的操作类型。'."\n" - ."\n" - .'针对不同的资源类型，支持的操作类型如下：'."\n" - .'- 主题（Topic）：Pub、Sub、Pub|Sub'."\n" - .'- 消费者组（Group）: Sub', - 'type' => 'array', - 'items' => [ - 'description' => '授权的操作类型。'."\n" - ."\n" - .'针对不同的资源类型，支持的操作类型如下：'."\n" - .'- 主题（Topic）：Pub、Sub、PubSub'."\n" - .'- 消费者组（Group）: Sub', - 'type' => 'string', - 'required' => false, - 'example' => 'Pub', - ], - 'required' => true, - 'enumValueTitles' => [ - 'Sub' => '订阅', - 'Pub|Sub' => '发送订阅', - 'Pub' => '发送', - ], - 'example' => 'Pub', - ], - 'ipWhitelists' => [ - 'description' => 'IP白名单列表', - 'type' => 'array', - 'items' => [ - 'description' => 'IP白名单，支持IP和IP段。', - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0.0/0', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'filter', + 'in' => 'query', + 'schema' => ['description' => '过滤条件，根据topicName过滤', 'type' => 'string', 'required' => false, 'example' => 'topic_test'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页页码，查询第几页的返回结果。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '10', 'default' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<MyPage<DisasterRecoveryItemDTO>>', + 'description' => 'Result<MyPage<DisasterRecoveryItemDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5F88833', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C115601B-8736-5BBF-AC99-7FEAE12xxxx'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', + 'type' => 'object', + 'properties' => [ + 'scrollId' => ['title' => '滚动标识', 'description' => '请求滚动ID。'."\n" + .'系统自动生成，后续分页请求需要带上该返回结果，才能持续分页。', 'type' => 'string', 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00'."\n"], + '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' => '49'], + 'list' => [ + 'title' => '分页数据', + 'description' => '分页数据', + 'type' => 'array', + 'items' => [ + 'description' => '分页数据', + 'type' => 'object', + 'properties' => [ + 'itemId' => ['description' => '备份计划id', 'type' => 'integer', 'format' => 'int64', 'example' => '100070284'], + 'planId' => ['title' => '容灾Item所在容灾计划ID', 'description' => '映射id', 'type' => 'integer', 'format' => 'int64', 'example' => '1300000016'], + 'itemStatus' => ['title' => '容灾Item状态,DisasterRecoveryItemStatusEnum[CREATING(创建中),CHANGING(变更中),RUNNING(运行中),MANUAL_STOPPED(人工停用),OVERDUE_STOPPED(欠费停用),code,desc]', 'description' => '备份映射状态：'."\n" + .' - CREATING(创建中)'."\n" + .' - CHANGING(变更中)'."\n" + .' - RUNNING(运行中)'."\n" + .' - MANUAL_STOPPED(人工停用)'."\n" + .' - OVERDUE_STOPPED(欠费停用)', 'type' => 'string', 'example' => 'RUNNING'], + 'topics' => [ + 'title' => '容灾Item所包含的容灾主题', + 'description' => '备份映射所包含的主题', + 'type' => 'array', + 'items' => [ + 'description' => '备份映射所包含的主题', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => 'regionId', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceType' => ['title' => '实例类型', 'description' => '实例类型', 'type' => 'string', 'example' => 'ALIYUN_ROCKETMQ'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-kh43w0olz0c'], + 'topicName' => ['title' => '容灾主题名称', 'description' => '主题名称', 'type' => 'string', 'example' => 'topic-test'], + 'consumerGroupId' => ['title' => '消费者组ID', 'description' => '消费者组ID', 'type' => 'string', 'deprecated' => true, 'example' => 'group-test'], + 'deliveryOrderType' => [ + 'description' => '消息投递到目标实例的顺序性。'."\n" + ."\n" + .'参数取值如下：'."\n" + .'- Concurrently：并发投递'."\n" + .'- Orderly：顺序投递', + 'type' => 'string', + 'enumValueTitles' => ['Concurrently' => '并发投递', 'Orderly' => '顺序投递'], + 'example' => 'Concurrently', + ], + ], + ], + ], + 'extInfo' => [ + 'title' => '扩展信息', + 'description' => '扩展信息', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '扩展信息', 'example' => '{}'], + ], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-09-20 03:38:28'], + 'updateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2024-10-04 02:19:44'], + ], + ], + ], + ], ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '200'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'xxx'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '创建访问权限', - ], - 'UpdateInstanceAcl' => [ - 'summary' => '更新指定实例下，指定用户和资源的访问权限。', - 'path' => '/instances/{instanceId}/acl/account/{username}', - 'methods' => [ - 'patch', + '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' => '查询备份映射列表', + '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' => [ + 'summary' => '查询备份计划列表。', + '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' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-c97xxx'], ], [ - 'name' => 'username', - 'in' => 'path', - 'schema' => [ - 'description' => '用户名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'name' => 'filter', + 'in' => 'query', + 'schema' => ['description' => '过滤条件，根据备份名称，备份描述进行过滤', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体结构。', - 'type' => 'object', - 'properties' => [ - 'resourceType' => [ - 'title' => '授权的资源列表,ResourceTypeEnum[TOPIC,GROUP,code,desc]', - 'description' => '授权的资源类型', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Group' => '消费者组', - 'Topic' => '主题', - ], - 'example' => 'Topic', - ], - 'resourceName' => [ - 'title' => '授权资源名称', - 'description' => '授权的资源名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'actions' => [ - 'description' => '针对不同的资源类型，支持的操作类型如下：'."\n" - ."\n" - .'- 主题（Topic）：Pub、Sub、Pub|Sub'."\n" - .'- 消费者组（Group）: Sub', - 'type' => 'array', - 'items' => [ - 'description' => '针对不同的资源类型，支持的操作类型如下：'."\n" - ."\n" - .'- 主题（Topic）：Pub、Sub、PubSub'."\n" - .'- 消费者组（Group）: Sub', - 'type' => 'string', - 'required' => false, - 'example' => 'Pub', - ], - 'required' => false, - 'enumValueTitles' => [ - 'Sub' => '订阅', - 'Pub|Sub' => '发送订阅', - 'Pub' => '发送', - ], - 'example' => 'Pub', - ], - 'decision' => [ - 'title' => '决策,DecisionEnum[ALLOW,DENY,type,desc]', - 'description' => '授权的决策结果', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Deny' => '拒绝访问', - 'Allow' => '允许访问', - ], - 'example' => 'Allow', - ], - 'ipWhitelists' => [ - 'title' => 'ip白名单', - 'description' => 'IP白名单列表', - 'type' => 'array', - 'items' => [ - 'description' => 'IP白名单', - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0.0/0', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页页码，查询第几页的返回结果。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '10', 'default' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<MyPage<DisasterRecoveryPlanDTO>>', + 'description' => 'Result<MyPage<DisasterRecoveryPlanDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '855EF8E6-9C1D-5DE2-9E84-924E13Exxxx'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'True'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', + 'type' => 'object', + 'properties' => [ + 'scrollId' => ['title' => '滚动标识', 'description' => '请求滚动ID。'."\n" + .'系统自动生成，后续分页请求需要带上该返回结果，才能持续分页。', 'type' => 'string', 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00'."\n"], + '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' => '28'], + 'list' => [ + 'title' => '分页数据', + 'description' => '分页数据', + 'type' => 'array', + 'items' => [ + 'description' => '分页数据', + 'type' => 'object', + 'properties' => [ + 'planId' => ['title' => '计划ID', 'description' => '计划ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1300000016'], + 'planName' => ['title' => '计划名称', 'description' => '计划名称', 'type' => 'string', 'example' => 'xxx'], + 'planDesc' => ['title' => '计划描述', 'description' => '计划描述', 'type' => 'string', 'example' => 'xxx'], + 'planType' => ['title' => '计划类型,DisasterRecoveryTypeEnum[ACTIVE_PASSIVE(灾备),ACTIVE_ACTIVE(双活),code,desc]', 'description' => '计划类型：'."\n" + .' - ACTIVE_PASSIVE(单向备份)'."\n" + .' - ACTIVE_ACTIVE(双向备份)', 'type' => 'string', 'example' => 'ACTIVE_PASSIVE'], + 'planStatus' => ['title' => '计划状态,DisasterRecoveryStatusEnum[CREATED(已创建),DELETED(已删除),code,desc]', 'description' => '计划状态：'."\n" + .' - CREATED(已创建)'."\n" + .' - RUNNING(运行中)'."\n" + .' - DELETED(已删除)', 'type' => 'string', 'example' => 'RUNNING'], + 'extInfo' => [ + 'title' => '扩展信息', + 'description' => '扩展信息', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '扩展信息', 'example' => 'xxx'], + ], + 'instances' => [ + 'title' => '容灾计划参与实例', + 'description' => '备份计划参与实例', + 'type' => 'array', + 'items' => [ + 'description' => '备份计划参与实例', + 'type' => 'object', + 'properties' => [ + 'instanceType' => ['title' => '实例类型', 'description' => '实例类型', 'type' => 'string', 'example' => 'ALIYUN_ROCKETMQ'], + 'regionId' => ['title' => '实例所在区域', 'description' => '实例所在区域', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-ot93rbxxx'], + 'instanceRole' => ['title' => '实例角色', 'description' => '实例角色', 'type' => 'string', 'example' => 'ACTIVE'], + 'authType' => ['title' => '认证方式', 'description' => '认证方式', 'type' => 'string', 'example' => 'NO_AUTH'], + 'username' => ['title' => '认证用户名', 'description' => '认证用户名', 'type' => 'string', 'example' => 'xxx'], + 'password' => ['title' => '认证密码', 'description' => '认证密码', 'type' => 'string', 'example' => 'xxx'], + 'endpointUrl' => ['title' => '接入点地址', 'description' => '接入点地址', 'type' => 'string', 'example' => 'xxx'], + 'networkType' => ['title' => '网络类型', 'description' => '网络类型', 'type' => 'string', 'example' => 'TCP_INTERNET'], + 'vpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-bp13docqysrgxtbxxxx'], + 'vSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID', 'type' => 'string', 'example' => 'vsw-uf6gwtbn6etadpv******'."\n"], + 'messageProperty' => [ + 'description' => '消息属性', + 'type' => 'object', + 'properties' => [ + 'propertyKey' => ['description' => '属性key', 'type' => 'string', 'example' => 'aaa'], + 'propertyValue' => ['description' => '属性value', 'type' => 'string', 'example' => 'bbb'], + ], + ], + 'securityGroupId' => ['description' => '安全组id', 'type' => 'string', 'example' => 'sg-bp17hpmgz9******'."\n"], + 'consumerGroupId' => ['description' => '消费者组ID，用于从源实例拉取消息。', 'type' => 'string', 'example' => 'GID_xxx'], + ], + ], + ], + 'syncCheckpointEnabled' => ['title' => '同步消费进度开关', 'description' => '同步消费进度开关', 'type' => 'boolean', 'example' => 'true'], + 'autoSyncCheckpoint' => ['title' => '是否自动同步消费进度', 'description' => '是否自动同步消费进度', 'type' => 'boolean', 'example' => 'true'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'updateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + ], + ], + ], + ], ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '200'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'xxx'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'InstanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '更新访问权限', - ], - 'DeleteInstanceAcl' => [ - 'summary' => '删除指定实例下，指定账号和资源的权限。', - '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_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' => '查询备份计划列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'rocketmq:ListDisasterRecoveryPlans', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListInstanceAccount' => [ + 'summary' => '查询指定实例下访问账号的列表。', + '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' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '10'], ], [ 'name' => 'username', - 'in' => 'path', - 'schema' => [ - 'description' => '用户名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'in' => 'query', + 'schema' => ['description' => '账号名称', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'resourceType', + 'name' => 'accountType', 'in' => 'query', 'schema' => [ - 'description' => '授权的资源类型', + 'description' => '账号类型', 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Group' => '消费者组', - 'Topic' => '主题', - ], - 'example' => 'Topic', + 'required' => false, + 'enumValueTitles' => ['CUSTOMER' => '自定义账号', 'DEFAULT' => '默认账号'], + 'example' => 'CUSTOMER', ], ], [ - 'name' => 'resourceName', + 'name' => 'accountStatus', 'in' => 'query', 'schema' => [ - 'description' => '授权的资源名称', + 'description' => '账号状态', 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'required' => false, + 'enumValueTitles' => ['DISABLE' => '禁用', 'ENABLE' => '启用'], + 'example' => 'ENABLE', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<MyPage<InstanceAccountDTO>>', + 'description' => 'Result<MyPage<InstanceAccountDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '7358418D-83BD-507A-8079-611C63E05674', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', + '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' => '24'], + 'list' => [ + 'title' => '分页数据', + 'description' => '分页数据', + 'type' => 'array', + 'items' => [ + 'description' => '账号信息', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['title' => 'regionId', 'description' => '区域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例id', 'description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'username' => ['title' => '用户名', 'description' => '账号名称', 'type' => 'string', 'example' => 'test'], + 'accountType' => [ + 'title' => '账号类型', + 'description' => '账号类型', + 'type' => 'string', + 'enumValueTitles' => ['CUSTOMER' => '自定义账号', 'DEFAULT' => '默认账号'], + 'example' => 'CUSTOMER', + ], + 'accountStatus' => [ + 'title' => '账号状态', + 'description' => '账号状态', + 'type' => 'string', + 'enumValueTitles' => ['DISABLE' => '禁用', 'ENABLE' => '启用'], + 'example' => 'ENABLE', + ], + 'remark' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'example' => 'test'], + ], + ], + ], + ], ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'type' => 'string', 'example' => 'xxx'], + ], + ], + ], + ], + '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' => '查询访问账号列表', + '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' => '删除访问权限', ], 'ListInstanceAcl' => [ 'summary' => '查询指定实例下的访问权限列表。', 'path' => '/instances/{instanceId}/acl', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8738,56 +5174,28 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '209895', - 'abilityTreeNodes' => [ - 'FEATUREonsO60XBD', - ], + 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '当前页码，从1开始。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '当前页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1'], ], [ 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，每页最多显示的返回结果数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '10', - 'example' => '10', - ], + 'schema' => ['description' => '分页大小，每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '10'], ], [ 'name' => 'filter', 'in' => 'query', - 'schema' => [ - 'description' => '查询的过滤条件，若不输入则查询所有权限。', - 'type' => 'string', - 'required' => false, - 'example' => 'CID-TEST', - ], + 'schema' => ['description' => '查询的过滤条件，若不输入则查询所有权限。', 'type' => 'string', 'required' => false, 'example' => 'CID-TEST'], ], ], 'responses' => [ @@ -8797,44 +5205,16 @@ 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DA4D2F89-E2C8-5F04-936B-60D55B055FA7', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'DA4D2F89-E2C8-5F04-936B-60D55B055FA7'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', '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' => '24', - ], + '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' => '24'], 'list' => [ 'title' => '分页数据', 'description' => '分页数据', @@ -8843,57 +5223,29 @@ 'description' => '权限信息', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'title' => '区域ID', - 'description' => '区域ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], + 'regionId' => ['title' => '区域ID', 'description' => '区域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], 'aclType' => [ 'title' => '访问类型', 'description' => '访问类型', 'type' => 'string', - 'enumValueTitles' => [ - 'APACHE' => '开源ACL', - ], + 'enumValueTitles' => ['APACHE' => '开源ACL'], 'example' => 'APACHE', ], - 'username' => [ - 'title' => '访问秘钥', - 'description' => '用户名称', - 'type' => 'string', - 'example' => 'test', - ], + 'username' => ['title' => '访问秘钥', 'description' => '用户名称', 'type' => 'string', 'example' => 'test'], 'resourceType' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', - 'enumValueTitles' => [ - 'Group' => '消费者组', - 'Topic' => '主题', - ], + 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], 'example' => 'Topic', ], - 'resourceName' => [ - 'title' => '资源名称', - 'description' => '资源名称', - 'type' => 'string', - 'example' => 'test', - ], + 'resourceName' => ['title' => '资源名称', 'description' => '资源名称', 'type' => 'string', 'example' => 'test'], 'decision' => [ 'title' => '决策,DecisionEnum[ALLOW,DENY,type,desc]', 'description' => '决策结果', 'type' => 'string', - 'enumValueTitles' => [ - 'Deny' => '拒绝访问', - 'Allow' => '允许访问', - ], + 'enumValueTitles' => ['Deny' => '拒绝访问', 'Allow' => '允许访问'], 'example' => 'Allow', ], 'actions' => [ @@ -8902,10 +5254,7 @@ 'items' => [ 'description' => '操作类型', 'type' => 'string', - 'enumValueTitles' => [ - 'Sub' => '订阅', - 'Pub' => '发送', - ], + 'enumValueTitles' => ['Sub' => '订阅', 'Pub' => '发送'], 'example' => 'Pub', ], ], @@ -8913,70 +5262,45 @@ 'title' => 'ip白名单', 'description' => 'IP白名单列表', 'type' => 'array', - 'items' => [ - 'description' => 'IP白名单', - 'type' => 'string', - 'example' => '0.0.0.0/0', - ], + 'items' => ['description' => 'IP白名单', 'type' => 'string', 'example' => '0.0.0.0/0'], ], ], ], ], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'InstanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '查询访问权限列表', - ], - 'GetInstanceAcl' => [ - 'summary' => '查询访问权限信息详情。', - 'path' => '/instances/{instanceId}/acl/account/{username}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + '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' => [ + 'summary' => '查询访问控制IP白名单列表。', + 'path' => '/instances/{instanceId}/ip/whitelist', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8985,439 +5309,498 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '263406', - 'abilityTreeNodes' => [ - 'FEATUREonsO60XBD', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '209879', + 'abilityTreeNodes' => ['FEATUREonsO60XBD'], ], 'parameters' => [ [ 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'username', - 'in' => 'path', - 'schema' => [ - 'description' => '用户名称', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', - ], + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'resourceType', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '授权的资源类型', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Group' => '消费者组', - 'Topic' => '主题', - ], - 'example' => 'Topic', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '10'], ], [ - 'name' => 'resourceName', + 'name' => 'ipWhitelist', 'in' => 'query', - 'schema' => [ - 'description' => '授权的资源名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '过滤条件，IP白名单。', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'Result<MyPage<String>>', + 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id，每次请求都是唯一值，便于后续排查问题', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '7358418D-83BD-507A-8079-611C63E05674'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ + 'title' => '返回结果', 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => '区域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'aclType' => [ - 'description' => '实例的鉴权类型。'."\n" - ."\n" - .'参数取值如下：'."\n" - .' '."\n" - .'- apache_acl：开源ACL'."\n" - .'- default：实例默认账号', - 'type' => 'string', - 'example' => 'apache_acl', - ], - 'username' => [ - 'description' => '用户名称', - 'type' => 'string', - 'example' => 'abc', - ], - 'resourceType' => [ - 'description' => '授权的资源类型', - 'type' => 'string', - 'example' => 'Topic', - ], - 'resourceName' => [ - 'description' => '授权的资源名称', - 'type' => 'string', - 'example' => 'test', - ], - 'decision' => [ - 'description' => '授权的决策结果', - 'type' => 'string', - 'example' => 'Allow', - ], - 'actions' => [ - 'description' => '授权的操作类型列表。', - 'type' => 'array', - 'items' => [ - 'description' => '授权的操作类型。', - 'type' => 'string', - 'example' => 'Pub', - ], - ], - 'ipWhitelists' => [ - 'description' => 'IP白名单列表', + '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' => '5'], + 'list' => [ + 'title' => '分页数据', + 'description' => '分页数据', 'type' => 'array', - 'items' => [ - 'description' => 'IP白名单，支持IP和IP段。', - 'type' => 'string', - 'example' => '0.0.0.0/0', - ], + 'items' => ['description' => 'IP白名单', 'type' => 'string', 'example' => '0.0.0.0/0'], ], ], ], - 'code' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Instance.NotFound'."\n"], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '查询访问权限详情', - ], - 'CreateInstanceIpWhitelist' => [ - 'summary' => '创建访问控制IP白名单。', - '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' => '查询IP白名单列表', + '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' => '查询指定地域下，所有的云消息队列 RocketMQ 版实例的列表信息。', + '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' => '实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'name' => 'filter', + 'in' => 'query', + 'schema' => ['title' => '过滤关键字', 'description' => '查询的过滤条件，若不输入则查询所有实例。', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['title' => '分页页码', 'description' => '分页页码，查询第几页的返回结果。'."\n" + ."\n" + .'取值范围：1~100000000。'."\n" + ."\n" + .'若您设置的参数值小于1，则系统默认按照参数值为1处理；若您设置的参数值大于100000000，则系统默认按照参数值为100000000处理。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['title' => '分页大小', 'description' => '分页大小，每页最多显示的返回结果数量。'."\n" + ."\n" + .'取值范围：10~200。'."\n" + ."\n" + .'若您设置的参数值小于10，则系统默认按照参数值为10处理；若您设置的参数值大于200，则系统默认按照参数值为200处理。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '10', 'example' => '10'], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '资源组ID', 'description' => '实例所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmx7caj******'], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'schema' => ['description' => '资源标签列表，用于筛选实例。', 'type' => 'string', 'required' => false, 'example' => '[{"key": "rmq-test", "value": "test"}]'], + ], + [ + 'name' => 'seriesCodes', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '请求体对象。', - 'type' => 'object', - 'properties' => [ - 'ipWhitelists' => [ - 'description' => 'IP白名单列表', - 'type' => 'array', - 'items' => [ - 'description' => 'IP白名单', - 'type' => 'string', - 'required' => true, - 'example' => '0.0.0.0/0', - ], - 'required' => true, - ], - ], + 'description' => '实例的主系列编码。'."\n" + ."\n" + .'参数取值如下：'."\n" + .'- standard：标准版'."\n" + .'- ultimate：铂金版'."\n" + .'- professional：专业版'."\n" + .'- dedicated： 独享版'."\n" + .'- shared： 共享版', + 'type' => 'array', + 'items' => ['description' => '实例的主系列编码。', 'type' => 'string', 'required' => false, 'example' => 'standard'], 'required' => false, ], ], + [ + 'name' => 'storageSecretKey', + 'in' => 'query', + 'schema' => ['title' => '存储加密密钥Key', 'description' => '存储加密密钥Key', 'type' => 'string', 'required' => false, 'example' => 'xxxxx'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<MyPage<InstanceDTO>>', + 'description' => 'Result<MyPage<InstanceDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A07B41BD-6DD3-5349-9E76-00303DF04BBE', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => '84445A20-2B50-5306-A3C0-AF99FC1833C6'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', + 'description' => '返回结果。', + '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' => '100'], + 'list' => [ + 'title' => '分页数据', + 'description' => '分页数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'regionId' => ['title' => '区域ID', 'description' => '实例所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'instanceName' => ['title' => '实例名称', 'description' => '实例名称。', 'type' => 'string', 'example' => 'test instance'], + 'status' => [ + 'title' => '实例状态', + 'description' => '实例状态。'."\n" + ."\n" + .'参数取值如下：'."\n" + .'- RELEASED（已释放）'."\n" + .'- RUNNING（运行中）'."\n" + .'- STOPPED（已停服）'."\n" + .'- CHANGING（变更中）'."\n" + .'- CREATING（创建中）', + 'type' => 'string', + 'enumValueTitles' => ['RELEASED' => '已释放', 'RUNNING' => '运行中', 'STOPPED' => '已停服', 'CHANGING' => '变更中', 'CREATING' => '创建中'], + 'example' => 'RUNNING', + 'enum' => ['CREATING', 'CHANGING', 'RUNNING', 'STOPPED', 'RELEASED'], + ], + 'startTime' => ['title' => '开服时间', 'description' => '实例的创建时间。', 'type' => 'string', 'example' => '2022-08-01 00:00:00'], + 'expireTime' => ['title' => '过期时间', 'description' => '实例的到期时间。', 'type' => 'string', 'example' => '2022-09-01 00:00:00'], + 'releaseTime' => ['title' => '释放时间', 'description' => '实例的释放时间。', 'type' => 'string', 'example' => '2022-09-07 00:00:00'], + 'userId' => ['title' => '所属人ID', 'description' => '实例所属的用户ID。', 'type' => 'string', 'example' => '6W0xz2uPfiwp****'], + 'commodityCode' => ['title' => '商品编码', 'description' => '消息队列RocketMQ 5.x系列实例的商品代号，类似于ons_rmqsub_public_cn。', 'type' => 'string', 'example' => 'ons_rmqsub_public_cn'], + 'serviceCode' => ['title' => '服务编码', 'description' => '实例所属的服务编码。消息队列RocketMQ版的服务编码为rmq。', 'type' => 'string', 'example' => 'rmq'], + 'seriesCode' => [ + 'title' => '系列编码', + 'description' => '实例的主系列编码。'."\n" + ."\n" + .'参数取值如下：'."\n" + .'- standard：标准版'."\n" + .'- ultimate：铂金版'."\n" + .'- professional：专业版'."\n" + .'- shared: 共享版'."\n" + .'- dedicated：独享版', + 'type' => 'string', + 'enumValueTitles' => ['standard' => '标准版', 'ultimate' => '铂金版', 'professional' => '专业版'], + 'example' => 'standard', + ], + 'subSeriesCode' => [ + 'title' => '子系列编码', + 'description' => '实例的子系列编码。'."\n" + ."\n" + .'参数取值如下：'."\n" + .'- cluster_ha：集群高可用版'."\n" + .'- single_node：单节点版'."\n" + .'- serverless： serverless版本', + 'type' => 'string', + 'enumValueTitles' => ['cluster_ha' => '集群高可用版', 'single_node' => '单节点版'], + 'example' => 'cluster_ha', + ], + 'paymentType' => [ + 'title' => '付费类型', + 'description' => '实例的付费类型。'."\n" + ."\n" + .'参数取值如下：'."\n" + .'- PayAsYouGo：按量付费（后付费）'."\n" + .'- Subscription：包年包月（预付费）', + 'type' => 'string', + 'enumValueTitles' => ['PayAsYouGo' => '按量付费（后付费）', 'Subscription' => '包年包月（预付费）'], + 'example' => 'Subscription', + 'enum' => ['Subscription', 'PayAsYouGo'], + ], + 'remark' => ['title' => '备注', 'description' => '实例的备注信息。', 'type' => 'string', 'example' => 'This is remark for instance.'], + 'topicCount' => ['title' => '主题数量', 'description' => '实例中所创建的主题数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'groupCount' => ['title' => '消费组数量', 'description' => '实例中所创建的消费者分组的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'createTime' => ['title' => '创建时间', 'description' => '实例的版本更新时间。', 'type' => 'string', 'example' => '2022-08-01 00:00:00'], + 'updateTime' => ['title' => '修改时间', 'description' => '实例的最后修改时间。', 'type' => 'string', 'example' => '2022-08-02 00:00:00'], + 'resourceGroupId' => ['title' => '资源组ID', 'description' => '实例所属的资源组ID。', 'type' => 'string', 'example' => 'rg-acfmx7caj******'], + 'tags' => [ + 'title' => '资源标签列表。', + 'description' => '资源标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => '资源标签。', + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '资源标签key值。', 'description' => '资源标签key值。', 'type' => 'string', 'example' => 'key'], + 'value' => ['title' => '资源标签value值。', 'description' => '资源标签value值。', 'type' => 'string', 'example' => 'value'], + ], + ], + ], + 'productInfo' => [ + 'description' => '产品信息。', + 'type' => 'object', + 'properties' => [ + 'traceOn' => ['description' => '是否开启消息轨迹功能。'."\n" + .'- true：开启消息轨迹功能'."\n" + .'- false：关闭消息轨迹功能'."\n" + ."\n" + .'<props="intl">该参数暂不生效，不管参数是否开启，实例都默认支持轨迹功能。</props>'."\n" + .'<props="china">该参数仅对Serverless类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见[Serverless计费说明](~~2586280~~)。</props>'."\n" + ."\n" + .'<props="china">对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。</props>', 'type' => 'boolean', 'example' => 'true'], + 'capacityType' => ['description' => '容量模式:'."\n" + .' - provisioned： 预留+弹性'."\n" + .' - ondemand： 按量付费', 'type' => 'string', 'example' => 'provisioned'], + ], + ], + ], + ], + ], + ], ], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'MissingPageNumber'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter pageNumber is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'PageNumber'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'pageNumber'], ], ], ], ], - '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' => '创建IP白名单', - ], - 'DeleteInstanceIpWhitelist' => [ - 'summary' => '删除指定实例下的指定全局IP白名单。', - 'path' => '/instances/{instanceId}/ip/whitelist', - 'methods' => [ - 'delete', + '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' => '查询实例列表', + 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => '查询消息列表。', + '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' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-zvp2vtypu05'], ], [ - 'name' => 'ipWhitelist', + 'name' => 'topicName', + 'in' => 'path', + 'schema' => ['description' => '主题名称。', 'type' => 'string', 'required' => true, 'example' => 'test_delay_queue'], + ], + [ + 'name' => 'messageId', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => '0.0.0.0/0', - ], + 'schema' => ['description' => '消息ID。', 'type' => 'string', 'required' => false, 'example' => '7F00000100207A4F0F294A938F7807AE'], ], [ - 'name' => 'ipWhitelists', + 'name' => 'messageKey', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'ip白名单列表', - 'type' => 'array', - 'items' => [ - 'description' => 'ip白名单', - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0.0/0', - ], - 'required' => false, - ], + 'schema' => ['description' => '消息key。', 'type' => 'string', 'required' => false, 'example' => 'XSCBillResult'], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '查询时间范围：开始时间。', 'type' => 'string', 'required' => false, 'example' => '2024-09-09 08:00:00'], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '查询时间范围：结束时间', 'type' => 'string', 'required' => false, 'example' => '2024-09-09 09:00:00'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '当前页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '分页大小，每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '20', 'minimum' => '1', 'example' => '10'], + ], + [ + 'name' => 'scrollId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '请求滚动ID。'."\n" + ."\n" + .'第一页请求无需传递，后续分页请求根据第一页返回结果，带上该字段。', 'type' => 'string', 'required' => false, 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00'], + ], + [ + 'name' => 'liteTopicName', + 'in' => 'query', + 'schema' => ['title' => '轻量主题名称', 'description' => '轻量主题名称', 'type' => 'string', 'required' => false, 'example' => 'abc'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<MyPage<MessageDTO>>', + 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '16425867-C948-5A0C-9A24-5259727BE727', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', + 'type' => 'object', + 'properties' => [ + 'pageNumber' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'pageSize' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'totalCount' => ['title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'list' => [ + 'title' => '分页数据', + 'description' => '分页数据', + 'type' => 'array', + 'items' => [ + 'description' => '消息信息', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['title' => '区域ID', 'description' => '区域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'topicName' => ['title' => '主题名称', 'description' => '主题名称', 'type' => 'string', 'example' => 'topic_test'], + 'messageId' => ['title' => '消息ID', 'description' => '消息ID', 'type' => 'string', 'example' => '7F000001000114B4340C5ABF94500079'], + 'bornTime' => ['title' => '生成时间', 'description' => '生成时间', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], + 'storeTime' => ['title' => '存储时间', 'description' => '存储时间', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], + 'body' => ['title' => '消息体', 'description' => '消息体', 'type' => 'string', 'example' => '{}'], + 'bodySize' => ['description' => '消息体大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'bornHost' => ['title' => '消息来自哪里', 'description' => '消息生产客户端', 'type' => 'string', 'example' => 'xx.xx.xx.xx'], + 'storeHost' => ['title' => '消息存储位置', 'description' => '消息存储服务端', 'type' => 'string', 'example' => 'xx.xx.xx.xx'], + 'messageType' => ['title' => '消息类型', 'description' => '消息类型', 'type' => 'string', 'example' => 'NORMAL'], + 'messageTag' => ['title' => '标签列表', 'description' => '消息标签', 'type' => 'string', 'example' => 'xx'], + 'messageGroup' => ['title' => '以前的shardingkey，顺序消息独有', 'description' => '消息分组，顺序消息独有。', 'type' => 'string', 'example' => 'xx'], + 'messageKeys' => [ + 'title' => '业务标识', + 'description' => '业务标识', + 'type' => 'array', + 'items' => ['description' => '业务标识。', 'type' => 'string', 'example' => 'xx'], + ], + 'userProperties' => [ + 'title' => '用户属性', + 'description' => '用户属性', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '用户属性。', 'example' => 'xx'], + ], + 'liteTopicName' => ['title' => '轻量主题名称', 'description' => '轻量主题名称', 'type' => 'string', 'example' => 'abc'], + ], + ], + ], + 'scrollId' => ['description' => '请求滚动ID。'."\n" + ."\n" + .'系统自动生成，后续分页请求需要带上该返回结果，才能持续分页。', 'type' => 'string', 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00'], + ], ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], - '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' => '删除IP白名单', - ], - 'ListInstanceIpWhitelist' => [ - 'summary' => '查询访问控制IP白名单列表。', - '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' => '查询消息列表', + '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' => [ + 'summary' => '查询监控项列表。', + 'path' => '/monitor/metrics/meta', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9425,171 +5808,88 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '209879', - 'abilityTreeNodes' => [ - 'FEATUREonsO60XBD', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], - ], - [ 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '当前页码，从1开始。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '分页页码，查询第几页的返回结果。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1'], ], [ 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '10', - 'example' => '10', - ], - ], - [ - 'name' => 'ipWhitelist', - 'in' => 'query', - 'schema' => [ - 'description' => '过滤条件，IP白名单。', - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0.0/0', - ], + 'schema' => ['description' => '分页大小，每页做多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '10', 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<MyPage<String>>', - 'description' => 'Result', + 'title' => 'Result<MyPage<MetricMetaDTO>>', + 'description' => 'Result<MyPage<MetricMetaDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '7358418D-83BD-507A-8079-611C63E05674', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '8B459455-4A35-5796-BA9D-98EF1AB9A931'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', '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' => '5', - ], + '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' => '分页数据', 'type' => 'array', 'items' => [ - 'description' => 'IP白名单', - 'type' => 'string', - 'example' => '0.0.0.0/0', + 'description' => '监控项列表。', + 'type' => 'object', + 'properties' => [ + 'metricName' => ['title' => '监控项名称', 'description' => '监控项名称', 'type' => 'string', 'example' => 'SendMessageCountPerInstance'], + 'description' => ['title' => '监控项描述', 'description' => '监控项描述', 'type' => 'string', 'example' => 'Using Serverless Devs to deploy the infrastructure of project:get-userinfo-v1-infrastructure-as-template-project'], + 'category' => ['title' => '监控项标签', 'description' => '监控项标签', 'type' => 'string', 'example' => 'Bug'], + ], ], ], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Instance.NotFound'."\n", - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The topic already exists.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], - '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' => '查询IP白名单列表', - ], - 'GetInstanceIpWhitelist' => [ - 'summary' => '查询访问控制IP白名单详情。', - '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\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => '查询监控项列表', + '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' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListMigrationOperations' => [ + 'summary' => '查询迁移操作列表。', + 'path' => '/migrations/{migrationId}/stages/{stageType}/operations', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9597,130 +5897,212 @@ ], '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' => '迁移ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '135'], + ], + [ + 'name' => 'stageType', 'in' => 'path', 'schema' => [ - 'description' => '实例ID', + 'description' => '迁移阶段类型。', 'type' => 'string', 'required' => true, - 'example' => 'rmq-cn-7e22ody****', + 'enumValueTitles' => ['MIGRATE_MESSAGE' => '消息迁移'], + 'example' => 'MIGRATE_MESSAGE', ], ], [ - 'name' => 'ipWhitelists', + 'name' => 'operationType', + 'in' => 'query', + 'schema' => [ + 'description' => '操作类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['MIGRATE_MESSAGE' => '迁移消息'], + 'example' => 'MIGRATE_MESSAGE', + ], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => ['description' => '查询的过滤条件。'."\n" + ."\n" + .'>'."\n" + .'> - 支持基于operationKey，即Topic名称进行过滤', 'type' => 'string', 'required' => false, 'example' => 'xx'], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-zxu37eiqq0x'], + ], + [ + 'name' => 'operationStatus', 'in' => 'query', 'style' => 'simple', 'schema' => [ - 'description' => 'IP白名单过滤列表', + 'title' => '操作状态', + 'description' => '操作状态', 'type' => 'array', - 'items' => [ - 'description' => 'IP白名单', - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0.0/0', - ], + 'items' => ['description' => '操作状态', 'type' => 'string', 'required' => false, 'example' => 'DOING'], + 'required' => false, + ], + ], + [ + 'name' => 'businessStatus', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'title' => '操作业务状态', + 'description' => '操作业务状态', + 'type' => 'array', + 'items' => ['description' => '操作业务状态', 'type' => 'string', 'required' => false, 'example' => 'DOUBLE_READ'], 'required' => false, ], ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页页码，查询第几页的返回结果。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '10000', 'minimum' => '10', 'example' => '10'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结果', + 'title' => 'Result<MyPage<MigrationOperationDTO>>', + 'description' => 'Result<MyPage<MigrationOperationDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '0B962390-D84B-5D44-8C11-79DF40299D41', - ], - 'success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5F88833'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ - 'description' => '返回数据对象', + 'title' => '返回结果', + 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => '区域ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'ipWhitelists' => [ - 'description' => 'IP白名单列表', + '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' => '分页数据', 'type' => 'array', 'items' => [ - 'description' => 'IP白名单', - 'type' => 'string', - 'example' => '0.0.0.0/0', + 'description' => '迁移操作列表。', + 'type' => 'object', + 'properties' => [ + 'operationId' => ['title' => '迁移操作ID', 'description' => '迁移操作ID', 'type' => 'integer', 'format' => 'int64', 'example' => '183'], + 'migrationId' => ['title' => '迁移ID', 'description' => '迁移ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'stageType' => [ + 'title' => '迁移阶段类型', + 'description' => '迁移阶段类型', + 'type' => 'string', + 'enumValueTitles' => ['MIGRATE_MESSAGE' => '消息迁移'], + 'example' => 'MIGRATE_MESSAGE', + ], + 'operationType' => [ + 'title' => '操作类型,MigrationOperationTypeEnum[IMPORT_TOPIC(导入主题),IMPORT_CONSUMER_GROUP(导入消费者组),CONNECT_NETWORK(网络打通),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(迁移消息),code(编码),desc(描述),param(参数类型),result(结果类型)]', + 'description' => '操作类型。', + 'type' => 'string', + 'enumValueTitles' => ['MIGRATE_MESSAGE' => '迁移消息'], + 'example' => 'MIGRATE_MESSAGE', + ], + 'operationStatus' => [ + 'title' => '操作状态,MigrationOperationStatusEnum[INIT(未开始),DOING(执行中),DONE(已完成),FAIL(已失败),code(编码),desc(描述)]', + 'description' => '操作状态', + 'type' => 'string', + 'enumValueTitles' => ['INIT' => '未开始', 'DONE' => '已完成', 'DOING' => '执行中', 'FAIL' => '已失败'], + 'example' => 'DOING', + ], + 'operationKey' => ['title' => '操作对象主键', 'description' => '操作对象主键'."\n" + ."\n\n" + .'> '."\n" + .'> - 在消息迁移阶段，操作对象为Topic名称', 'type' => 'string', 'example' => 'normal-topic-1'], + 'businessStatus' => [ + 'title' => '操作业务状态,ConnectNetworkBusinessStatusEnum[CONNECT_PENDING(等待打通),CONNECT_DOING(打通中),CONNECT_SUCCESS(打通成功),CONNECT_FAILURE(打通失败),code,desc]', + 'description' => '操作业务状态。', + 'type' => 'string', + 'enumValueTitles' => ['MIGRATE_WAIT' => '读写源集群', 'SWITCH_WRITE' => '写目标集群冗余读', 'MIGRATE_FINISH' => '读写目标集群', 'DOUBLE_READ' => '写源集群冗余读', 'ALREADY_MIGRATED' => '已迁移'], + 'example' => 'DOUBLE_READ', + ], + 'operationParam' => [ + 'title' => '操作参数', + 'description' => '操作参数', + 'type' => 'object', + 'properties' => [ + 'paramData' => ['title' => '参数信息', 'description' => '参数信息', 'type' => 'any', 'example' => '{'."\n" + .' "action": "MIGRATE_FORWARD",'."\n" + .' "targetStage": "MIGRATE_FINISH"'."\n" + .'}'], + ], + ], + 'operationResult' => [ + 'title' => '操作结果', + 'description' => '操作结果', + 'type' => 'object', + 'properties' => [ + 'resultData' => ['title' => '操作结果', 'description' => '操作结果', 'type' => 'any', 'example' => '{'."\n" + .' "checkStatus": "WAIT_CHECK",'."\n" + .' "sourceTopicStatus": "PERM_6",'."\n" + .' "targetTopicStatus": "PERM_4",'."\n" + .' "checkResult": {},'."\n" + .' "migrateStage": "DOUBLE_READ"'."\n" + .'}'], + ], + ], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2022-08-01 00:00:00'], + 'updateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + ], ], ], ], ], - 'code' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'message' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'xxx', - ], - 'httpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The topic already exists.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'consumerGroupId'], ], ], ], ], - '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' => '查询迁移操作列表', + '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' => '查询IP白名单详情', ], 'ListMigrations' => [ 'summary' => '查询迁移任务列表。', 'path' => '/migrations', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'methods' => ['get'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], @@ -9728,19 +6110,12 @@ ], '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' => '查询的过滤条件。', 'type' => 'string', 'required' => false, 'example' => 'xx'], ], [ 'name' => 'migrationType', @@ -9750,47 +6125,24 @@ .' - INSTANCE_MIGRATION(实例迁移)', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'INSTANCE_MIGRATION' => '实例迁移', - ], + 'enumValueTitles' => ['INSTANCE_MIGRATION' => '实例迁移'], 'example' => 'INSTANCE_MIGRATION', ], ], [ 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页页码，查询第几页的返回结果。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '分页页码，查询第几页的返回结果。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1'], ], [ 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，每页最多显示的返回结果数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '10000', - 'minimum' => '10', - 'example' => '10', - ], + 'schema' => ['description' => '分页大小，每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '10000', 'minimum' => '10', 'example' => '10'], ], [ 'name' => 'resourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm4goe2ckfiva', - ], + 'schema' => ['description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm4goe2ckfiva'], ], ], 'responses' => [ @@ -9800,44 +6152,16 @@ 'description' => 'Result<MyPage<MigrationDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'E5897B2E-C3AC-56DC-A482-F0E9E53F48D5', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'E5897B2E-C3AC-56DC-A482-F0E9E53F48D5'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', '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' => ['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'], 'list' => [ 'title' => '分页数据', 'description' => '分页数据', @@ -9846,26 +6170,10 @@ 'description' => '迁移任务列表。', 'type' => 'object', 'properties' => [ - 'migrationId' => [ - 'title' => '迁移ID', - 'description' => '迁移ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21', - ], - 'migrationName' => [ - 'title' => '迁移名称', - 'description' => '迁移名称', - 'type' => 'string', - 'example' => 'xxx', - ], - 'migrationType' => [ - 'title' => '迁移类型,MigrationTypeEnum[RESOURCE_IMPORT(资源导入),INSTANCE_MIGRATION(实例迁移),code(编码),desc(描述)]', - 'description' => '迁移类型：'."\n" - .' - INSTANCE_MIGRATION(实例迁移)', - 'type' => 'string', - 'example' => 'INSTANCE_MIGRATION', - ], + 'migrationId' => ['title' => '迁移ID', 'description' => '迁移ID', 'type' => 'integer', 'format' => 'int64', 'example' => '21'], + 'migrationName' => ['title' => '迁移名称', 'description' => '迁移名称', 'type' => 'string', 'example' => 'xxx'], + 'migrationType' => ['title' => '迁移类型,MigrationTypeEnum[RESOURCE_IMPORT(资源导入),INSTANCE_MIGRATION(实例迁移),code(编码),desc(描述)]', 'description' => '迁移类型：'."\n" + .' - INSTANCE_MIGRATION(实例迁移)', 'type' => 'string', 'example' => 'INSTANCE_MIGRATION'], 'migrationStatus' => [ 'title' => '迁移状态,MigrationStatusEnum[CREATED(已创建),MIGRATING(迁移中),COMPLETED(已完成),code(编码),desc(描述)]', 'description' => '迁移状态：'."\n" @@ -9874,20 +6182,10 @@ .' - COMPLETED(已完成)'."\n" .' - CANCELLED(已取消)', 'type' => 'string', - 'enumValueTitles' => [ - 'CANCELLED' => '已取消', - 'CREATED' => '已创建', - 'COMPLETED' => '已完成', - 'MIGRATING' => '迁移中', - ], + 'enumValueTitles' => ['CANCELLED' => '已取消', 'CREATED' => '已创建', 'COMPLETED' => '已完成', 'MIGRATING' => '迁移中'], 'example' => 'MIGRATING', ], - 'userId' => [ - 'title' => '用户ID', - 'description' => '用户ID', - 'type' => 'string', - 'example' => '111', - ], + 'userId' => ['title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '111'], 'currentStage' => [ 'title' => '当前阶段,MigrationStageTypeEnum[CONNECT_NETWORK(网络打通),MIGRATE_METADATA(迁移元数据),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(消息迁移),code(编码),desc(描述),type(类型)]', 'description' => '当前迁移阶段', @@ -9901,12 +6199,7 @@ .' - REPLACE_ENDPOINT(更换接入点)'."\n" .' - MIGRATE_MESSAGE(消息迁移)', 'type' => 'string', - 'enumValueTitles' => [ - 'REPLACE_ENDPOINT' => '更换接入点', - 'MIGRATE_METADATA' => '迁移元数据', - 'CONNECT_NETWOR' => '网络打通', - 'MIGRATE_MESSAGE' => '消息迁移', - ], + 'enumValueTitles' => ['REPLACE_ENDPOINT' => '更换接入点', 'MIGRATE_METADATA' => '迁移元数据', 'CONNECT_NETWOR' => '网络打通', 'MIGRATE_MESSAGE' => '消息迁移'], 'example' => 'MIGRATE_METADATA', ], 'stageStatus' => [ @@ -9916,19 +6209,10 @@ .' - DOING(执行中)'."\n" .' - DONE(已完成)', 'type' => 'string', - 'enumValueTitles' => [ - 'INIT' => '未开始', - 'DONE' => '已完成', - 'DOING' => '执行中', - ], + 'enumValueTitles' => ['INIT' => '未开始', 'DONE' => '已完成', 'DOING' => '执行中'], 'example' => 'DOING', ], - 'stageData' => [ - 'title' => '阶段数据', - 'description' => '阶段数据', - 'type' => 'any', - 'example' => '[]', - ], + 'stageData' => ['title' => '阶段数据', 'description' => '阶段数据', 'type' => 'any', 'example' => '[]'], ], ], 'migrationSource' => [ @@ -9942,24 +6226,16 @@ .' - EXTERNAL_INSTANCE(外部实例)'."\n" .' - INTERNAL_INSTANCE(阿里云5.0实例)', 'type' => 'string', - 'enumValueTitles' => [ - 'EXTERNAL_INSTANCE' => '外部实例', - 'INTERNAL_INSTANCE' => '阿里云5.0实例', - ], + 'enumValueTitles' => ['EXTERNAL_INSTANCE' => '外部实例', 'INTERNAL_INSTANCE' => '阿里云5.0实例'], 'example' => 'EXTERNAL_INSTANCE', ], - 'sourceData' => [ - 'title' => '迁移来源数据', - 'description' => '迁移来源数据', - 'type' => 'any', - 'example' => '{'."\n" - .'"clusterType":"INTERNET_NETWORK",'."\n" - .'"aclType":"NONE",'."\n" - .'"clusterName":"test",'."\n" - .'"namesrvAddrList":"47.110.248.xxx:9876"],'."\n" - .'"brokerObtainMethod":"AUTO_OBTAIN"'."\n" - .'}', - ], + 'sourceData' => ['title' => '迁移来源数据', 'description' => '迁移来源数据', 'type' => 'any', 'example' => '{'."\n" + .'"clusterType":"INTERNET_NETWORK",'."\n" + .'"aclType":"NONE",'."\n" + .'"clusterName":"test",'."\n" + .'"namesrvAddrList":"47.110.248.xxx:9876"],'."\n" + .'"brokerObtainMethod":"AUTO_OBTAIN"'."\n" + .'}'], ], ], 'migrationTarget' => [ @@ -9972,88 +6248,45 @@ 'description' => '迁移来源类型：'."\n" .' - INTERNAL_INSTANCE(阿里云5.0实例)', 'type' => 'string', - 'enumValueTitles' => [ - 'INTERNAL_INSTANCE' => '阿里云5.0实例', - ], + 'enumValueTitles' => ['INTERNAL_INSTANCE' => '阿里云5.0实例'], 'example' => 'INTERNAL_INSTANCE', ], - 'targetData' => [ - 'title' => '迁移目标数据', - 'description' => '迁移目标数据', - 'type' => 'any', - 'example' => '{'."\n" - .'"clusterType":"ROCKETMQ_V5",'."\n" - .'"instanceId":"rmq-cn-778429mp301",'."\n" - .'"regionId":"cn-hangzhou"'."\n" - .'}', - ], + 'targetData' => ['title' => '迁移目标数据', 'description' => '迁移目标数据', 'type' => 'any', 'example' => '{'."\n" + .'"clusterType":"ROCKETMQ_V5",'."\n" + .'"instanceId":"rmq-cn-778429mp301",'."\n" + .'"regionId":"cn-hangzhou"'."\n" + .'}'], ], ], - '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' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2022-08-01 00:00:00'], + 'updateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], ], ], ], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], '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' => '查询迁移任务列表', - ], - 'ListMigrationOperations' => [ - 'summary' => '查询迁移操作列表。', - 'path' => '/migrations/{migrationId}/stages/{stageType}/operations', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListRegions' => [ + 'summary' => '查询地域列表。', + 'path' => '/regions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10061,732 +6294,577 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'migrationId', - 'in' => 'path', + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '迁移ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '135', + 'title' => 'Result<List<RegionDTO>>', + 'description' => 'Result<List<RegionDTO>>', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '0B962390-D84B-5D44-8C11-79DF40299D41'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => [ + 'title' => '返回结果', + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => '区域列表。', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['title' => 'regionId,类似 cn-hangzhou', 'description' => 'regionId,类似 cn-hangzhou', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'regionName' => ['title' => '中文region，类似杭州', 'description' => '中文region，类似杭州', 'type' => 'string', 'example' => '杭州'], + 'supportRocketmqV5' => ['title' => '是否开通新服 v5版本', 'description' => '是否开通新服 v5版本', 'type' => 'boolean', 'example' => 'true'], + 'supportRocketmqV4' => ['title' => '是否开通旧服 v4版本', 'description' => '是否开通旧服 v4版本', 'type' => 'boolean', 'example' => 'true'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'updateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'tags' => [ + 'description' => '地域标签。', + 'type' => 'array', + 'items' => [ + 'description' => '地域标签。', + 'type' => 'object', + 'properties' => [ + 'tagCode' => ['description' => '标签Code。', 'type' => 'string', 'example' => 'xx'], + 'tagValue' => ['description' => '标签的值。', 'type' => 'any', 'example' => 'xx'], + ], + ], + ], + ], + ], + ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingPageNumber'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'ConsumerGroupId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', '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\\": \\"杭州\\",\\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' => '查询地域列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'], + ], + ], + 'ramActions' => [], + ], + 'ListTagResources' => [ + 'summary' => '查询可见的资源标签关系。', + 'path' => '/resourceTag/list', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'stageType', - 'in' => 'path', - 'schema' => [ - 'description' => '迁移阶段类型。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'MIGRATE_MESSAGE' => '消息迁移', - ], - 'example' => 'MIGRATE_MESSAGE', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ [ - 'name' => 'operationType', + 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'description' => '操作类型。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'MIGRATE_MESSAGE' => '迁移消息', - ], - 'example' => 'MIGRATE_MESSAGE', - ], + 'schema' => ['title' => '地域ID。', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'filter', + 'name' => 'resourceType', 'in' => 'query', - 'schema' => [ - 'description' => '查询的过滤条件。'."\n" - ."\n" - .'>'."\n" - .'> - 支持基于operationKey，即Topic名称进行过滤', - 'type' => 'string', - 'required' => false, - 'example' => 'xx', - ], + 'schema' => ['title' => '资源类型。', 'description' => '资源类型。', 'type' => 'string', 'required' => true, 'example' => 'instance'], ], [ - 'name' => 'instanceId', + 'name' => 'resourceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-zxu37eiqq0x', - ], + 'schema' => ['title' => '资源ID列表，JSON格式。', 'description' => '资源ID列表，JSON格式。', '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' => '标签列表，JSON格式。', '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' => '下一个查询开始的位置。', 'type' => 'string', 'required' => false, 'example' => 'd09e2b63e1b12d905b7080ff70'], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmx7caj******'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<MyPage<MigrationOperationDTO>>', - 'description' => 'Result<MyPage<MigrationOperationDTO>>', + 'title' => 'Result<InnerListTagResourcesResponse>', + 'description' => 'Result<InnerListTagResourcesResponse>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5F88833', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'F00C6A70-C782-5DD6-9D11-0CFC710100C7'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', 'description' => '返回结果', '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' => '下一个查询开始的位置。', 'type' => 'string', 'example' => 'd09e2b63e1b12d905b7080ff70'], + 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F00C6A70-C782-5DD6-9D11-0CFC710100C7'], + 'tagResources' => [ + 'description' => '资源标签关系。', 'type' => 'array', 'items' => [ - 'description' => '迁移操作列表。', + 'description' => '资源标签关系。', 'type' => 'object', 'properties' => [ - 'operationId' => [ - 'title' => '迁移操作ID', - 'description' => '迁移操作ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '183', - ], - 'migrationId' => [ - 'title' => '迁移ID', - 'description' => '迁移ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'stageType' => [ - 'title' => '迁移阶段类型', - 'description' => '迁移阶段类型', - 'type' => 'string', - 'enumValueTitles' => [ - 'MIGRATE_MESSAGE' => '消息迁移', - ], - 'example' => 'MIGRATE_MESSAGE', - ], - 'operationType' => [ - 'title' => '操作类型,MigrationOperationTypeEnum[IMPORT_TOPIC(导入主题),IMPORT_CONSUMER_GROUP(导入消费者组),CONNECT_NETWORK(网络打通),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(迁移消息),code(编码),desc(描述),param(参数类型),result(结果类型)]', - 'description' => '操作类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'MIGRATE_MESSAGE' => '迁移消息', - ], - 'example' => 'MIGRATE_MESSAGE', - ], - 'operationStatus' => [ - 'title' => '操作状态,MigrationOperationStatusEnum[INIT(未开始),DOING(执行中),DONE(已完成),FAIL(已失败),code(编码),desc(描述)]', - 'description' => '操作状态：'."\n" - .' - INIT(未开始)'."\n" - .' - DOING(执行中)'."\n" - .' - DONE(已完成) '."\n" - .' - FAIL(已失败)', - 'type' => 'string', - 'enumValueTitles' => [ - 'INIT' => '未开始', - 'DONE' => '已完成', - 'DOING' => '执行中', - 'FAIL' => '已失败', - ], - 'example' => 'DOING', - ], - 'operationKey' => [ - 'title' => '操作对象主键', - 'description' => '操作对象主键'."\n" - ."\n\n" - .'> '."\n" - .'> - 在消息迁移阶段，操作对象为Topic名称', - 'type' => 'string', - 'example' => 'normal-topic-1', - ], - 'businessStatus' => [ - 'title' => '操作业务状态,ConnectNetworkBusinessStatusEnum[CONNECT_PENDING(等待打通),CONNECT_DOING(打通中),CONNECT_SUCCESS(打通成功),CONNECT_FAILURE(打通失败),code,desc]', - 'description' => '操作业务状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'MIGRATE_WAIT' => '读写源集群', - 'SWITCH_WRITE' => '写目标集群冗余读', - 'MIGRATE_FINISH' => '读写目标集群', - 'DOUBLE_READ' => '写源集群冗余读', - 'ALREADY_MIGRATED' => '已迁移', - ], - 'example' => 'DOUBLE_READ', - ], - 'operationParam' => [ - 'title' => '操作参数', - 'description' => '操作参数', - 'type' => 'object', - 'properties' => [ - 'paramData' => [ - 'title' => '参数信息', - 'description' => '参数信息', - 'type' => 'any', - 'example' => '{'."\n" - .' "action": "MIGRATE_FORWARD",'."\n" - .' "targetStage": "MIGRATE_FINISH"'."\n" - .'}', - ], - ], - ], - 'operationResult' => [ - 'title' => '操作结果', - 'description' => '操作结果', - 'type' => 'object', - 'properties' => [ - 'resultData' => [ - 'title' => '操作结果', - 'description' => '操作结果', - 'type' => 'any', - 'example' => '{'."\n" - .' "checkStatus": "WAIT_CHECK",'."\n" - .' "sourceTopicStatus": "PERM_6",'."\n" - .' "targetTopicStatus": "PERM_4",'."\n" - .' "checkResult": {},'."\n" - .' "migrateStage": "DOUBLE_READ"'."\n" - .'}', - ], - ], - ], - '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' => '资源类型。', 'type' => 'string', 'example' => 'instance'], + 'tagValue' => ['description' => '标签的值。', 'type' => 'string', 'example' => 'value'], + 'resourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'rmq-cn-pe334n08h08'], + 'tagKey' => ['description' => '标签的键。', 'type' => 'string', 'example' => 'key'], + 'category' => ['description' => '标签类型。', 'type' => 'string', 'example' => 'custom'], + 'scope' => ['description' => '可见范围。', 'type' => 'string', 'example' => 'public'], + 'aliUid' => ['description' => '资源归属uid。', 'type' => 'integer', 'format' => 'int64', 'example' => '1876441048322426'], ], ], ], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The topic already exists.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'consumerGroupId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The topic already exists.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', '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' => '查询资源标签关系', + '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' => '全部资源', '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' => '查询迁移操作列表', ], - 'ExecuteMigrationOperation' => [ - 'summary' => '指定的迁移任务执行指定的操作。', - 'path' => '/migrations/{migrationId}/stages/{stageType}/operations/{operationId}/execute', - 'methods' => [ - 'post', + 'ListTopicSubscriptions' => [ + 'summary' => '查询主题订阅关系列表。', + '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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-zpr34udri0w'], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => ['description' => '主题名称。', 'type' => 'string', 'required' => true, 'example' => 'dev4-HMH_INSURANCE_NOMAL_TOPIC'], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<SubscriptionDTO>>', + 'description' => 'Result<List<SubscriptionDTO>>', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '92A9BE4E-B794-50C8-979C-0456E4D32943'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => [ + 'title' => '返回结果', + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => '主题订阅列表。', + 'type' => 'object', + 'properties' => [ + 'consumerGroupId' => ['title' => '消费者组', 'description' => '消费者组', 'type' => 'string', 'example' => 'CID-TEST'], + 'topicName' => ['title' => '订阅主题', 'description' => '订阅主题', 'type' => 'string', 'example' => 'topic_test'], + 'messageModel' => ['title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', 'description' => '消费者分组的消费模式。'."\n" + .'- BROADCASTING：广播模式'."\n" + .'- CLUSTERING：集群模式', 'type' => 'string', 'example' => 'BROADCASTING'], + 'subscriptionStatus' => ['title' => '订阅状态,SubscriptionStatusEnum[ONLINE(在线),OFFLINE(离线),code,desc]', 'description' => '订阅状态。'."\n" + .'- ONLINE：在线。消费者分组下如果有多个消费者，只要有一个消费者在线则显订阅状态为在线。'."\n" + .'- OFFLINE：离线。消费者分组下如果有多个消费者，所有消费者都处于离线时订阅状态才显示离线。', 'type' => 'string', 'example' => 'ONLINE'], + 'filterExpression' => ['title' => '过滤表达式', 'description' => '过滤表达式', 'type' => 'string', 'example' => '*'], + 'filterExpressionType' => ['title' => '过滤表达式类型,SubscriptionExpressionTypeEnum[SQL(SQL过滤),TAG(TAG过滤),UNSPECIFIED(FILTER_TYPE_UNSPECIFIED 过滤类型未指定),code,desc]', 'description' => '过滤表达式类型。'."\n" + .'- SQL：SQL过滤'."\n" + .'- TAG：Tag过滤。', 'type' => 'string', 'example' => 'SQL'], + 'consistency' => ['description' => '订阅关系的一致性。'."\n" + .'- 订阅关系不一致为false。'."\n" + .'- 订阅关系一致为true。', 'type' => 'string', 'example' => 'true'], + ], + ], + ], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'Topic'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', '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' => '查询主题订阅关系列表', + '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' => '查询指定实例下的主题列表信息。', + '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' => [ - 'description' => '迁移ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '44', - ], + 'schema' => ['title' => '实例ID', 'description' => '指定需要获取哪个实例下的主题列表。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'instanceId', + 'name' => 'filter', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-x0r37kel***', - ], + 'schema' => ['title' => '过滤条件', 'description' => '查询的过滤条件，若不输入则查询该实例下所有的主题。', 'type' => 'string', 'required' => false, 'example' => 'topic_test'], ], [ - 'name' => 'stageType', - 'in' => 'path', - 'schema' => [ - 'description' => '迁移阶段类型，消息迁移(MIGRATE_MESSAGE)', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'MIGRATE_MESSAGE' => '消息迁移', - ], - 'example' => 'MIGRATE_MESSAGE', - ], + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['title' => '分页页码', 'description' => '分页页码，查询第几页的返回结果。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'operationId', - 'in' => 'path', - 'schema' => [ - 'description' => '迁移操作ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2729', - ], + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['title' => '分页大小', 'description' => '分页大小，每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '3'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'messageTypes', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '请求体结构。', - 'type' => 'object', - 'properties' => [ - 'operationParam' => [ - 'title' => '操作参数', - 'description' => '操作参数', - 'type' => 'object', - 'properties' => [ - 'paramData' => [ - 'title' => '参数信息', - 'description' => '参数信息，参数类型为json字符串，参考示例。'."\n" - ."\n" - .'action（操作）字段枚举值如下：'."\n" - .'- MIGRATE_FORWARD(迁移前进)'."\n" - .'- MIGRATE_BACKWARD(迁移回退)'."\n" - ."\n" - .'targetStage（目标阶段）字段枚举值如下：'."\n" - .' - MIGRATE_WAIT(读写源集群)'."\n" - .' - DOUBLE_READ(写源集群冗余读)'."\n" - .' - SWITCH_WRITE(写目标集群冗余读)'."\n" - .' - MIGRATE_FINISH(读写目标集群)'."\n" - ."\n\n" - .'> '."\n" - .'> - 关于迁移前进，只能按照顺序逐个阶段向前推进。'."\n" - .'> - 关于迁移回滚，可以回滚至之前的任何一个阶段。', - 'type' => 'any', - 'required' => false, - 'example' => '迁移前进：{"action":"MIGRATE_FORWARD","targetStage":"MIGRATE_FINISH"}'."\n" - ."\n" - .'迁移后退：{"action":"MIGRATE_BACKWARD","targetStage":"MIGRATE_WAIT"}', - ], - ], - 'required' => false, - ], + 'description' => '主题的消息类型。', + 'type' => 'array', + 'items' => [ + 'description' => '需要查询实例下哪种类型的主题。若不输入，则查询实例下的所有主题。'."\n" + .'参数取值如下：'."\n" + .'- TRANSACTION：事务消息'."\n" + .'- FIFO：顺序消息'."\n" + .'- DELAY：定时/延时消息'."\n" + .'- NORMAL：普通消息'."\n" + .'- LITE: 轻量类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['TRANSACTION' => '事务消息', 'FIFO' => '顺序消息', 'DELAY' => '定时/延时消息', 'LITE' => '轻量类型', 'NORMAL' => '普通消息'], + 'example' => 'NORMAL', ], 'required' => false, + 'enumValueTitles' => [], ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<MigrationOperationDTO>', - 'description' => 'Result<MigrationOperationDTO>', + 'title' => 'Result<MyPage<TopicDTO>>', + 'description' => 'Result<MyPage<TopicDTO>>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '814BCD66-2D76-5080-AAD2-E50E5BDB0995', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], 'data' => [ 'title' => '返回结果', - 'description' => '返回结果', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'operationId' => [ - 'title' => '迁移操作ID', - 'description' => '迁移操作ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '110', - ], - 'migrationId' => [ - 'title' => '迁移ID', - 'description' => '迁移ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'stageType' => [ - 'title' => '迁移阶段类型', - 'description' => '迁移阶段类型', - 'type' => 'string', - 'enumValueTitles' => [ - 'MIGRATE_MESSAGE' => '迁移消息', - ], - 'example' => 'MIGRATE_MESSAGE', - ], - 'operationType' => [ - 'title' => '操作类型,MigrationOperationTypeEnum[IMPORT_TOPIC(导入主题),IMPORT_CONSUMER_GROUP(导入消费者组),CONNECT_NETWORK(网络打通),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(迁移消息),code(编码),desc(描述),param(参数类型),result(结果类型)]', - 'description' => '操作类型：MIGRATE_MESSAGE（迁移消息）', - 'type' => 'string', - 'example' => 'MIGRATE_MESSAGE', - ], - 'operationStatus' => [ - 'title' => '操作状态,MigrationOperationStatusEnum[INIT(未开始),DOING(执行中),DONE(已完成),FAIL(已失败),code(编码),desc(描述)]', - 'description' => '操作状态：'."\n" - .' - INIT(未开始)'."\n" - .' - DOING(执行中)'."\n" - .' - DONE(已完成)'."\n" - .' - FAIL(已失败)', - 'type' => 'string', - 'enumValueTitles' => [ - 'INIT' => '未开始', - 'DONE' => '已完成', - 'DOING' => '执行中', - 'FAIL' => '已失败', - ], - 'example' => 'DOING', - ], - 'operationKey' => [ - 'title' => '操作对象主键', - 'description' => '操作对象主键', - 'type' => 'string', - 'example' => 'normal-topic-1', - ], - 'businessStatus' => [ - 'title' => '操作业务状态,ConnectNetworkBusinessStatusEnum[CONNECT_PENDING(等待打通),CONNECT_DOING(打通中),CONNECT_SUCCESS(打通成功),CONNECT_FAILURE(打通失败),code,desc]', - 'description' => '操作业务状态：'."\n" - .' - MIGRATE_WAIT(读写源集群)'."\n" - .' - DOUBLE_READ(写源集群冗余读)'."\n" - .' - SWITCH_WRITE(写目标集群冗余读)'."\n" - .' - MIGRATE_FINISH(读写目标集群)'."\n" - .' - ALREADY_MIGRATED(已迁移)', - 'type' => 'string', - 'enumValueTitles' => [ - 'MIGRATE_CHECK' => '读写源集群', - 'SWITCH_WRITE' => '写目标集群冗余读', - 'MIGRATE_FINISH' => '读写目标集群', - 'DOUBLE_READ' => '写源集群冗余读', - 'ALREADY_MIGRATED' => '已迁移', - ], - 'example' => 'MIGRATE_WAIT', - ], - 'operationParam' => [ - 'title' => '操作参数', - 'description' => '操作参数', - 'type' => 'object', - 'properties' => [ - 'paramData' => [ - 'title' => '参数信息', - 'description' => '参数信息', - 'type' => 'any', - 'example' => '{"action":"MIGRATE_FORWARD","targetStage":"MIGRATE_FINISH"}', - ], - ], - ], - 'operationResult' => [ - 'title' => '操作结果', - 'description' => '操作结果', - 'type' => 'object', - 'properties' => [ - 'resultData' => [ - 'title' => '操作结果', - 'description' => '操作结果', - 'type' => 'any', - 'example' => '{'."\n" - .' "checkStatus": "WAIT_CHECK",'."\n" - .' "sourceTopicStatus": "PERM_6",'."\n" - .' "targetTopicStatus": "PERM_4",'."\n" - .' "checkResult": {},'."\n" - .' "migrateStage": "DOUBLE_READ"'."\n" - .'}', + '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'], + 'list' => [ + 'title' => '分页数据', + 'description' => '分页数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'regionId' => ['title' => '区域ID', 'description' => '实例所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'topicName' => ['title' => 'Topic编码', 'description' => '主题名称。', 'type' => 'string', 'example' => 'topic_test'], + 'messageType' => [ + 'title' => '消息类型,MessageTypeEnum[UNSPECIFIED,NORMAL(普通),FIFO(顺序),DELAY(延迟),TRANSACTION(事务),UNRECOGNIZED(无法识别),code,desc]', + 'description' => '主题的消息类型。', + 'type' => 'string', + 'enumValueTitles' => ['TRANSACTION' => '事务消息', 'FIFO' => '顺序消息', 'DELAY' => '定时/延时消息', 'NORMAL' => '普通消息'], + 'example' => 'NORMAL', + 'enum' => ['NORMAL', 'FIFO', 'DELAY', 'TRANSACTION'], + ], + 'status' => [ + 'title' => 'Topic状态,TopicStatusEnum[CREATING(创建中),RUNNING(运行中),code,desc]', + 'description' => '主题的状态。', + 'type' => 'string', + 'enumValueTitles' => ['RUNNING' => '运行中', 'CREATING' => '创建中'], + 'example' => 'RUNNING', + 'enum' => ['CREATING', 'RUNNING'], + ], + 'remark' => ['title' => '备注', 'description' => '主题的备注信息。', 'type' => 'string', 'example' => 'This is the remark for test.'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'updateTime' => ['title' => '修改时间', 'description' => '主题的最后修改时间。', 'type' => 'string', 'example' => '2022-08-01 20:05:50'], + 'maxSendTps' => ['description' => '发送消息tps上限', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'liteTopicExpiration' => ['title' => 'liteTopic过期时间，单位：分钟', 'description' => 'lite类型Topic过期时间，单位：分钟', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], ], ], ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '修改时间', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], ], ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The topic already exists.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'The topic cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'TopicName'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'topicName'], ], ], ], ], - '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' => '执行迁移操作', - ], - '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' => '查询主题列表', + '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' => '查询指定主题下的轨迹消息列表。', + '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' => [ - 'description' => '迁移ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-tl32upjeb08'], ], [ - 'name' => 'instanceId', + 'name' => 'topicName', + 'in' => 'path', + 'schema' => ['description' => '主题名称。', 'type' => 'string', 'required' => true, 'example' => 'topic_hpms_product_price_change'], + ], + [ + 'name' => 'startTime', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-pe334f1nx04', - ], + 'schema' => ['description' => '开始时间。', 'type' => 'string', 'required' => true, 'example' => '2023-05-10 10:42:11'], ], [ - 'name' => 'stageType', - 'in' => 'path', + 'name' => 'endTime', + 'in' => 'query', + 'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => true, 'example' => '2023-05-19 10:10:09'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页页码，查询第几页的返回结果。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100000000', 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，每页做多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '10'], + ], + [ + 'name' => 'queryType', + 'in' => 'query', 'schema' => [ - 'description' => '迁移阶段类型，消息迁移(MIGRATE_MESSAGE)', + 'description' => '查询类型。', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'MIGRATE_MESSAGE' => '消息迁移', - ], - 'example' => 'MIGRATE_MESSAGE', + 'enumValueTitles' => ['MESSAGE_ID' => 'MESSAGE_ID', 'MESSAGE_KEY' => 'MESSAGE_KEY', 'TOPIC' => 'TOPIC'], + 'example' => 'MESSAGE_ID', ], ], + [ + 'name' => 'messageId', + 'in' => 'query', + 'schema' => ['description' => '消息ID。'."\n" + ."\n" + .'queryType选择MESSAGE_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '0100163E0EC1F1965C04C7906700000000'], + ], + [ + 'name' => 'messageKey', + 'in' => 'query', + 'schema' => ['description' => '消息key。'."\n" + ."\n" + .'queryType选择MESSAGE_KEY时必填。', 'type' => 'string', 'required' => false, 'example' => 'order_ceating'], + ], + [ + 'name' => 'liteTopicName', + 'in' => 'query', + 'schema' => ['title' => '轻量主题名称', 'description' => '轻量主题名称', 'type' => 'string', 'required' => false, 'example' => 'abc'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - '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' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], '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' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'pageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'pageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'totalCount' => ['description' => '返回结果的总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'list' => [ + 'description' => '分页数据。', + 'type' => 'array', + 'items' => [ + 'description' => '分页数据。', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'instanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rmq-cn-7e22ody****'], + 'topicName' => ['description' => '主题名称。', 'type' => 'string', 'example' => 'topic_test'], + 'messageId' => ['description' => '消息ID。', 'type' => 'string', 'example' => '7F00000100207A4F0F294A938F7807AE'], + 'bornTime' => ['description' => '生成时间。', 'type' => 'string', 'example' => '2023-03-22 12:17:08'], + 'messageTag' => ['description' => '标签列表。', 'type' => 'string', 'example' => 'xx'], + 'messageKeys' => [ + 'description' => '业务标识。', + 'type' => 'array', + 'items' => ['description' => '业务标识。', 'type' => 'string', 'example' => 'xx'], + ], + ], + ], + ], + ], ], + 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['description' => '动态错误码。', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['description' => '动态错误信息。', 'type' => 'string', 'example' => 'InstanceId'], ], ], ], ], - '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' => '完成当前迁移阶段', - ], - 'CreateDisasterRecoveryPlan' => [ - 'summary' => '创建备份计划。', - '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' => '查询轨迹消息列表', + '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' => [ + 'summary' => '重置指定消费者分组的消费位点。重置消费位点是指改变订阅者当前的消费位置。当消费者出现故障或者消费错误数据时，您可通过重置消费位点将消费位置回滚到之前的某个位点重新开始消费，您也可以将消费位置移动至最新位点，暂时不处理堆积的消息。', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeOffsets/{topicName}', + 'methods' => ['patch'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], @@ -10794,223 +6872,54 @@ ], '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' => '云消息队列 RocketMQ 版的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-tl32ue44x0g'], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => ['description' => '消费者分组ID。', 'type' => 'string', 'required' => true, 'example' => 'dolphin_status'], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => ['description' => '消费者分组订阅的主题名称。', 'type' => 'string', 'required' => true, 'example' => 'AMZN_REPORT_TOPIC'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体结构。', + 'description' => '请求体对象。', 'type' => 'object', 'properties' => [ - 'planName' => [ - 'title' => '计划名称', - 'description' => '计划名称，必填', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], - 'planDesc' => [ - 'title' => '计划描述', - 'description' => '计划描述', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], - 'planType' => [ - 'title' => '计划类型', - 'description' => '备份计划类型，必填。请参见[Global Replicator](~~2843187~~)。'."\n" - .'参数取值如下：'."\n" - .' - ACTIVE_PASSIVE：单向备份'."\n" - .' - ACTIVE_ACTIVE：双向备份', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ACTIVE_ACTIVE' => '双向备份', - 'ACTIVE_PASSIVE' => '单向备份', - ], - 'example' => 'ACTIVE_ACTIVE', - ], - 'instances' => [ - 'title' => '容灾计划参与实例', - 'description' => '备份计划参与实例。必填', - 'type' => 'array', - 'items' => [ - 'description' => '备份计划参与实例', - 'type' => 'object', - 'properties' => [ - 'instanceType' => [ - 'title' => '实例类型', - 'description' => '实例类型'."\n" - .' - ALIYUN_ROCKETMQ ：阿里云实例'."\n" - .' - EXTERNAL_ROCKETMQ ：外部实例，开源实例，开源集群', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ALIYUN_ROCKETMQ' => '阿里云mq实例', - 'EXTERNAL_ROCKETMQ' => '外部实例', - ], - 'example' => 'ALIYUN_ROCKETMQ', - ], - 'regionId' => [ - 'title' => '实例所在区域', - 'description' => '实例所在区域', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID，instanceType实例类型为EXTERNAL_ROCKETMQ无须填写，ALIYUN_ROCKETMQ必填', - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-******', - ], - 'instanceRole' => [ - 'title' => '实例角色', - 'description' => '实例角色，主或者备'."\n" - .' - ACTIVE：主'."\n" - .' - PASSIVE：备', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PASSIVE' => '备', - 'ACTIVE' => '主', - ], - 'example' => 'PASSIVE', - ], - 'authType' => [ - 'title' => '认证方式', - 'description' => '认证方式。instanceType实例类型为ALIYUN_ROCKETMQ，实例版本为4.0无须填写'."\n" - .' - NO_AUTH：无需认证'."\n" - .' - ACL_AUTH：acl认证', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'NO_AUTH' => '无须认证', - 'ACL_AUTH' => 'acl认证', - ], - 'example' => 'ACL_AUTH', - ], - 'username' => [ - 'title' => '认证用户名', - 'description' => '认证用户名，authType为ACL_AUTH时必填', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], - 'password' => [ - 'title' => '认证密码', - 'description' => '认证密码，authType为ACL_AUTH时必填。instanceType实例类型为ALIYUN_ROCKETMQ无须填写', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], - 'endpointUrl' => [ - 'title' => '接入点地址', - 'description' => '接入点地址，instanceType实例类型为ALIYUN_ROCKETMQ无须填写，EXTERNAL_ROCKETMQ需要填写', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], - 'networkType' => [ - 'title' => '网络类型', - 'description' => '网络类型，instanceType实例类型为ALIYUN_ROCKETMQ无须填写，EXTERNAL_ROCKETMQ需要填写'."\n" - .'参数取值如下：'."\n" - .' - TCP_INTERNET：tcp公网'."\n" - .' - TCP_VPC：tcp专有网络', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TCP_VPC' => 'tcp专有网络', - 'TCP_INTERNET' => 'tcp公网', - ], - 'example' => 'TCP_INTERNET', - ], - 'vpcId' => [ - 'title' => 'VPC ID', - 'description' => '创建实例所关联的专有网络的ID，instanceType实例类型仅为EXTERNAL_ROCKETMQ，networkType为TCP_VPC时需要填写', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-wz9qt50xhtj9krb******'."\n", - ], - 'vSwitchId' => [ - 'title' => '交换机ID', - 'description' => '实例所关联的交换机ID，instanceType实例类型仅为EXTERNAL_ROCKETMQ，networkType为TCP_VPC时需要填写', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-uf6gwtbn6etadpv******'."\n", - ], - 'messageProperty' => [ - 'description' => '消息过滤属性，消息同步到目标集群时，会自动添加上该属性，用于消息消费时进行SQL过滤。', - 'type' => 'object', - 'properties' => [ - 'propertyKey' => [ - 'description' => '属性key', - 'type' => 'string', - 'required' => false, - 'example' => 'aaa', - ], - 'propertyValue' => [ - 'description' => '属性value', - 'type' => 'string', - 'required' => false, - 'example' => 'bbb', - ], - ], - 'required' => false, - ], - 'securityGroupId' => [ - 'description' => '安全组id，instanceType实例类型仅为EXTERNAL_ROCKETMQ，networkType为TCP_VPC时需要填写', - 'type' => 'string', - 'required' => false, - 'example' => 'sg-bp17hpmgz9******', - ], - 'consumerGroupId' => [ - 'description' => '消费者组ID，用于从源实例拉取消息。'."\n" - .'<notice>自建实例必须填写，阿里云实例会自动生成。</notice>', - 'type' => 'string', - 'required' => false, - 'example' => 'GID_DS_XXX_YYY', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'autoSyncCheckpoint' => [ - 'title' => '自动消费进度同步开关', - 'description' => '是否开启消费进度自动同步。'."\n" + 'resetType' => [ + 'title' => '重置方式,ConsumeOffsetResetTypeEnum[LATEST_OFFSET(最新位点),SPECIFIED_TIME(指定时间),code,desc]', + 'description' => '重置方式。'."\n" + .'- LATEST_OFFSET：从最新位点开始消费。'."\n" ."\n" - .'> 只有在开启消费进度同步时有效。即 `syncCheckpointEnabled`字段值为true。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '开启', - 'false' => '关闭', - ], - 'example' => 'true', - ], - 'syncCheckpointEnabled' => [ - 'description' => '同步消费进度开关', - 'type' => 'boolean', + .' Group ID消费指定Topic中的消息时，会跳过当前堆积（未被消费）的所有消息，从重置操作时间后发送的最新消息开始消费。'."\n" + .'- SPECIFIED_TIME：从指定时间的位点开始消费。'."\n" + .' '."\n" + .' - 消费者将从重置时间对应的消费位点之后的消息进行消费，不管这些消息是否已被消费过。'."\n" + ."\n" + .' - 可选时间范围中的起始和终止时间分别是该Topic中储存的最早的和最晚的一条消息的生产时间，不能选择超过可选时间范围的时间点。'."\n" + ."\n" + .' - 重置到某一时刻对应的消费位点，匹配位点时，服务端会根据自动匹配到该时刻最接近的消费位点。', + 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'true' => '开启', - 'false' => '关闭', - ], - 'example' => 'true', + 'enumValueTitles' => ['SPECIFIED_TIME' => '从指定时间的位点开始消费', 'LATEST_OFFSET' => '从最新位点开始消费'], + 'example' => 'LATEST_OFFSET', ], + 'resetTime' => ['title' => '重置时间', 'description' => '指定重置时间。表示消费者将从该时间点对应的消费位点重新开始消费消息。'."\n" + ."\n" + .'仅当resetType（重置方式）选择SPECIFIED_TIME（指定时间）时需要填写该参数。'."\n" + ."\n" + .'格式为YYYY-MM-DD HH:mm:ss，例如：2023-11-23 10:00:00。', 'type' => 'string', 'required' => false, 'example' => '2023-03-22 12:17:08'], ], 'required' => false, ], @@ -11019,105 +6928,133 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Long>', - 'description' => 'Result<Long>', + 'title' => 'Result<Void>', + 'description' => 'Result<Void>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5xxxx', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果，备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'xxx', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'F9A95891-EAD4-5A2B-8A30-676CD18921AF'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', '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' => '创建备份计划', - ], - 'DeleteDisasterRecoveryPlan' => [ - 'summary' => '删除备份计划。', - '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' => '重置消费位点', + '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' => [ + 'summary' => '启用备份映射任务。', + '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' => '备份计划id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016'], + ], + [ + 'name' => 'itemId', + 'in' => 'path', + 'schema' => ['description' => '映射任务id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100000704'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C7E8AE3A-219B-52EE-BE32-4036Fxxxxx'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DisasterRecoveryItemStatus.Error'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The current status of the disaster recovery item does not support this operation.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'InstanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '启用备份映射任务', + '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' => [ + 'summary' => '停用备份映射任务。', + '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' => '备份计划id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016'], + ], + [ + 'name' => 'itemId', + 'in' => 'path', + 'schema' => ['description' => '映射任务id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100070284'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -11125,78 +7062,46 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'."\n", - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'DisasterRecoveryPlanStatus.Error', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The current status of the disaster recovery plan does not support this operation.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'A07B41BD-6DD3-5349-9E76-00303xxxx'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DisasterRecoveryItemStatus.Error'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The current status of the disaster recovery item does not support this operation.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '删除备份计划', - ], - 'UpdateDisasterRecoveryPlan' => [ - 'summary' => '修改备份计划。', - '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' => '停用备份映射任务', + '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' => [ + 'summary' => '同步消费进度信息到目标实例。', + 'path' => '/disaster_recovery/{planId}/items/{itemId}/checkpoints/{checkpointId}', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -11206,234 +7111,102 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225048', - 'abilityTreeNodes' => [ - 'FEATUREonsU22PJL', - ], + 'abilityTreeCode' => '251695', + 'abilityTreeNodes' => ['FEATUREonsOVRH1R'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', - 'schema' => [ - 'description' => '备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['description' => '备份计划ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13000000xx'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'itemId', + 'in' => 'path', + 'schema' => ['description' => '映射ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13000000xx'], + ], + [ + 'name' => 'checkpointId', + 'in' => 'path', + 'schema' => ['description' => '消费进度ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13000000xx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体。', + 'title' => 'Schema of Response', + 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'planName' => [ - 'title' => '计划名称', - 'description' => '计划名称', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], - 'planDesc' => [ - 'title' => '计划描述', - 'description' => '计划描述', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], - 'planType' => [ - 'title' => '计划类型', - 'description' => '备份任务类，不支持修改。参数取值如下：'."\n" - .' - ACTIVE_PASSIVE：单向备份'."\n" - .' - ACTIVE_ACTIVE：双向备份', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ACTIVE_ACTIVE' => '单向备份', - 'ACTIVE_PASSIVE' => '双向备份', - ], - 'example' => 'ACTIVE_PASSIVE', - ], - 'instances' => [ - 'title' => '容灾计划参与实例', - 'description' => '备份计划参与实例。不支持修改实例，只支持修改实例下面messageProperty消息过滤条件，auth认证方式', - 'type' => 'array', - 'items' => [ - 'description' => '备份计划参与实例', - 'type' => 'object', - 'properties' => [ - 'instanceType' => [ - 'title' => '实例类型', - 'description' => '实例类型：'."\n" - .' - ALIYUN_ROCKETMQ ：阿里云实例'."\n" - .' - EXTERNAL_ROCKETMQ ：外部实例，开源实例，开源集群', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ALIYUN_ROCKETMQ' => '阿里云实例', - 'EXTERNAL_ROCKETMQ' => '外部实例', - ], - 'example' => 'ALIYUN_ROCKETMQ', - ], - 'regionId' => [ - 'title' => '实例所在区域', - 'description' => '实例所在区域', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-83l3r0xxxx', - ], - 'instanceRole' => [ - 'title' => '实例角色', - 'description' => '实例角色，主或者备'."\n" - .' - ACTIVE：主'."\n" - .' - PASSIVE：备', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PASSIVE' => '备', - 'ACTIVE' => '主', - ], - 'example' => 'ACTIVE', - ], - 'authType' => [ - 'title' => '认证方式', - 'description' => '认证方式'."\n" - .' - NO_AUTH：无需认证'."\n" - .' - ACL_AUTH：acl认证', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'NO_AUTH' => '无须认证', - 'ACL_AUTH' => 'acl认证', - ], - 'example' => 'NO_AUTH', - ], - 'username' => [ - 'title' => '认证用户名', - 'description' => '认证用户名，authType为ACL_AUTH时必填', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], - 'password' => [ - 'title' => '认证密码', - 'description' => '认证密码，authType为ACL_AUTH时必填', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], - 'endpointUrl' => [ - 'title' => '接入点地址', - 'description' => '接入点地址，instanceType实例类型为ALIYUN_ROCKETMQ无须填写，EXTERNAL_ROCKETMQ需要填写', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], - 'networkType' => [ - 'title' => '网络类型', - 'description' => '网络类型，instanceType实例类型为ALIYUN_ROCKETMQ无须填写，EXTERNAL_ROCKETMQ需要填写 参数取值如下：'."\n" - .' - TCP_INTERNET：tcp公网'."\n" - .' - TCP_VPC：tcp专有网络', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TCP_VPC' => 'tcp专有网络', - 'TCP_INTERNET' => 'tcp公网', - ], - 'example' => 'TCP_INTERNET', - ], - 'vpcId' => [ - 'title' => 'VPC ID', - 'description' => '创建实例所关联的专有网络的ID，nstanceType实例类型仅为EXTERNAL_ROCKETMQ，networkType为TCP_VPC时需要填写', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-wz9qt50xhtj9krb******'."\n", - ], - 'vSwitchId' => [ - 'title' => '交换机ID', - 'description' => '实例所关联的交换机ID，nstanceType实例类型仅为EXTERNAL_ROCKETMQ，networkType为TCP_VPC时需要填写', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-uf6gwtbn6etadpv******'."\n", - ], - 'messageProperty' => [ - 'description' => '消息过滤属性，消息同步到目标集群时，会自动添加上该属性，用于消息消费时进行SQL过滤。', - 'type' => 'object', - 'properties' => [ - 'propertyKey' => [ - 'description' => '属性key', - 'type' => 'string', - 'required' => false, - 'example' => 'aaa', - ], - 'propertyValue' => [ - 'description' => '属性value', - 'type' => 'string', - 'required' => false, - 'example' => 'bbb', - ], - ], - 'required' => false, - ], - 'securityGroupId' => [ - 'description' => '安全组id，nstanceType实例类型仅为EXTERNAL_ROCKETMQ，networkType为TCP_VPC时需要填写', - 'type' => 'string', - 'required' => false, - 'example' => 'sg-bp17hpmgz9******'."\n", - ], - 'consumerGroupId' => [ - 'description' => '消费者组ID，用于从源实例拉取消息。'."\n" - .'<notice>自建实例必须填写，阿里云实例会自动生成。</notice>', - 'type' => 'string', - 'required' => false, - 'example' => 'GID_DS_XXX_YYY', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'autoSyncCheckpoint' => [ - 'title' => '自动消费进度同步开关', - 'description' => '是否开启消费进度自动同步。'."\n" - ."\n" - .'> 只有在开启消费进度同步时有效。即 `syncCheckpointEnabled`字段值为true。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '开启', - 'false' => '关闭', - ], - 'example' => 'true', - ], - 'syncCheckpointEnabled' => [ - 'description' => '同步消费进度开关', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '开启', - 'false' => '关闭', - ], - 'example' => 'true', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '7358418D-83BD-507A-8079-611C63E05674'], + 'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['description' => '动态错误信息。', 'type' => 'string', 'example' => 'instanceId'], + ], + ], + ], + ], + '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' => '同步消费进度信息', + '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' => '全部资源', 'arn' => '*'], ], - 'required' => false, ], ], ], + ], + 'TagResources' => [ + 'summary' => '用户创建标签资源关系。', + 'path' => '/resourceTag/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['title' => '地域ID。', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => ['title' => '资源类型。', 'description' => '资源类型。', 'type' => 'string', 'required' => true, 'example' => 'instance'], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => ['title' => '资源ID列表，JSON格式。', 'description' => '资源ID列表，JSON格式。', 'type' => 'string', 'required' => true, 'example' => '["rmq-cn-pe3355cs707"]'], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'schema' => ['title' => '标签列表，JSON格式。', 'description' => '标签列表，JSON格式。', 'type' => 'string', 'required' => true, 'example' => '[{"key": "rmq-test", "value": "test"}]'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -11441,726 +7214,253 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A07B41BD-6DD3-5349-9E76-00303Dxxxx', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'DisasterRecoveryPlanStatus.Error', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The current status of the disaster recovery plan does not support this operation.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '0B962390-D84B-5D44-8C11-79DF40299D41'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', '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' => '修改备份计划', - ], - 'ListDisasterRecoveryPlans' => [ - 'summary' => '查询备份计划列表。', - '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' => '创建标签资源关系', + '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' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UntagResources' => [ + 'summary' => '用户删除标签资源关系。', + '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' => '实例ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-c97xxx', - ], + 'schema' => ['title' => '地域ID。', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'filter', + 'name' => 'resourceType', 'in' => 'query', - 'schema' => [ - 'description' => '过滤条件，根据备份名称，备份描述进行过滤', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + 'schema' => ['title' => '资源类型。', 'description' => '资源类型。', 'type' => 'string', 'required' => true, 'example' => 'instance'], ], [ - 'name' => 'pageNumber', + 'name' => 'resourceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页页码，查询第几页的返回结果。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['title' => '资源ID列表，JSON格式。', 'description' => '资源ID列表，JSON格式。', 'type' => 'string', 'required' => true, 'example' => '["rmq-cn-pe3355cs707"]'], ], [ - 'name' => 'pageSize', + 'name' => 'tagKey', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，每页最多显示的返回结果数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['title' => '标签键列表，JSON格式。', 'description' => '标签键列表，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '["key1", "key2"]'], + ], + [ + 'name' => 'all', + 'in' => 'query', + 'schema' => ['title' => '是否删除所有标签。', 'description' => '是否删除所有标签。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<MyPage<DisasterRecoveryPlanDTO>>', - 'description' => 'Result<MyPage<DisasterRecoveryPlanDTO>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '855EF8E6-9C1D-5DE2-9E84-924E13Exxxx', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'True', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'object', - 'properties' => [ - 'scrollId' => [ - 'title' => '滚动标识', - 'description' => '请求滚动ID。'."\n" - .'系统自动生成，后续分页请求需要带上该返回结果，才能持续分页。', - 'type' => 'string', - 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00'."\n", - ], - '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' => '28', - ], - 'list' => [ - 'title' => '分页数据', - 'description' => '分页数据', - 'type' => 'array', - 'items' => [ - 'description' => '分页数据', - 'type' => 'object', - 'properties' => [ - 'planId' => [ - 'title' => '计划ID', - 'description' => '计划ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1300000016', - ], - 'planName' => [ - 'title' => '计划名称', - 'description' => '计划名称', - 'type' => 'string', - 'example' => 'xxx', - ], - 'planDesc' => [ - 'title' => '计划描述', - 'description' => '计划描述', - 'type' => 'string', - 'example' => 'xxx', - ], - 'planType' => [ - 'title' => '计划类型,DisasterRecoveryTypeEnum[ACTIVE_PASSIVE(灾备),ACTIVE_ACTIVE(双活),code,desc]', - 'description' => '计划类型：'."\n" - .' - ACTIVE_PASSIVE(单向备份)'."\n" - .' - ACTIVE_ACTIVE(双向备份)', - 'type' => 'string', - 'example' => 'ACTIVE_PASSIVE', - ], - 'planStatus' => [ - 'title' => '计划状态,DisasterRecoveryStatusEnum[CREATED(已创建),DELETED(已删除),code,desc]', - 'description' => '计划状态：'."\n" - .' - CREATED(已创建)'."\n" - .' - RUNNING(运行中)'."\n" - .' - DELETED(已删除)', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'extInfo' => [ - 'title' => '扩展信息', - 'description' => '扩展信息', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '扩展信息', - 'example' => 'xxx', - ], - ], - 'instances' => [ - 'title' => '容灾计划参与实例', - 'description' => '备份计划参与实例', - 'type' => 'array', - 'items' => [ - 'description' => '备份计划参与实例', - 'type' => 'object', - 'properties' => [ - 'instanceType' => [ - 'title' => '实例类型', - 'description' => '实例类型', - 'type' => 'string', - 'example' => 'ALIYUN_ROCKETMQ', - ], - 'regionId' => [ - 'title' => '实例所在区域', - 'description' => '实例所在区域', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-ot93rbxxx', - ], - 'instanceRole' => [ - 'title' => '实例角色', - 'description' => '实例角色', - 'type' => 'string', - 'example' => 'ACTIVE', - ], - 'authType' => [ - 'title' => '认证方式', - 'description' => '认证方式', - 'type' => 'string', - 'example' => 'NO_AUTH', - ], - 'username' => [ - 'title' => '认证用户名', - 'description' => '认证用户名', - 'type' => 'string', - 'example' => 'xxx', - ], - 'password' => [ - 'title' => '认证密码', - 'description' => '认证密码', - 'type' => 'string', - 'example' => 'xxx', - ], - 'endpointUrl' => [ - 'title' => '接入点地址', - 'description' => '接入点地址', - 'type' => 'string', - 'example' => 'xxx', - ], - 'networkType' => [ - 'title' => '网络类型', - 'description' => '网络类型', - 'type' => 'string', - 'example' => 'TCP_INTERNET', - ], - 'vpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID', - 'type' => 'string', - 'example' => 'vpc-bp13docqysrgxtbxxxx', - ], - 'vSwitchId' => [ - 'title' => '交换机ID', - 'description' => '交换机ID', - 'type' => 'string', - 'example' => 'vsw-uf6gwtbn6etadpv******'."\n", - ], - 'messageProperty' => [ - 'description' => '消息属性', - 'type' => 'object', - 'properties' => [ - 'propertyKey' => [ - 'description' => '属性key', - 'type' => 'string', - 'example' => 'aaa', - ], - 'propertyValue' => [ - 'description' => '属性value', - 'type' => 'string', - 'example' => 'bbb', - ], - ], - ], - 'securityGroupId' => [ - 'description' => '安全组id', - 'type' => 'string', - 'example' => 'sg-bp17hpmgz9******'."\n", - ], - 'consumerGroupId' => [ - 'description' => '消费者组ID，用于从源实例拉取消息。', - 'type' => 'string', - 'example' => 'GID_xxx', - ], - ], - ], - ], - 'syncCheckpointEnabled' => [ - 'title' => '同步消费进度开关', - 'description' => '同步消费进度开关', - 'type' => 'boolean', - 'example' => 'true', - ], - 'autoSyncCheckpoint' => [ - 'title' => '是否自动同步消费进度', - 'description' => '是否自动同步消费进度', - 'type' => 'boolean', - 'example' => 'true', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '修改时间', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - ], - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'xxx', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'A07B41BD-6DD3-5349-9E76-00303DF04BBE'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter deliveryOrderType is invalid.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', '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' => '查询备份计划列表', - ], - 'GetDisasterRecoveryPlan' => [ - 'summary' => '查询备份计划详情。', - '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' => '删除标签资源关系', + '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' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateConsumerGroup' => [ + 'summary' => '更新消费者分组的基础信息和消费重试策略。', + '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' => '备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'schema' => ['title' => '实例ID', 'description' => '待更新消费者分组所属的实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22on9****'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => ['title' => '消费组ID', 'description' => '待更新的消费者分组ID。', 'type' => 'string', 'required' => true, 'example' => 'CID-TEST'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Result<DisasterRecoveryPlanDTO>', - 'description' => 'Result<DisasterRecoveryPlanDTO>', + 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', + 'remark' => ['title' => '备注', 'description' => '更新后的消费者分组的备注信息。', 'type' => 'string', 'required' => false, 'example' => 'This is the remark for test.'], + 'deliveryOrderType' => [ + 'title' => '投递顺序性', + 'description' => '不支持修改', 'type' => 'string', - 'example' => '7358418D-83BD-507A-8079-611C63E0xxx', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', + 'deprecated' => true, + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Concurrently', + 'enum' => ['Concurrently', 'Orderly'], ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', + 'consumeRetryPolicy' => [ + 'title' => '消费重试策略', + 'description' => '更新后的消费者分组的消费重试策略。更多信息，请参见'."\n" + .'[消费重试](~~440356~~)。', 'type' => 'object', 'properties' => [ - 'planId' => [ - 'title' => '计划ID', - 'description' => '计划ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1300000016', - ], - 'planName' => [ - 'title' => '计划名称', - 'description' => '计划名称', - 'type' => 'string', - 'example' => 'xxx', - ], - 'planDesc' => [ - 'title' => '计划描述', - 'description' => '计划描述', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'planType' => [ - 'title' => '计划类型,DisasterRecoveryTypeEnum[ACTIVE_PASSIVE(灾备),ACTIVE_ACTIVE(双活),code,desc]', - 'description' => '计划类型：'."\n" - .' - ACTIVE_PASSIVE(单向备份)'."\n" - .' - ACTIVE_ACTIVE(双向备份)', - 'type' => 'string', - 'example' => 'ACTIVE_PASSIVE', - ], - 'planStatus' => [ - 'title' => '计划状态,DisasterRecoveryStatusEnum[CREATED(已创建),DELETED(已删除),code,desc]', - 'description' => '计划状态：'."\n" - .' - CREATED(已创建)'."\n" - .' - RUNNING(运行中)'."\n" - .' - DELETED(已删除)', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'extInfo' => [ - 'title' => '扩展信息', - 'description' => '扩展信息', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'xxxx', - 'description' => '扩展信息', - ], - ], - 'instances' => [ - 'title' => '容灾计划参与实例', - 'description' => '备份计划参与实例', - 'type' => 'array', - 'items' => [ - 'description' => '备份计划参与实例', - 'type' => 'object', - 'properties' => [ - 'instanceType' => [ - 'title' => '实例类型', - 'description' => '实例类型', - 'type' => 'string', - 'example' => 'ALIYUN_ROCKETMQ', - ], - 'regionId' => [ - 'title' => '实例所在区域', - 'description' => '实例所在区域', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-gpz3qtcdxxx', - ], - 'instanceRole' => [ - 'title' => '实例角色', - 'description' => '实例角色', - 'type' => 'string', - 'example' => 'ACTIVE', - ], - 'authType' => [ - 'title' => '认证方式', - 'description' => '认证方式', - 'type' => 'string', - 'example' => 'ACL_AUTH', - ], - 'username' => [ - 'title' => '认证用户名', - 'description' => '认证用户名', - 'type' => 'string', - 'example' => 'xxx', - ], - 'password' => [ - 'title' => '认证密码', - 'description' => '认证密码', - 'type' => 'string', - 'example' => 'xxx', - ], - 'endpointUrl' => [ - 'title' => '接入点地址', - 'description' => '接入点地址', - 'type' => 'string', - 'example' => 'xxx', - ], - 'networkType' => [ - 'title' => '网络类型', - 'description' => '网络类型', - 'type' => 'string', - 'example' => 'TCP_INTERNET', - ], - 'vpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID', - 'type' => 'string', - 'example' => 'vpc-wz9qt50xhtj9krb******'."\n", - ], - 'vSwitchId' => [ - 'title' => '交换机ID', - 'description' => '交换机ID', - 'type' => 'string', - 'example' => 'vsw-uf6gwtbn6etadpv******'."\n", - ], - 'messageProperty' => [ - 'description' => '消息过滤属性', - 'type' => 'object', - 'properties' => [ - 'propertyKey' => [ - 'description' => '属性key', - 'type' => 'string', - 'example' => 'xxx', - ], - 'propertyValue' => [ - 'description' => '属性value', - 'type' => 'string', - 'example' => 'xxx', - ], - ], - ], - 'securityGroupId' => [ - 'description' => '安全组id', - 'type' => 'string', - 'example' => 'sg-bp17hpmgz9******'."\n", - ], - 'consumerGroupId' => [ - 'description' => '消费者组ID，用于从源实例拉取消息。', - 'type' => 'string', - 'example' => 'GID_DS_XXX_YYY', - ], - ], - ], - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '修改时间', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'autoSyncCheckpoint' => [ - 'description' => '是否开启消费进度自动同步。'."\n" + 'retryPolicy' => [ + 'title' => '重试策略类型', + 'description' => '重试策略类型。更多信息，请参见[消息重试](~~440356~~)。'."\n" ."\n" - .'> 只有在开启消费进度同步时有效。即 `syncCheckpointEnabled`字段值为true。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '开启', - 'false' => '关闭', - ], - 'example' => 'true', - ], - 'syncCheckpointEnabled' => [ - 'description' => '同步消费进度开关', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '开启', - 'false' => '关闭', - ], - 'example' => 'true', + .'参数取值如下：'."\n" + .'- FixedRetryPolicy：固定间隔重试，仅支持顺序投递'."\n" + .'- DefaultRetryPolicy：阶梯退避重试，仅支持并发投递', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['FixedRetryPolicy' => '固定间隔重试', 'DefaultRetryPolicy' => '阶梯退避重试'], + 'example' => 'DefaultRetryPolicy', + 'enum' => ['DefaultRetryPolicy', 'FixedRetryPolicy'], ], + 'maxRetryTimes' => ['title' => '最大重试次数', 'description' => '最大重试次数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16'], + 'deadLetterTargetTopic' => ['description' => '死信Topic。'."\n" + ."\n" + .'消费者出现异常消费某条消息失败，且消息重试后依然未成功，消息将被投递至死信Topic中，以便后续进行业务恢复或回溯。更多信息，请参见[消费重试与死信](~~440356~~)。', 'type' => 'string', 'required' => false, 'example' => 'DLQ_mqtest'], + 'fixedIntervalRetryTime' => ['description' => '固定重试间隔，单位：秒。重试策略为FixedRetryPolicy固定间隔重试策略时生效'."\n" + .'取值范围：'."\n" + .' - 并发投递：10-1800'."\n" + .' - 顺序投递：1-600', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], + 'required' => true, ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'xxx', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'maxReceiveTps' => ['description' => '消费消息tps上限', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'], ], + 'required' => false, ], ], ], - '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' => '查询备份计划详情', - ], - 'AddDisasterRecoveryItem' => [ - 'summary' => '添加备份映射任务', - 'path' => '/disaster_recovery/{planId}/items', - 'methods' => [ - 'post', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'C7F94090-3358-506A-97DC-34BC803C****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'InvalidDeliveryOrderType'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter deliveryOrderType is invalid.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'DeliveryOrderType'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'deliveryOrderType'], + ], + ], + ], ], - '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' => '更新消费者分组', + 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></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' => [ + 'summary' => '更新备份映射任务。', + 'path' => '/disaster_recovery/{planId}/items/{itemId}', + 'methods' => ['patch'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12172,81 +7472,48 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '225043', - 'abilityTreeNodes' => [ - 'FEATUREonsOVRH1R', - 'FEATUREonsU22PJL', - ], + 'abilityTreeCode' => '263691', + 'abilityTreeNodes' => ['FEATUREonsOVRH1R', 'FEATUREonsU22PJL'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', - 'schema' => [ - 'description' => '备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['description' => '备份计划id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016'], + ], + [ + 'name' => 'itemId', + 'in' => 'path', + 'schema' => ['description' => '映射任务id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100070284'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体结构。必填', + 'description' => '请求体结构。', 'type' => 'object', 'properties' => [ 'topics' => [ - 'title' => '容灾Item所包含的容灾主题', - 'description' => '备份映射所包含的主题，必填', + 'description' => '备份映射所包含的主题列表', 'type' => 'array', 'items' => [ 'description' => '备份映射所包含的主题', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => '区域ID', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'regionId' => ['description' => '区域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], 'instanceType' => [ - 'title' => '实例类型', 'description' => '实例类型'."\n" .' - ALIYUN_ROCKETMQ ：阿里云实例'."\n" .' - EXTERNAL_ROCKETMQ ：外部实例，开源实例，开源集群', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'ALIYUN_ROCKETMQ' => '阿里云实例', - 'EXTERNAL_ROCKETMQ' => '外部实例', - ], + 'enumValueTitles' => ['ALIYUN_ROCKETMQ' => '阿里云实例', 'EXTERNAL_ROCKETMQ' => '外部实例'], 'example' => 'ALIYUN_ROCKETMQ'."\n", ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID，instanceType为EXTERNAL_ROCKETMQ会自动生成个实例ID，可以通过查询备份计划获取该ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rmq-cn-em93y94xxx', - ], - 'topicName' => [ - 'title' => '容灾主题名称', - 'description' => '容灾主题名称,必填', - 'type' => 'string', - 'required' => false, - 'example' => 'Topic_xxx', - ], - 'consumerGroupId' => [ - 'title' => '消费者组ID', - 'description' => '消费者组ID，ACTIVE_ACTIVE双向备份时必填', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'GID_xxx', - ], + 'instanceId' => ['description' => '实例ID，instanceType为EXTERNAL_ROCKETMQ会自动生成个实例ID，可以通过查询备份计划获取该ID。', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-em93y94xxx'], + 'topicName' => ['description' => '容灾主题名称,必填', 'type' => 'string', 'required' => false, 'example' => 'Topic_xxx'], + 'consumerGroupId' => ['description' => '消费者组ID，ACTIVE_ACTIVE双向备份时必填', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'GID_xxx'], 'deliveryOrderType' => [ 'description' => '消息投递到目标实例的顺序性。'."\n" ."\n" @@ -12255,10 +7522,7 @@ .'- Orderly：顺序投递', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Concurrently' => '并发投递', - 'Orderly' => '顺序投递', - ], + 'enumValueTitles' => ['Concurrently' => '并发投递', 'Orderly' => '顺序投递'], 'example' => 'Concurrently', ], ], @@ -12274,81 +7538,49 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'description' => '返回结果,映射任务id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1300000016', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'xxx', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0C32BED2-FA9F-50AD-9DA7-8B70E26C9D0D'], + 'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['description' => '错误码', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], - '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' => '添加备份映射任务', - ], - 'UpdateDisasterRecoveryItem' => [ - 'summary' => '更新备份映射任务。', - 'path' => '/disaster_recovery/{planId}/items/{itemId}', - 'methods' => [ - 'patch', + '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' => '更新备份映射任务', + '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' => [ + 'summary' => '修改备份计划。', + 'path' => '/disaster_recovery/{planId}', + 'methods' => ['patch'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12360,106 +7592,124 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '263691', - 'abilityTreeNodes' => [ - 'FEATUREonsOVRH1R', - 'FEATUREonsU22PJL', - ], + 'abilityTreeCode' => '225048', + 'abilityTreeNodes' => ['FEATUREonsU22PJL'], ], 'parameters' => [ [ 'name' => 'planId', 'in' => 'path', - 'schema' => [ - 'description' => '备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], - ], - [ - 'name' => 'itemId', - 'in' => 'path', - 'schema' => [ - 'description' => '映射任务id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100070284', - ], + 'schema' => ['description' => '备份计划id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1300000016'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体结构。', + 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'topics' => [ - 'description' => '备份映射所包含的主题列表', + 'planName' => ['title' => '计划名称', 'description' => '计划名称', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + 'planDesc' => ['title' => '计划描述', 'description' => '计划描述', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + 'planType' => [ + 'title' => '计划类型', + 'description' => '备份任务类，不支持修改。参数取值如下：'."\n" + .' - ACTIVE_PASSIVE：单向备份'."\n" + .' - ACTIVE_ACTIVE：双向备份', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['ACTIVE_ACTIVE' => '单向备份', 'ACTIVE_PASSIVE' => '双向备份'], + 'example' => 'ACTIVE_PASSIVE', + ], + 'instances' => [ + 'title' => '容灾计划参与实例', + 'description' => '备份计划参与实例。不支持修改实例，只支持修改实例下面messageProperty消息过滤条件，auth认证方式', 'type' => 'array', 'items' => [ - 'description' => '备份映射所包含的主题', + 'description' => '备份计划参与实例', 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => '区域ID', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], 'instanceType' => [ - 'description' => '实例类型'."\n" + 'title' => '实例类型', + 'description' => '实例类型：'."\n" .' - ALIYUN_ROCKETMQ ：阿里云实例'."\n" .' - EXTERNAL_ROCKETMQ ：外部实例，开源实例，开源集群', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'ALIYUN_ROCKETMQ' => '阿里云实例', - 'EXTERNAL_ROCKETMQ' => '外部实例', - ], - 'example' => 'ALIYUN_ROCKETMQ'."\n", + 'enumValueTitles' => ['ALIYUN_ROCKETMQ' => '阿里云实例', 'EXTERNAL_ROCKETMQ' => '外部实例'], + 'example' => 'ALIYUN_ROCKETMQ', ], - 'instanceId' => [ - 'description' => '实例ID，instanceType为EXTERNAL_ROCKETMQ会自动生成个实例ID，可以通过查询备份计划获取该ID。', + 'regionId' => ['title' => '实例所在区域', 'description' => '实例所在区域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + 'instanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-83l3r0xxxx'], + 'instanceRole' => [ + 'title' => '实例角色', + 'description' => '实例角色，主或者备'."\n" + .' - ACTIVE：主'."\n" + .' - PASSIVE：备', 'type' => 'string', 'required' => false, - 'example' => 'rmq-cn-em93y94xxx', + 'enumValueTitles' => ['PASSIVE' => '备', 'ACTIVE' => '主'], + 'example' => 'ACTIVE', ], - 'topicName' => [ - 'description' => '容灾主题名称,必填', + 'authType' => [ + 'title' => '认证方式', + 'description' => '认证方式'."\n" + .' - NO_AUTH：无需认证'."\n" + .' - ACL_AUTH：acl认证', 'type' => 'string', 'required' => false, - 'example' => 'Topic_xxx', + 'enumValueTitles' => ['NO_AUTH' => '无须认证', 'ACL_AUTH' => 'acl认证'], + 'example' => 'NO_AUTH', ], - 'consumerGroupId' => [ - 'description' => '消费者组ID，ACTIVE_ACTIVE双向备份时必填', + 'username' => ['title' => '认证用户名', 'description' => '认证用户名，authType为ACL_AUTH时必填', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + 'password' => ['title' => '认证密码', 'description' => '认证密码，authType为ACL_AUTH时必填', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + 'endpointUrl' => ['title' => '接入点地址', 'description' => '接入点地址，instanceType实例类型为ALIYUN_ROCKETMQ无须填写，EXTERNAL_ROCKETMQ需要填写', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + 'networkType' => [ + 'title' => '网络类型', + 'description' => '网络类型，instanceType实例类型为ALIYUN_ROCKETMQ无须填写，EXTERNAL_ROCKETMQ需要填写 参数取值如下：'."\n" + .' - TCP_INTERNET：tcp公网'."\n" + .' - TCP_VPC：tcp专有网络', 'type' => 'string', - 'deprecated' => true, 'required' => false, - 'example' => 'GID_xxx', + 'enumValueTitles' => ['TCP_VPC' => 'tcp专有网络', 'TCP_INTERNET' => 'tcp公网'], + 'example' => 'TCP_INTERNET', ], - 'deliveryOrderType' => [ - 'description' => '消息投递到目标实例的顺序性。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- Concurrently：并发投递'."\n" - .'- Orderly：顺序投递', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Concurrently' => '并发投递', - 'Orderly' => '顺序投递', + 'vpcId' => ['title' => 'VPC ID', 'description' => '创建实例所关联的专有网络的ID，nstanceType实例类型仅为EXTERNAL_ROCKETMQ，networkType为TCP_VPC时需要填写', 'type' => 'string', 'required' => false, 'example' => 'vpc-wz9qt50xhtj9krb******'."\n"], + 'vSwitchId' => ['title' => '交换机ID', 'description' => '实例所关联的交换机ID，nstanceType实例类型仅为EXTERNAL_ROCKETMQ，networkType为TCP_VPC时需要填写', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6gwtbn6etadpv******'."\n"], + 'messageProperty' => [ + 'description' => '消息过滤属性，消息同步到目标集群时，会自动添加上该属性，用于消息消费时进行SQL过滤。', + 'type' => 'object', + 'properties' => [ + 'propertyKey' => ['description' => '属性key', 'type' => 'string', 'required' => false, 'example' => 'aaa'], + 'propertyValue' => ['description' => '属性value', 'type' => 'string', 'required' => false, 'example' => 'bbb'], ], - 'example' => 'Concurrently', + 'required' => false, ], + 'securityGroupId' => ['description' => '安全组id，nstanceType实例类型仅为EXTERNAL_ROCKETMQ，networkType为TCP_VPC时需要填写', 'type' => 'string', 'required' => false, 'example' => 'sg-bp17hpmgz9******'."\n"], + 'consumerGroupId' => ['description' => '消费者组ID，用于从源实例拉取消息。'."\n" + .'<notice>自建实例必须填写，阿里云实例会自动生成。</notice>', 'type' => 'string', 'required' => false, 'example' => 'GID_DS_XXX_YYY'], ], 'required' => false, ], 'required' => false, ], + 'autoSyncCheckpoint' => [ + 'title' => '自动消费进度同步开关', + 'description' => '是否开启消费进度自动同步。'."\n" + ."\n" + .'> 只有在开启消费进度同步时有效。即 `syncCheckpointEnabled`字段值为true。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], + 'example' => 'true', + ], + 'syncCheckpointEnabled' => [ + 'description' => '同步消费进度开关', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], + 'example' => 'true', + ], ], 'required' => false, ], @@ -12468,99 +7718,167 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0C32BED2-FA9F-50AD-9DA7-8B70E26C9D0D', - ], - 'success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'A07B41BD-6DD3-5349-9E76-00303Dxxxx'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DisasterRecoveryPlanStatus.Error'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The current status of the disaster recovery plan does not support this operation.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '更新备份映射任务', - ], - 'DeleteDisasterRecoveryItem' => [ - 'summary' => '删除备份映射任务。', - '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' => '修改备份计划', + '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' => '更新云消息队列 RocketMQ 版实例的基本信息和规格配置。', + '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' => '备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['title' => '实例ID', 'description' => '待更新实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'itemId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '映射任务id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100000650', + 'description' => '请求体结构。', + 'type' => 'object', + 'properties' => [ + 'instanceName' => ['title' => '实例名称', 'description' => '更新后的实例名称。', 'type' => 'string', 'required' => false, 'example' => 'test_instance'], + 'remark' => ['title' => '实例备注', 'description' => '更新后的实例备注信息。', 'type' => 'string', 'required' => false, 'example' => 'This is the remark for test.'], + 'networkInfo' => [ + 'title' => '网络信息', + 'description' => '更新后的实例网络信息。', + 'type' => 'object', + 'properties' => [ + 'internetInfo' => [ + 'title' => '公网信息', + 'description' => '公网信息，仅当实例开通公网访问功能时，该参数有效。', + 'type' => 'object', + 'properties' => [ + 'ipWhitelist' => [ + 'title' => '公网IP白名单列表', + 'description' => '公网访问IP白名单列表。'."\n" + ."\n" + .'- 若不配置IP白名单，则默认放通所有IP地址段通过公网访问云消息队列 RocketMQ 版服务端。'."\n" + .'- 若配置IP白名单，则仅允许白名单内的IP地址通过公网访问云消息队列 RocketMQ 版服务端。', + 'type' => 'array', + 'items' => ['title' => '公网IP白名单', 'description' => '公网访问IP白名单。', 'type' => 'string', 'required' => false, 'example' => '192.168.x.x/24'], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'productInfo' => [ + 'title' => '扩展配置', + 'description' => '实例的扩展配置。', + 'type' => 'object', + 'properties' => [ + 'sendReceiveRatio' => ['title' => '消息收发比例', 'description' => '消息发送和接收的比例。'."\n" + ."\n" + .'取值范围：[0.25，1]', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.5'], + 'autoScaling' => [ + 'title' => '自适应弹性伸缩', + 'description' => '是否开启规格外突发弹性能力。'."\n" + ."\n" + .'开启弹性突发能力后，云消息队列 RocketMQ 版允许该实例在一定范围内超过基础规格限制的TPS，且超过基础规格外的部分，需要收取额外的弹性规格费用。具体计费信息，请参见[计算能力费用](~~427237~~)。'."\n" + ."\n\n" + .'> 仅部分规格的实例支持开启弹性突发规格能力，具体支持的实例，请参见[实例规格](~~444715~~)。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '开启弹性', 'false' => '关闭弹性'], + 'example' => 'true', + ], + 'messageRetentionTime' => ['title' => '消息保留时长', 'description' => '消息保存时长。单位：小时。'."\n" + ."\n" + .'取值范围，请参见[使用限制](~~440347~~)>资源配额>消息保存时长的限制值。'."\n" + ."\n" + .'云消息队列 RocketMQ 版的消息存储完全实现Serverless弹性，按照实际存储空间收取费用，您可以通过调整消息保存时长来控制消息的存储容量。更多信息，请参见[存储费用](~~427238~~)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '72'], + 'traceOn' => [ + 'description' => '是否开启消息轨迹功能。'."\n" + ."\n" + .'<props="intl">该参数暂不生效，不管参数是否开启，实例都默认支持轨迹功能。</props>'."\n" + .'<props="china">该参数仅对Serverless类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见[Serverless计费说明](~~2586280~~)。</props>'."\n" + .'<props="china">对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。</props>', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['false' => '关闭消息轨迹功能', 'true' => '开启消息轨迹功能'], + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'aclInfo' => [ + 'description' => '访问控制信息。', + 'type' => 'object', + 'properties' => [ + 'aclTypes' => [ + 'description' => '实例的鉴权类型。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的鉴权类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['default' => '智能身份识别', 'apache_acl' => 'Apache RocketMQ ACL'], + 'example' => 'apache_acl', + ], + 'required' => false, + ], + 'defaultVpcAuthFree' => [ + 'description' => '是否智能身份识别类型下，VPC接入免密访问', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '开启免密访问', 'false' => '关闭免密访问'], + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + 'required' => false, ], ], ], @@ -12571,110 +7889,92 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '0B962390-D84B-5D44-8C11-79DFxxxx', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'DisasterRecoveryItemStatus.Error', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The current status of the disaster recovery item does not support this operation.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AA87DE09-DA44-52F4-9515-78B1B607****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码。', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息。', 'type' => 'string', 'example' => 'instanceId'], ], ], ], ], - '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' => '删除备份映射任务', - ], - 'StartDisasterRecoveryItem' => [ - 'summary' => '启用备份映射任务。', - 'path' => '/disaster_recovery/{planId}/items/{itemId}/start', - 'methods' => [ - 'post', + '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' => '更新实例', + 'description' => '><notice>阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。></notice>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => '更新指定实例下指定账号的信息。', + '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' => '备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'itemId', + 'name' => 'username', 'in' => 'path', + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'accountStatus', + 'in' => 'query', 'schema' => [ - 'description' => '映射任务id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100000704', + 'description' => '账号状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['DISABLE' => '禁用', 'ENABLE' => '启用'], + 'example' => 'ENABLE', ], ], + [ + 'name' => 'password', + 'in' => 'query', + 'schema' => ['description' => '账号密码。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'remark', + 'in' => 'query', + 'schema' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], ], 'responses' => [ 200 => [ @@ -12683,1009 +7983,344 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C7E8AE3A-219B-52EE-BE32-4036Fxxxxx', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'DisasterRecoveryItemStatus.Error', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The current status of the disaster recovery item does not support this operation.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Instance.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '启用备份映射任务', - ], - 'StopDisasterRecoveryItem' => [ - 'summary' => '停用备份映射任务。', - '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' => '更新访问账号', + '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' => '更新指定实例下，指定用户和资源的访问权限。', + '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' => '备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'itemId', + 'name' => 'username', 'in' => 'path', - 'schema' => [ - 'description' => '映射任务id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100070284', - ], + 'schema' => ['description' => '用户名称', 'type' => 'string', 'required' => true, 'example' => 'test'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'description' => '请求体结构。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A07B41BD-6DD3-5349-9E76-00303xxxx', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'DisasterRecoveryItemStatus.Error', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', + 'resourceType' => [ + 'title' => '授权的资源列表,ResourceTypeEnum[TOPIC,GROUP,code,desc]', + 'description' => '授权的资源类型', 'type' => 'string', - 'example' => 'The current status of the disaster recovery item does not support this operation.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'required' => true, + 'enumValueTitles' => ['Group' => '消费者组', 'Topic' => '主题'], + 'example' => 'Topic', ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', + 'resourceName' => ['title' => '授权资源名称', 'description' => '授权的资源名称', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'actions' => [ + 'description' => '针对不同的资源类型，支持的操作类型如下：'."\n" + ."\n" + .'- 主题（Topic）：Pub、Sub、Pub|Sub'."\n" + .'- 消费者组（Group）: Sub', + 'type' => 'array', + 'items' => ['description' => '针对不同的资源类型，支持的操作类型如下：'."\n" + ."\n" + .'- 主题（Topic）：Pub、Sub、PubSub'."\n" + .'- 消费者组（Group）: Sub', 'type' => 'string', 'required' => false, 'example' => 'Pub'], + 'required' => false, + 'enumValueTitles' => ['Sub' => '订阅', 'Pub|Sub' => '发送订阅', 'Pub' => '发送'], + 'example' => 'Pub', ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', + 'decision' => [ + 'title' => '决策,DecisionEnum[ALLOW,DENY,type,desc]', + 'description' => '授权的决策结果', 'type' => 'string', - 'example' => 'instanceId', + 'required' => false, + 'enumValueTitles' => ['Deny' => '拒绝访问', 'Allow' => '允许访问'], + 'example' => 'Allow', ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', + 'ipWhitelists' => [ + 'title' => 'ip白名单', + 'description' => 'IP白名单列表', + 'type' => 'array', + 'items' => ['description' => 'IP白名单', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0'], + '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' => '停用备份映射任务', - ], - 'ListDisasterRecoveryItems' => [ - 'summary' => '查询备份映射任务列表。', - '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' => '备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'topicName', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '主题名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'topic-test284', - ], - ], - [ - 'name' => 'filter', - 'in' => 'query', - 'schema' => [ - 'description' => '过滤条件，根据topicName过滤', - 'type' => 'string', - 'required' => false, - 'example' => 'topic_test', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页页码，查询第几页的返回结果。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，每页最多显示的返回结果数量。', - 'type' => 'integer', - 'format' => 'int32', 'required' => false, - 'maximum' => '10000', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<MyPage<DisasterRecoveryItemDTO>>', - 'description' => 'Result<MyPage<DisasterRecoveryItemDTO>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C115601B-8736-5BBF-AC99-7FEAE12xxxx', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'object', - 'properties' => [ - 'scrollId' => [ - 'title' => '滚动标识', - 'description' => '请求滚动ID。'."\n" - .'系统自动生成，后续分页请求需要带上该返回结果，才能持续分页。', - 'type' => 'string', - 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00'."\n", - ], - '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' => '49', - ], - 'list' => [ - 'title' => '分页数据', - 'description' => '分页数据', - 'type' => 'array', - 'items' => [ - 'description' => '分页数据', - 'type' => 'object', - 'properties' => [ - 'itemId' => [ - 'description' => '备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100070284', - ], - 'planId' => [ - 'title' => '容灾Item所在容灾计划ID', - 'description' => '映射id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1300000016', - ], - 'itemStatus' => [ - 'title' => '容灾Item状态,DisasterRecoveryItemStatusEnum[CREATING(创建中),CHANGING(变更中),RUNNING(运行中),MANUAL_STOPPED(人工停用),OVERDUE_STOPPED(欠费停用),code,desc]', - 'description' => '备份映射状态：'."\n" - .' - CREATING(创建中)'."\n" - .' - CHANGING(变更中)'."\n" - .' - RUNNING(运行中)'."\n" - .' - MANUAL_STOPPED(人工停用)'."\n" - .' - OVERDUE_STOPPED(欠费停用)', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'topics' => [ - 'title' => '容灾Item所包含的容灾主题', - 'description' => '备份映射所包含的主题', - 'type' => 'array', - 'items' => [ - 'description' => '备份映射所包含的主题', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'regionId', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceType' => [ - 'title' => '实例类型', - 'description' => '实例类型', - 'type' => 'string', - 'example' => 'ALIYUN_ROCKETMQ', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-kh43w0olz0c', - ], - 'topicName' => [ - 'title' => '容灾主题名称', - 'description' => '主题名称', - 'type' => 'string', - 'example' => 'topic-test', - ], - 'consumerGroupId' => [ - 'title' => '消费者组ID', - 'description' => '消费者组ID', - 'type' => 'string', - 'deprecated' => true, - 'example' => 'group-test', - ], - 'deliveryOrderType' => [ - 'description' => '消息投递到目标实例的顺序性。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- Concurrently：并发投递'."\n" - .'- Orderly：顺序投递', - 'type' => 'string', - 'enumValueTitles' => [ - 'Concurrently' => '并发投递', - 'Orderly' => '顺序投递', - ], - 'example' => 'Concurrently', - ], - ], - ], - ], - 'extInfo' => [ - 'title' => '扩展信息', - 'description' => '扩展信息', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '扩展信息', - 'example' => '{}', - ], - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2024-09-20 03:38:28', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '修改时间', - 'type' => 'string', - 'example' => '2024-10-04 02:19:44', - ], - ], - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'xxx', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'instanceId'], + 'accessDeniedDetail' => ['title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', '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' => '查询备份映射列表', - ], - 'GetDisasterRecoveryItem' => [ - 'summary' => '查询备份计划映射详情。', - 'path' => '/disaster_recovery/{planId}/items/{itemId}', - 'methods' => [ - 'get', + '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' => '更新访问权限', + '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}'], + ], + ], + ], ], + ], + 'UpdateTopic' => [ + 'summary' => '更新主题的备注信息。', + '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' => '备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['title' => '实例ID', 'description' => '待更新主题所属的实例的ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-7e22ody****'], ], [ - 'name' => 'itemId', + 'name' => 'topicName', 'in' => 'path', + 'schema' => ['title' => '主题名称', 'description' => '待更新的主题的名称。', 'type' => 'string', 'required' => true, 'example' => 'topic_test'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '映射任务id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100070284', + 'title' => '', + 'description' => '请求体结构。', + 'type' => 'object', + 'properties' => [ + 'remark' => ['title' => '备注', 'description' => '更新后的主题备注信息。', 'type' => 'string', 'required' => false, 'example' => 'This is the remark for test.'], + 'maxSendTps' => ['description' => '发送消息tps上限', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'], + 'liteTopicExpiration' => ['title' => 'liteTopic过期时间，单位：分钟'."\n" + .'取值范围：15-720。'."\n" + .'默认-1，表示永久存在', 'description' => 'lite类型的Topic过期时间，单位：分钟'."\n" + .'取值范围：15-720。'."\n" + .'默认-1，表示永久存在', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], + ], + 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<DisasterRecoveryItemDTO>', - 'description' => 'Result<DisasterRecoveryItemDTO>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'object', - 'properties' => [ - 'itemId' => [ - 'description' => '备份计划id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100070284', - ], - 'planId' => [ - 'title' => '容灾Item所在容灾计划ID', - 'description' => '映射id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1300000016', - ], - 'itemStatus' => [ - 'title' => '容灾Item状态,DisasterRecoveryItemStatusEnum[CREATING(创建中),CHANGING(变更中),RUNNING(运行中),MANUAL_STOPPED(人工停用),OVERDUE_STOPPED(欠费停用),code,desc]', - 'description' => '备份映射状态：'."\n" - .' - CREATING(创建中)'."\n" - .' - CHANGING(变更中)'."\n" - .' - RUNNING(运行中)'."\n" - .' - MANUAL_STOPPED(人工停用)'."\n" - .' - OVERDUE_STOPPED(欠费停用)', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'topics' => [ - 'title' => '容灾Item所包含的容灾主题', - 'description' => '备份映射所包含的主题', - 'type' => 'array', - 'items' => [ - 'description' => '备份映射所包含的主题', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'regionId', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceType' => [ - 'title' => '实例类型', - 'description' => '实例类型', - 'type' => 'string', - 'example' => 'ALIYUN_ROCKETMQ', - ], - 'instanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-wwo3xxx', - ], - 'topicName' => [ - 'title' => '容灾主题名称', - 'description' => '主题名称', - 'type' => 'string', - 'example' => 'order_push_xxx', - ], - 'consumerGroupId' => [ - 'title' => '消费者组ID', - 'description' => '消费者组ID', - 'type' => 'string', - 'deprecated' => true, - 'example' => 'xxx_reserve_group', - ], - 'deliveryOrderType' => [ - 'description' => '消息投递到目标实例的顺序性。'."\n" - ."\n" - .'参数取值如下：'."\n" - .'- Concurrently：并发投递'."\n" - .'- Orderly：顺序投递', - 'type' => 'string', - 'enumValueTitles' => [ - 'Concurrently' => '并发投递', - 'Orderly' => '顺序投递', - ], - 'example' => 'Concurrently', - ], - ], - ], - ], - 'extInfo' => [ - 'title' => '扩展信息', - 'description' => '扩展信息', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{}', - 'description' => '扩展信息', - ], - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2024-06-24 02:57:31', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '修改时间', - 'type' => 'string', - 'example' => '2024-09-26 02:13:10', - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'xxx', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'accessDeniedDetail' => [ - 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'description' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', - 'type' => 'string', - 'example' => 'xxx', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'], + 'success' => ['title' => '是否成功', 'description' => '执行结果是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'The topic cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'TopicName'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'topicName'], ], ], ], ], - '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' => '查询备份映射详情', - ], - 'ListDisasterRecoveryCheckpoints' => [ - 'summary' => '查询消费进度同步列表。', - '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' => '更新主题', + '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' => [ + 'summary' => '验证指定实例下指定主题的消息消费状态。', + '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' => '备份计划ID', - 'type' => 'string', - 'required' => true, - 'example' => '1300000016', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-i7m2vc1vx01'], ], [ - 'name' => 'itemId', + 'name' => 'topicName', 'in' => 'path', - 'schema' => [ - 'title' => '备份映射ID', - 'description' => '备份映射ID', - 'type' => 'string', - 'required' => true, - 'example' => '100070284', - ], + 'schema' => ['description' => '主题名称。', 'type' => 'string', 'required' => true, 'example' => 'delay_topic'], ], [ - 'name' => 'instanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '源实例ID', - 'description' => '源实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'rmq-cn-7e22ody****', - ], - ], - [ - 'name' => 'filter', - 'in' => 'query', - 'schema' => [ - 'title' => '过滤条件', - 'description' => '过滤条件', - 'type' => 'string', - 'required' => false, - 'example' => 'topic_test', - ], + 'name' => 'messageId', + 'in' => 'path', + 'schema' => ['description' => '消息ID。', 'type' => 'string', 'required' => true, 'example' => 'A9FE190A59AA421ED014743DFDBF017D'], ], [ - 'name' => 'pageNumber', + 'name' => 'consumerGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '当前页码，从1开始。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '消费者分组ID。', 'type' => 'string', 'required' => true, 'example' => 'TEST_FINANCE_STOCK_OUT_GROUP'], ], [ - 'name' => 'pageSize', + 'name' => 'clientId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，每页最多显示的返回结果数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '客户端ID。', 'type' => 'string', 'required' => true, 'example' => 'zeekr-settlement-server-dc555456f-v2lcg@1@1@qfvorazqns'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结果', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'description' => '返回结果', - 'type' => 'object', - 'properties' => [ - 'pageNumber' => [ - 'description' => '当前页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'totalCount' => [ - 'description' => '总记录数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'list' => [ - 'description' => '分页数据', - 'type' => 'array', - 'items' => [ - 'description' => '分页数据', - 'type' => 'object', - 'properties' => [ - 'planId' => [ - 'description' => '备份计划ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13000000xx', - ], - 'itemId' => [ - 'description' => '备份映射ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000000xx', - ], - 'checkpointId' => [ - 'description' => '消费进度ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000000xx', - ], - 'lastSyncTime' => [ - 'description' => '最近同步时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1740724080343', - ], - 'sourceProgress' => [ - 'description' => '源消费进度', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => '区域ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-3mp3vblzxxx', - ], - 'instanceType' => [ - 'description' => '实例类型'."\n" - .' - ALIYUN_ROCKETMQ ：阿里云实例'."\n" - .' - EXTERNAL_ROCKETMQ ：外部实例，开源实例，开源集群', - 'type' => 'string', - 'example' => 'ALIYUN_ROCKETMQ', - ], - 'consumerGroupId' => [ - 'description' => '消费者组ID', - 'type' => 'string', - 'example' => 'GID_TEST', - ], - 'topicName' => [ - 'description' => '主题名称', - 'type' => 'string', - 'example' => 'TOPIC_TEST', - ], - 'lastFetchTime' => [ - 'description' => '最近获取时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1740724080343', - ], - 'progressData' => [ - 'description' => '消费进度数据', - 'type' => 'object', - 'properties' => [ - 'consumeTimestamp' => [ - 'description' => '最新消费时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1740724080343', - ], - ], - ], - ], - ], - 'targetProgress' => [ - 'description' => '目标消费进度', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => '区域ID', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'instanceId' => [ - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-nwy3i065xxx', - ], - 'instanceType' => [ - 'description' => '实例类型'."\n" - .' - ALIYUN_ROCKETMQ ：阿里云实例'."\n" - .' - EXTERNAL_ROCKETMQ ：外部实例，开源实例，开源集群', - 'type' => 'string', - 'example' => 'ALIYUN_ROCKETMQ', - ], - 'consumerGroupId' => [ - 'description' => '消费者组ID', - 'type' => 'string', - 'example' => 'GID_TEST', - ], - 'topicName' => [ - 'description' => '主题名称', - 'type' => 'string', - 'example' => 'TOPIC_TEST', - ], - 'lastFetchTime' => [ - 'description' => '最新获取时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1740724080343', - ], - 'progressData' => [ - 'description' => '消费进度数据', - 'type' => 'object', - 'properties' => [ - 'consumeTimestamp' => [ - 'description' => '最新消费时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1740724080343', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'code' => [ - 'description' => '错误码', - 'type' => 'string', - 'example' => '200', - ], - 'message' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '5304143F-AB0E-5AB4-A227-7C5489216FD5'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Topic.NotFound'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Parameter instanceId is mandatory for this action .'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'InstanceId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', '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' => '查询消费进度同步列表', - ], - 'SyncDisasterRecoveryCheckpoint' => [ - 'summary' => '同步消费进度信息到目标实例。', - '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' => '消息消费验证', + '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' => '验证指定实例下指定主题的消息发送功能。', + 'path' => '/instances/{instanceId}/topics/{topicName}/messages', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13695,1423 +8330,1200 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '251695', - 'abilityTreeNodes' => [ - 'FEATUREonsOVRH1R', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREonsB0E8FD'], ], 'parameters' => [ [ - 'name' => 'planId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '备份计划ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13000000xx', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rmq-cn-wwo32kqfm10'], ], [ - 'name' => 'itemId', + 'name' => 'topicName', 'in' => 'path', - 'schema' => [ - 'description' => '映射ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13000000xx', - ], + 'schema' => ['description' => '主题名称。', 'type' => 'string', 'required' => true, 'example' => 'card_status_topic'], ], [ - 'name' => 'checkpointId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '消费进度ID', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '请求体结构。', + 'type' => 'object', + 'properties' => [ + 'message' => ['title' => '消息内容', 'description' => '消息内容', 'type' => 'string', 'required' => false, 'example' => 'successful'], + 'messageTag' => ['title' => '消息标签', 'description' => '消息标签', 'type' => 'string', 'required' => false, 'example' => 'xx'], + 'messageKey' => ['title' => '业务标识', 'description' => '业务标识', 'type' => 'string', 'required' => false, 'example' => 'xx'], + 'liteTopicName' => ['title' => '轻量主题名称', 'description' => 'Lite消息队列主题名称', 'type' => 'string', 'required' => false, 'example' => 'abc'], + 'messageGroup' => ['title' => '消息组'."\n", 'description' => '以前的shardingkey，顺序消息独有', 'type' => 'string', 'required' => false, 'example' => 'testMessageGroup'], + 'deliveryTimeStamp' => ['title' => '投递消息时间戳', 'description' => '延时消息定时时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1773718320000'], + 'userProperties' => ['title' => '用户属性', 'description' => '消息自定义属性', 'type' => 'object', 'required' => false, 'example' => '{"test":"test"}'], + ], 'required' => false, - 'example' => '13000000xx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结果', + 'title' => 'Result<String>', + 'description' => 'Result<String>', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '7358418D-83BD-507A-8079-611C63E05674', - ], - 'success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'instanceId', - ], + 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '3BD2C19B-66DE-59C7-B2F6-FD1BE21DC8C1'], + 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'data' => ['title' => '返回结果', 'description' => '返回结果', 'type' => 'string', 'example' => '0A64228900207A4F0F2931A4E0D40BE5'], + 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'InvalidConsumerGroupId'], + 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'The instance cannot be found.'], + 'httpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'dynamicCode' => ['title' => '动态错误码', 'description' => '动态错误码', 'type' => 'string', 'example' => 'ConsumerGroupId'], + 'dynamicMessage' => ['title' => '动态错误信息', 'description' => '动态错误信息', 'type' => 'string', 'example' => 'consumerGroupId'], ], ], ], ], - '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' => '同步消费进度信息', - ], - 'ListTagResources' => [ - 'summary' => '查询可见的资源标签关系。', - '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' => '消息发送验证', + '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' => '华东5（南京-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-nanjing.aliyuncs.com', 'endpoint' => 'rocketmq.cn-nanjing.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'rocketmq.cn-wulanchabu.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-beijing.aliyuncs.com', 'endpoint' => 'rocketmq.cn-beijing.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhengzhou-jva', 'regionName' => '郑州（联通合营）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-qingdao.aliyuncs.com', 'endpoint' => 'rocketmq.cn-qingdao.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-shanghai.aliyuncs.com', 'endpoint' => 'rocketmq.cn-shanghai.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-hongkong.aliyuncs.com', 'endpoint' => 'rocketmq.cn-hongkong.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => '华南2（河源）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-heyuan.aliyuncs.com', 'endpoint' => 'rocketmq.cn-heyuan.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-heyuan.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'rocketmq.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-shenzhen.aliyuncs.com', 'endpoint' => 'rocketmq.cn-shenzhen.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => '韩国（首尔）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华东6（福州-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-fuzhou.aliyuncs.com', 'endpoint' => 'rocketmq.cn-fuzhou.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-fuzhou.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-chengdu.aliyuncs.com', 'endpoint' => 'rocketmq.cn-chengdu.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-guangzhou.aliyuncs.com ', 'endpoint' => 'rocketmq.cn-guangzhou.aliyuncs.com ', 'vpc' => 'rocketmq-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-huhehaote.aliyuncs.com', 'endpoint' => 'rocketmq.cn-huhehaote.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '菲律宾（马尼拉）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '泰国（曼谷）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'rocketmq.cn-hangzhou.aliyuncs.com', 'endpoint' => 'rocketmq.cn-hangzhou.aliyuncs.com', 'vpc' => 'rocketmq-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', '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' => '沙特（利雅得）', 'areaId' => 'middleEast', 'areaName' => '中东', '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' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => 'Ability已存在'], + ['code' => 'Ability.NotFound', 'message' => 'The ability cannot be found.', 'http_code' => 404, 'description' => 'Ability不存在'], + ['code' => 'AbilityStatus.NotPending', 'message' => 'The ability has yet to take effect.', 'http_code' => 400, 'description' => 'Ability不是待生效状态'], + ['code' => 'AsyncTask.Ignored', 'message' => 'The asynchronous task ignored.', 'http_code' => 400, 'description' => '异步任务忽略执行'], + ['code' => 'AsyncTask.InOrder', 'message' => 'The asynchronous task appending.', 'http_code' => 400, 'description' => '异步任务排队中'], + ['code' => 'AsyncTask.NotCompleted', 'message' => 'The asynchronous task not complete yet.', 'http_code' => 400, 'description' => '异步任务未完成'], + ['code' => 'AsyncTask.NotFound', 'message' => 'The asynchronous task does not exist.', 'http_code' => 404, 'description' => '异步任务不存在'], + ['code' => 'AsyncTaskGroup.NotFound', 'message' => 'The asynchronous task group does not exist.', 'http_code' => 404, 'description' => '异步任务分组不存在'], + ['code' => 'AsyncTaskHandler.NotFound', 'message' => 'The asynchronous task executor does not exist.', 'http_code' => 404, 'description' => '异步任务执行器不存在'], + ['code' => 'AsyncTaskSlave.NotCompleted', 'message' => 'The asynchronous sub task not complete yet.', 'http_code' => 400, 'description' => '异步任务子任务未完成'], + ['code' => 'AsyncTaskType.NotFound', 'message' => 'The asynchronous task type does not exist.', 'http_code' => 404, 'description' => '异步任务类型不存在'], + ['code' => 'Commodity.Existed', 'message' => 'The commodity already exists.', 'http_code' => 400, 'description' => '商品已存在'], + ['code' => 'Commodity.NotFound', 'message' => 'The commodity cannot be found.', 'http_code' => 404, 'description' => '商品不存在'], + ['code' => 'CommodityStatus.NotPending', 'message' => 'The commodity is not pending.', 'http_code' => 400, 'description' => '商品不是待生效状态'], + ['code' => 'CommodityStatus.NotValid', 'message' => 'The commodity has yet to take effect.', 'http_code' => 400, 'description' => '商品未生效'], + ['code' => 'ConsumerGroup.Existed', 'message' => 'The consumerGroup already exists.', 'http_code' => 400, 'description' => 'Group已经创建'], + ['code' => 'ConsumerGroup.NotFound', 'message' => 'The consumerGroup cannot be found.', 'http_code' => 404, 'description' => 'Group不存在'], + ['code' => 'ConsumerGroupCount.Limited', 'message' => 'The group quantity over limit', 'http_code' => 400, 'description' => 'Group数量超出容量'], + ['code' => 'ConsumerGroupStatus.NotRunning', 'message' => 'The consumerGroup is not running.', 'http_code' => 400, 'description' => 'Group状态不在运行中'], + ['code' => 'DateFormatError', 'message' => 'The date format error.', 'http_code' => 400, 'description' => '时间转换异常'], + ['code' => 'DisasterRecoveryActiveTopic.Duplicated', 'message' => 'In the disaster recovery plan items, the topics in the source cluster cannot be duplicated.', 'http_code' => 400, 'description' => '备份计划条例中，源集群的Topic不能重复。'], + ['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' => '备份计划实例信息，如果网络选择公网，则不支持私有IP。'], + ['code' => 'DisasterRecoveryInstanceSeriesType.NotSupport', 'message' => 'The primary family of the instance in the backup plan does not support.', 'http_code' => 400, 'description' => '备份计划中实例的主系列不支持'], + ['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' => '备份计划条例中，Topic不能重复。'], + ['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' => '不同备份计划中，同实例的过滤条件Key必须保持一致。'], + ['code' => 'DisasterRecoveryMessagePropertyKey.NotMatch', 'message' => 'In the disaster recovery plan, the message property key for different instances must be consistent.', 'http_code' => 400, 'description' => '备份计划中，不同实例的过滤条件Key必须保持一致。'], + ['code' => 'DisasterRecoveryMessagePropertyValue.NOT_SAME', 'message' => 'The filter value cannot be consistent between instances in the backup plan.', 'http_code' => 400, 'description' => '备份计划不同实例之间过滤条件Value不能一致'], + ['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' => '备份计划中的实例所在区域不支持。'], + ['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' => '备份条例中的Topic数量有且仅有2个。'], + ['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' => '根据Topic名称生成的消费者组过长，不支持创建备份任务。'], + ['code' => 'EntityNotExist.Role', 'message' => 'The role does not exist.', 'http_code' => 400, 'description' => '该角色不存在'], + ['code' => 'GroupName.canSystemReserved', 'message' => 'The group name has been reserved by the system.', 'http_code' => 400, 'description' => 'Group名称已被系统预定'], + ['code' => 'Instance.Existed', 'message' => 'The instance already exists.', 'http_code' => 400, 'description' => 'Instance已存在'], + ['code' => 'Instance.NotFound', 'message' => 'The instance cannot be found.', 'http_code' => 404, 'description' => 'Instance不存在'], + ['code' => 'InstanceApacheAcl.NotSupport', 'message' => 'instance does not support acl identification.', 'http_code' => 400, 'description' => '实例不支持acl身份识别'], + ['code' => 'InstanceEndpoint.NotExist', 'message' => 'The instanceEndpoint does not exist.', 'http_code' => 404, 'description' => '实例接入点不存在'], + ['code' => 'InstanceId.NotNull', 'message' => 'The instanceId is mandatory for this action.', 'http_code' => 400, 'description' => '实例ID不能为空'], + ['code' => 'InstanceRelease.NotSupport', 'message' => 'The current instance type does not support the release operation', 'http_code' => 400, 'description' => '实例释放不支持'], + ['code' => 'InstanceStatus.NotAllowed', 'message' => 'The operation is forbidden for current instance states.', 'http_code' => 400, 'description' => '实例当前状态不允许变更'], + ['code' => 'InstanceStatus.NotRunning', 'message' => 'The instance is not running.', 'http_code' => 400, 'description' => 'Instance状态不在运行中'], + ['code' => 'InstanceStatus.Released', 'message' => 'The instance already released.', 'http_code' => 400, 'description' => 'Instance状态已释放'], + ['code' => 'InstanceStatus.Stopped', 'message' => 'The instance already stopped.', 'http_code' => 400, 'description' => 'Instance状态已停服'], + ['code' => 'InstanceUser.NotBelong', 'message' => 'The instance does not belong to the current user', 'http_code' => 403, 'description' => '实例不归属当前用户'], + ['code' => 'InternalError', 'message' => 'An error occurred while processing your request. Please submit the work order.', 'http_code' => 500, 'description' => '系统异常，请提交工单'], + ['code' => 'Invalid%s', 'message' => 'Parameter %s is invalid.', 'http_code' => 400, 'description' => '参数%s非法'], + ['code' => 'Invalid%s.Format', 'message' => 'Parameter format %s is invalid.', 'http_code' => 400, 'description' => '参数%s格式非法'], + ['code' => 'Invalid%s.Length', 'message' => 'Parameter length %s is invalid.', 'http_code' => 400, 'description' => '参数%s长度非法'], + ['code' => 'Invalid%s.Range', 'message' => 'Parameter range %s is invalid.', 'http_code' => 400, 'description' => '参数%s范围非法'], + ['code' => 'MessageSendTopic.NotSupport', 'message' => 'The current messageType is not supported.', 'http_code' => 400, 'description' => '消息发送不支持该Topic类型'], + ['code' => 'MeterRecord.Existed', 'message' => 'The meterRecord already exists.', 'http_code' => 400, 'description' => 'MeterRecord已存在'], + ['code' => 'MigrationRegion.NotSupport', 'message' => 'The region does not support migration.', 'http_code' => 400, 'description' => '该地域不支持迁移'], + ['code' => 'MigrationStatus.Error', 'message' => 'Migration status is abnormal.', 'http_code' => 400, 'description' => '迁移状态异常'], + ['code' => 'Missing%s', 'message' => 'Parameter %s is mandatory for this action .', 'http_code' => 400, 'description' => '参数%s缺失'], + ['code' => 'NoPermission', 'message' => 'Permission denied', 'http_code' => 403, 'description' => '没有权限'], + ['code' => 'Order.Existed', 'message' => 'The order already exists.', 'http_code' => 400, 'description' => 'Order已存在'], + ['code' => 'Order.NotFound', 'message' => 'The order cannot be found.', 'http_code' => 404, 'description' => 'Order找不到'], + ['code' => 'OrderType.NotSupport', 'message' => 'The order type not supported.', 'http_code' => 400, 'description' => '订单类型不支持'], + ['code' => 'ProxyAccount.NotSupport', 'message' => 'Proxy account not supported.', 'http_code' => 400, 'description' => '代理账号不支持'], + ['code' => 'RamResourceError', 'message' => 'The ram resource error.', 'http_code' => 400, 'description' => 'ram资源异常'], + ['code' => 'RemoteCallError', 'message' => 'An internal service invocation error occurred while processing your request. Please try again later.', 'http_code' => 500, 'description' => '内部服务调用错误，请稍后重试'], + ['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' => '请求冲突，当前资源存在其他请求或系统任务的并发修改，请稍后重试。'], + ['code' => 'Resource.NotFound', 'message' => 'The resource is not found.', 'http_code' => 404, 'description' => '资源不存在。'], + ['code' => 'ResourceGroup.CheckFailed', 'message' => 'Failed to check the resource group.', 'http_code' => 400, 'description' => '资源组检查失败'], + ['code' => 'ResourceGroup.UpdateError', 'message' => 'Failed to update the resource group.', 'http_code' => 400, 'description' => '资源组更新失败'], + ['code' => 'ResourceTagService.Error', 'message' => 'Failed to manipulate the resource tag.', 'http_code' => 400, 'description' => '操作资源标签失败'], + ['code' => 'Service.Existed', 'message' => 'The service already exists.', 'http_code' => 400, 'description' => 'Service已存在'], + ['code' => 'Service.NotFound', 'message' => 'The service cannot be found.', 'http_code' => 404, 'description' => 'Service不存在'], + ['code' => 'ServiceMsgProcessSpec.NotFound', 'message' => 'The message process spec cannot be found.', 'http_code' => 404, 'description' => '服务消息收发计算规格不存在'], + ['code' => 'ServiceSeries.Existed', 'message' => 'The serviceSeries already exists.', 'http_code' => 400, 'description' => 'ServiceSeries已存在'], + ['code' => 'ServiceSeries.NotFound', 'message' => 'The serviceSeries cannot be found.', 'http_code' => 404, 'description' => 'ServiceSeries不存在'], + ['code' => 'ServiceSeries.NotNull', 'message' => 'The serviceSeries is mandatory for this action.', 'http_code' => 400, 'description' => '服务系列不能为空'], + ['code' => 'ServiceSeriesStatus.NotPending', 'message' => 'The serviceSeries is not pending.', 'http_code' => 400, 'description' => 'ServiceSeries不是待生效状态'], + ['code' => 'ServiceSeriesStatus.NotValid', 'message' => 'The serviceSeries does not take effect.', 'http_code' => 400, 'description' => '服务系列未生效'], + ['code' => 'StsCertificate.NotNull', 'message' => 'The sts certificate is mandatory for this action.', 'http_code' => 400, 'description' => 'STS证书不能为空'], + ['code' => 'Topic.Existed', 'message' => 'The topic already exists.', 'http_code' => 400, 'description' => 'Topic已经创建'], + ['code' => 'Topic.NotFound', 'message' => 'The topic cannot be found.', 'http_code' => 404, 'description' => 'Topic不存在'], + ['code' => 'TopicCount.Limited', 'message' => 'The topic quantity over limit', 'http_code' => 400, 'description' => 'Topic数量超出容量'], + ['code' => 'TopicName.NotStandard', 'message' => 'The topic name is invalid.', 'http_code' => 400, 'description' => 'Topic名称非标'], + ['code' => 'TopicName.System', 'message' => 'The topic name has been reserved by the system.', 'http_code' => 400, 'description' => 'Topic名称已被系统预定'], + ['code' => 'TopicStatus.notRunning', 'message' => 'The topic is not running.', 'http_code' => 400, 'description' => 'Topic状态不在运行中'], + ['code' => 'TraceRecord.Existed', 'message' => 'The trace record already exists.', 'http_code' => 400, 'description' => 'TraceRecord已经创建'], + ['code' => 'TraceRecord.NotFound', 'message' => 'The trace record cannot be found.', 'http_code' => 404, 'description' => 'TraceRecord不存在'], + ['code' => 'TraceResult.Existed', 'message' => 'The trace result is already created.', 'http_code' => 400, 'description' => 'TraceResult已经创建'], + ['code' => 'TraceResult.notFound', 'message' => 'The trace result cannot be found.', 'http_code' => 404, 'description' => 'TraceResult不存在'], + ['code' => 'Unauthorized', 'message' => 'not authorized.', 'http_code' => 400, 'description' => '未授权'], + ], + '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' => '云消息队列 RocketMQ 版', + 'ramCodes' => ['rocketmq'], + 'ramLevel' => '资源级', + 'ramConditions' => [ + [ + 'name' => 'rocketmq:InternetSpec', + 'schema' => [ + 'type' => 'String', + 'description' => '是否支持公网', + 'enums' => ['enable', 'disable'], + ], ], - 'parameters' => [ - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域ID。', - 'description' => '地域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' => '资源类型。', - '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' => '资源ID列表，JSON格式。', - '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' => '标签列表，JSON格式。', - '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' => '下一个查询开始的位置。', - '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' => '资源组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' => '请求ID', - 'type' => 'string', - 'example' => 'F00C6A70-C782-5DD6-9D11-0CFC710100C7', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'object', - 'properties' => [ - 'nextToken' => [ - 'description' => '下一个查询开始的位置。', - 'type' => 'string', - 'example' => 'd09e2b63e1b12d905b7080ff70', - ], - 'requestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F00C6A70-C782-5DD6-9D11-0CFC710100C7', - ], - 'tagResources' => [ - 'description' => '资源标签关系。', - 'type' => 'array', - 'items' => [ - 'description' => '资源标签关系。', - 'type' => 'object', - 'properties' => [ - 'resourceType' => [ - 'description' => '资源类型。', - 'type' => 'string', - 'example' => 'instance', - ], - 'tagValue' => [ - 'description' => '标签的值。', - 'type' => 'string', - 'example' => 'value', - ], - 'resourceId' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'rmq-cn-pe334n08h08', - ], - 'tagKey' => [ - 'description' => '标签的键。', - 'type' => 'string', - 'example' => 'key', - ], - 'category' => [ - 'description' => '标签类型。', - 'type' => 'string', - 'example' => 'custom', - ], - 'scope' => [ - 'description' => '可见范围。', - 'type' => 'string', - 'example' => 'public', - ], - 'aliUid' => [ - 'description' => '资源归属uid。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1876441048322426', - ], - ], - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The topic already exists.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - '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' => '查询资源标签关系', - ], - 'TagResources' => [ - 'summary' => '用户创建标签资源关系。', - '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' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'CreateInstanceIpWhitelist', + 'description' => '创建IP白名单', + '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' => '资源类型。', - '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' => '资源ID列表，JSON格式。', - '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' => '标签列表，JSON格式。', - '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' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '0B962390-D84B-5D44-8C11-79DF40299D41', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - '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' => '创建标签资源关系', - ], - 'UntagResources' => [ - 'summary' => '用户删除标签资源关系。', - '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' => '查询Topic可重置时间范围', + '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' => '全部资源', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域ID。', - 'description' => '地域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' => '资源类型。', - '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' => '资源ID列表，JSON格式。', - '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' => '标签键列表，JSON格式。', - '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' => '是否删除所有标签。', - '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' => '请求ID', - 'type' => 'string', - 'example' => 'A07B41BD-6DD3-5349-9E76-00303DF04BBE', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter deliveryOrderType is invalid.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - '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' => '删除标签资源关系', - ], - 'ChangeResourceGroup' => [ - 'summary' => '修改实例所属的资源组。', - 'path' => '/resourceGroup/change', - 'methods' => [ - 'post', + [ + 'apiName' => 'ListTagResources', + 'description' => '查询资源标签关系', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'rocketmq:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => '全部资源', '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' => '查询IP白名单详情', + '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' => '全部资源', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'resourceId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源ID，即云消息队列 RocketMQ 版实例的ID。表示需要为哪个实例修改所属的资源组。', - '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' => '实例所属的地域ID。', - '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' => '资源类型。'."\n" - ."\n" - .'该参数固定取值为**instance**，表述资源的类型为实例。', - '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' => '资源组ID，表示需要将指定实例转入到哪个资源组下。'."\n" - ."\n" - .'您可以通过<props="china">[ListResourceGroups](https://help.aliyun.com/document_detail/158855.html)</props><props="intl">[ListResourceGroups](https://www.alibabacloud.com/help/resource-management/latest/listresourcegroups)</props>接口查询已有资源组。', - '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' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID，每个请求ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'description' => '返回结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Instance.NotFound', - ], - 'message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'The instance cannot be found.', - ], - 'httpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'dynamicCode' => [ - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'description' => '动态错误信息。', - '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' => '修改资源组', - ], - 'GetConsumeTimespan' => [ - 'summary' => '查询topic可重置时间范围', - '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' => '实例的ID。', - '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' => '消费者分组ID。', - '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' => '请求ID，每个请求的ID都是唯一的，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80', - ], - 'success' => [ - 'description' => '执行结果是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'description' => '返回结果', - 'type' => 'object', - 'properties' => [ - 'instanceId' => [ - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'rmq-cn-7e22ody****', - ], - 'topicName' => [ - 'description' => '指定消费者分组订阅的主题。', - 'type' => 'string', - 'example' => 'topic_test', - ], - 'consumerGroupId' => [ - 'description' => '消费者分组的ID。', - 'type' => 'string', - 'example' => 'CID-TEST', - ], - 'minTimestamp' => [ - 'description' => '整个 Topic 目前最早存储的消息的生产时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026222', - ], - 'maxTimestamp' => [ - 'description' => '整个 Topic 目前最新存储的消息的生产时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026833', - ], - 'consumeTimestamp' => [ - 'description' => '当前 Group 消费该 Topic 的最新时间。', - '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' => 'HTTP状态码', - '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' => '查询Topic可重置时间范围', - ], - 'ListRegions' => [ - 'summary' => '查询地域列表。', - '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' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListInstanceIpWhitelist', + 'description' => '查询IP白名单列表', '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<RegionDTO>>', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '0B962390-D84B-5D44-8C11-79DF40299D41', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'array', - 'items' => [ - 'description' => '区域列表。', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'title' => 'regionId,类似 cn-hangzhou', - 'description' => 'regionId,类似 cn-hangzhou', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'regionName' => [ - 'title' => '中文region，类似杭州', - 'description' => '中文region，类似杭州', - 'type' => 'string', - 'example' => '杭州', - ], - 'supportRocketmqV5' => [ - 'title' => '是否开通新服 v5版本', - 'description' => '是否开通新服 v5版本', - 'type' => 'boolean', - 'example' => 'true', - ], - 'supportRocketmqV4' => [ - 'title' => '是否开通旧服 v4版本', - 'description' => '是否开通旧服 v4版本', - 'type' => 'boolean', - 'example' => 'true', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '修改时间', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'tags' => [ - 'description' => '地域标签。', - 'type' => 'array', - 'items' => [ - 'description' => '地域标签。', - 'type' => 'object', - 'properties' => [ - 'tagCode' => [ - 'description' => '标签Code。', - 'type' => 'string', - 'example' => 'xx', - ], - 'tagValue' => [ - 'description' => '标签的值。', - 'type' => 'any', - 'example' => 'xx', - ], - ], - ], - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MissingPageNumber', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'ConsumerGroupId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - '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' => '查询地域列表', - ], - 'ListAvailableZones' => [ - 'summary' => '查询支持的可用区。', - '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' => '请求ID', - 'type' => 'string', - 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - 'type' => 'array', - 'items' => [ - 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'zoneId' => [ - 'title' => '可用区id', - 'description' => '可用区id', - 'type' => 'string', - 'example' => 'cn-qingdao-b', - ], - 'zoneName' => [ - 'title' => '可用区名称', - 'description' => '可用区名称', - 'type' => 'string', - 'example' => 'ha-cn-t9b30w902vm_qrs', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - 'updateTime' => [ - 'title' => '修改时间', - 'description' => '修改时间', - 'type' => 'string', - 'example' => '2022-08-01 20:05:50', - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'Parameter instanceId is mandatory for this action .', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - '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' => '查询支持的可用区', - ], - 'ListMetricMeta' => [ - 'summary' => '查询监控项列表。', - 'path' => '/monitor/metrics/meta', - 'methods' => [ - 'get', + [ + 'apiName' => 'UntagResources', + 'description' => '删除标签资源关系', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'rocketmq:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => '全部资源', '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' => '分页页码，查询第几页的返回结果。', - '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' => '分页大小，每页做多显示的返回结果数量。', - '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' => '请求ID', - 'type' => 'string', - 'example' => '8B459455-4A35-5796-BA9D-98EF1AB9A931', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'data' => [ - 'title' => '返回结果', - 'description' => '返回结果', - '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' => '分页数据', - 'type' => 'array', - 'items' => [ - 'description' => '监控项列表。', - 'type' => 'object', - 'properties' => [ - 'metricName' => [ - 'title' => '监控项名称', - 'description' => '监控项名称', - 'type' => 'string', - 'example' => 'SendMessageCountPerInstance', - ], - 'description' => [ - 'title' => '监控项描述', - 'description' => '监控项描述', - 'type' => 'string', - 'example' => 'Using Serverless Devs to deploy the infrastructure of project:get-userinfo-v1-infrastructure-as-template-project', - ], - 'category' => [ - 'title' => '监控项标签', - 'description' => '监控项标签', - 'type' => 'string', - 'example' => 'Bug', - ], - ], - ], - ], - ], - ], - 'code' => [ - 'title' => '错误码', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'Topic.NotFound', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'The topic already exists.', - ], - 'httpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'dynamicCode' => [ - 'title' => '动态错误码', - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'InstanceId', - ], - 'dynamicMessage' => [ - 'title' => '动态错误信息', - 'description' => '动态错误信息', - 'type' => 'string', - 'example' => 'instanceId', - ], - ], + [ + 'apiName' => 'ListMetricMeta', + 'description' => '查询监控项列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'rocketmq:ListMetricMeta', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RocketMQ', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteInstanceIpWhitelist', + 'description' => '删除IP白名单', + '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' => '查询监控项列表', - ], - ], - '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/*'], ], ], ]; |