diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/rocketmq/2022-08-01 | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/rocketmq/2022-08-01')
| -rw-r--r-- | data/en_us/rocketmq/2022-08-01/api-docs.php | 15144 |
1 files changed, 15144 insertions, 0 deletions
diff --git a/data/en_us/rocketmq/2022-08-01/api-docs.php b/data/en_us/rocketmq/2022-08-01/api-docs.php new file mode 100644 index 0000000..c1e6ab3 --- /dev/null +++ b/data/en_us/rocketmq/2022-08-01/api-docs.php @@ -0,0 +1,15144 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'RocketMQ', + 'version' => '2022-08-01', + ], + 'directories' => [ + [ + 'id' => 322709, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateInstance', + 'UpdateInstance', + 'DeleteInstance', + 'ListInstances', + 'GetInstance', + ], + ], + [ + 'id' => 322715, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateTopic', + 'UpdateTopic', + 'DeleteTopic', + 'ListTopics', + 'GetTopic', + ], + ], + [ + 'id' => 322721, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateConsumerGroup', + 'UpdateConsumerGroup', + 'DeleteConsumerGroup', + 'ListConsumerGroups', + 'GetConsumerGroup', + ], + ], + [ + 'id' => 322727, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListTopicSubscriptions', + 'ListConsumerGroupSubscriptions', + 'GetConsumerGroupSubscription', + 'DeleteConsumerGroupSubscription', + ], + ], + [ + 'id' => 322732, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListConsumerConnections', + 'GetConsumerGroupLag', + 'GetConsumerStack', + 'ResetConsumeOffset', + ], + ], + [ + 'id' => 322737, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListMessages', + 'GetMessageDetail', + 'VerifySendMessage', + 'VerifyConsumeMessage', + ], + ], + [ + 'id' => 322742, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListTraces', + 'GetTrace', + ], + ], + [ + 'id' => 322745, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateInstanceAccount', + 'UpdateInstanceAccount', + 'DeleteInstanceAccount', + 'ListInstanceAccount', + 'GetInstanceAccount', + 'CreateInstanceAcl', + 'UpdateInstanceAcl', + 'DeleteInstanceAcl', + 'ListInstanceAcl', + 'GetInstanceAcl', + 'CreateInstanceIpWhitelist', + 'DeleteInstanceIpWhitelist', + 'ListInstanceIpWhitelist', + 'GetInstanceIpWhitelist', + ], + ], + [ + 'id' => 322760, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListMigrations', + 'ListMigrationOperations', + 'ExecuteMigrationOperation', + 'FinishMigrationStage', + ], + ], + [ + 'id' => 322765, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDisasterRecoveryPlan', + 'DeleteDisasterRecoveryPlan', + 'UpdateDisasterRecoveryPlan', + 'ListDisasterRecoveryPlans', + 'GetDisasterRecoveryPlan', + 'AddDisasterRecoveryItem', + 'UpdateDisasterRecoveryItem', + 'DeleteDisasterRecoveryItem', + 'StartDisasterRecoveryItem', + 'StopDisasterRecoveryItem', + 'ListDisasterRecoveryItems', + 'GetDisasterRecoveryItem', + 'ListDisasterRecoveryCheckpoints', + 'SyncDisasterRecoveryCheckpoint', + ], + ], + [ + 'id' => 322780, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListTagResources', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 322784, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ChangeResourceGroup', + ], + ], + [ + 'id' => 322786, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetConsumeTimespan', + 'ListRegions', + 'ListAvailableZones', + 'ListMetricMeta', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateInstance' => [ + 'summary' => 'Creates an ApsaraMQ for RocketMQ 5.x instance.', + 'path' => '/instances', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '145030', + 'abilityTreeNodes' => [ + 'FEATUREonsWNMPZ3', + ], + ], + 'parameters' => [ + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value of this parameter, but you must ensure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c2c5d1274a8d4317a13bc5b0d4******', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceName' => [ + 'title' => '实例名称', + 'description' => 'The name of the instance that you want to create.'."\n" + ."\n" + .'If you leave this parameter empty, the instance ID is used as the instance name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rmq-cn-72u3048uxxx', + ], + 'serviceCode' => [ + 'title' => '服务编码', + 'description' => 'The code of the service to which the instance belongs. The service code of ApsaraMQ for RocketMQ is rmq.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq', + 'default' => 'rmq', + ], + 'seriesCode' => [ + 'title' => '系列编码', + 'description' => 'The primary edition of the instance. For information about the differences among primary edition instances, see [Instance selection](~~444722~~).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* standard: Standard Edition'."\n" + .'* ultimate: Enterprise Platinum Edition'."\n" + .'* professional: Professional Edition'."\n" + ."\n" + .'> After you create an instance, you can only upgrade the primary edition of the instance. The following editions are sorted in ascending order: Standard Edition, Professional Edition, Enterprise Platinum Edition. For example, you can upgrade an instance from Standard Edition to Professional Edition, but you cannot downgrade an instance from Professional Edition to Standard Edition.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'standard' => '', + 'ultimate' => '', + 'professional' => '', + ], + 'example' => 'standard', + ], + 'subSeriesCode' => [ + 'title' => '子系列编码', + 'description' => 'The sub-category edition of the instance. For information about the differences among sub-category edition instances, see [Instance selection](~~444722~~).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* cluster_ha: Cluster High-availability Edition'."\n" + .'* single_node: Standalone Edition'."\n" + .'* serverless: serverless'."\n" + ."\n" + .'If you set seriesCode to ultimate, you can set this parameter only to cluster_ha.'."\n" + ."\n" + .'> After you create an instance, you cannot change the sub-category edition of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* serverless: serverless'."\n" + .'* cluster_ha: Cluster High-availability Edition'."\n" + .'* single_node: Standalone Edition'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'serverless' => '', + 'cluster_ha' => 'cluster_ha', + 'single_node' => 'single_node', + ], + 'example' => 'cluster_ha', + ], + 'paymentType' => [ + 'title' => '付费类型,'."\n" + .'预付费：Subscription'."\n" + .'后付费：PayAsYouGo', + 'description' => 'The billing method of the instance. ApsaraMQ for RocketMQ supports the subscription and pay-as-you-go billing methods.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PayAsYouGo: This billing method allows you to use resources before you pay for the resources.'."\n" + .'* Subscription: This billing method allows you to use resources after you pay for the resources.'."\n" + ."\n" + .'For more information, see [Billing methods](~~427234~~).'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'PayAsYouGo' => '', + 'Subscription' => '', + ], + 'example' => 'Subscription', + 'enum' => [ + 'Subscription', + 'PayAsYouGo', + ], + ], + 'period' => [ + 'title' => '购买时长，只有预付费支持', + 'description' => 'The subscription duration of the instance. This parameter takes effect only if you set paymentType to Subscription.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Monthly subscription: 1, 2, 3, 4, 5, and 6'."\n" + .'* Yearly subscription: 1, 2, and 3'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'periodUnit' => [ + 'title' => '购买时长单位，只有预付费支持'."\n" + .'月：Month'."\n" + .'年：Year', + 'description' => 'The unit of the subscription duration.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Month'."\n" + .'* Year'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Month' => '', + 'Year' => '', + ], + 'example' => 'Month', + 'enum' => [ + 'Month', + 'Year', + ], + ], + 'autoRenew' => [ + 'title' => '是否自动续费，只有预付费支持', + 'description' => 'Specifies whether to enable auto-renewal for the instance. This parameter takes effect only if you set paymentType to Subscription. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'autoRenewPeriod' => [ + 'title' => '自动续费周期，只有预付费支持', + 'description' => 'The auto-renewal cycle of the instance. This parameter takes effect only if you set autoRenew to true. Unit: months.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Monthly renewal: 1, 2, 3, 6, and 12'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'remark' => [ + 'title' => '备注信息', + 'description' => 'The instance description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is the remark for test.', + ], + 'productInfo' => [ + 'title' => '产品信息', + 'description' => 'The information about instance specifications.'."\n", + 'type' => 'object', + 'properties' => [ + 'msgProcessSpec' => [ + 'title' => '消息收发规格', + 'description' => 'The computing specification that specifies the messaging transactions per second (TPS) of the instance. For more information, see [Instance editions](~~444715~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rmq.s2.2xlarge', + ], + 'sendReceiveRatio' => [ + 'title' => '消息收发比例', + 'description' => 'The ratio of the message sending TPS to the messaging TPS of the instance.'."\n" + ."\n" + .'For example, if the maximum messaging TPS of an instance is 1,000 and the ratio of the message sending TPS to the messaging TPS of the instance is 0.8, the maximum message sending TPS of the instance is 800 and the maximum message receiving TPS is 200.'."\n" + ."\n" + .'Valid values: 0 to 1. Default value: 0.5.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.5', + ], + 'autoScaling' => [ + 'title' => '是否开启弹性伸缩', + 'description' => 'Specifies whether to enable the elastic TPS feature for the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'After you enable the elastic TPS feature for an ApsaraMQ for RocketMQ instance, you can use a specific amount of TPS that exceeds the specification limit. You are charged for the elastic TPS feature. For more information, see [Computing fees](~~427237~~).'."\n" + ."\n" + .'> The elastic TPS feature is supported only by instances of specific editions. For more information, see [Instance editions](~~444715~~).'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'messageRetentionTime' => [ + 'title' => '消息保留时长', + 'description' => 'The retention period of messages. Unit: hours.'."\n" + ."\n" + .'For information about the valid values of this parameter, see the "Limits on resource quotas" section of the [Limits](~~440347~~) topic.'."\n" + ."\n" + .'ApsaraMQ for RocketMQ supports serverless scaling of message storage. You are charged storage fees based on your actual storage usage. You can change the retention period of messages to manage storage capacity. For more information, see [Storage fees](~~427238~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '72', + ], + 'storageEncryption' => [ + 'title' => '是否开启存储加密', + 'description' => 'Specifies whether to enable the encryption at rest feature.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'storageSecretKey' => [ + 'title' => '存储加密密钥Key', + 'description' => 'The key for encryption at rest.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'capacityType' => [ + 'title' => '容量模式。provisioned：预留+弹性；onDemand：按量付费', + 'type' => 'string', + 'enum' => [ + 'provisioned', + 'ondemand', + ], + ], + 'provisionedCapacity' => [ + 'title' => '预留容量', + 'type' => 'integer', + 'format' => 'int64', + ], + 'traceOn' => [ + 'title' => '是否开启消息轨迹功能。'."\n" + ."\n" + .'true：开启消息轨迹功能'."\n" + .'false：关闭消息轨迹功能'."\n" + .'该参数仅对 Serverless 类型的实例生效，若开启消息轨迹功能，会产生相关的消息轨迹费用，具体计费信息，请参见 Serverless 计费说明。 对于按量付费和包年包月实例，该参数不生效，即不管参数是否开启，都默认支持消息轨迹功能。', + 'type' => 'boolean', + ], + ], + 'required' => false, + ], + 'networkInfo' => [ + 'title' => '网络信息', + 'description' => 'The information about the network.'."\n", + 'type' => 'object', + 'properties' => [ + 'vpcInfo' => [ + 'title' => '专有网络信息', + 'description' => 'The virtual private cloud (VPC)-related configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'vpcId' => [ + 'title' => '专有网络ID', + 'description' => 'The ID of the VPC with which the instance to be created is associated.'."\n" + ."\n" + .'> After you create an ApsaraMQ for RocketMQ instance, you cannot change the VPC with which the instance is associated. If you want to change the VPC with which the instance is associated, you must release the instance and create a new instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-wz9qt50xhtj9krb******', + ], + 'vSwitchId' => [ + 'title' => '交换机ID', + 'description' => 'The ID of the vSwitch with which the instance is associated. If you want to specify multiple vSwitches, separate the vSwitches with vertical bars (|).'."\n" + ."\n" + .'> After you create an ApsaraMQ for RocketMQ instance, you cannot change the vSwitch with which the instance is associated. If you want to change the vSwitch with which the instance is associated, you must release the instance and purchase a new instance.'."\n" + ."\n" + .'> We recommend that you configure vSwitches instead of this parameter.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'vsw-uf6gwtbn6etadpv*******', + ], + 'securityGroupIds' => [ + 'description' => 'The ID of the security group to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp17hpmgz96tvnsdy6so', + ], + 'vSwitches' => [ + 'description' => 'The vSwitches.'."\n" + ."\n" + .'> After you create an ApsaraMQ for RocketMQ instance, you cannot change the vSwitch with which the instance is associated. If you want to change the vSwitch with which the instance is associated, you must release the instance and purchase a new instance.'."\n" + ."\n" + .'> This parameter is required. We recommend that you configure this parameter instead of vSwitchId.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'vSwitchId' => [ + 'description' => 'The ID of the vSwitch with which the instance is associated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf6gwtbn6etadpv*******', + ], + ], + 'required' => false, + 'description' => 'The vSwitches.', + ], + 'required' => false, + ], + ], + 'required' => true, + ], + 'internetInfo' => [ + 'title' => '公网信息', + 'description' => 'The Internet-related configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'internetSpec' => [ + 'title' => '是否开启公网'."\n" + .'开启：enable'."\n" + .'关闭：disable', + 'description' => 'Specifies whether to enable the Internet access feature.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* enable'."\n" + .'* disable'."\n" + ."\n" + .'By default, ApsaraMQ for RocketMQ allows you to access instances in VPCs. If you enable Internet access for an instance, you can access the instance over the Internet. After you enable this feature, you are charged for outbound Internet traffic. For more information, see [Internet access fees](~~427240~~).'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'enable' => '', + 'disable' => '', + ], + 'example' => 'disable', + ], + 'flowOutType' => [ + 'title' => '公网计费类型'."\n" + .'固定带宽计费：payByBandwidth', + 'description' => 'The metering method of Internet usage.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* payByBandwidth: pay-by-bandwidth. This value is valid only if you enable Internet access.'."\n" + .'* payByTraffic: pay-by-traffic. This value is valid only if you enable Internet access.'."\n" + .'* uninvolved: No metering method is involved. This value is valid only if you disable Internet access.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'payByBandwidth' => 'payByBandwidth', + 'payByTraffic' => '', + 'uninvolved' => 'uninvolved', + ], + 'example' => 'uninvolved', + ], + 'flowOutBandwidth' => [ + 'title' => '公网带宽规格', + 'description' => 'The Internet bandwidth. Unit: MB/s.'."\n" + ."\n" + .'This parameter is required only if you set flowOutType to payByBandwidth.'."\n" + ."\n" + .'Valid values: 1 to 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'ipWhitelist' => [ + 'title' => '公网IP白名单列表', + 'description' => 'The whitelist that includes the CIDR blocks that are allowed to access the ApsaraMQ for RocketMQ broker over the Internet. This parameter can be configured only if you use the public endpoint to access the instance.'."\n" + ."\n" + .'* If you do not configure an IP address whitelist, all CIDR blocks are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n" + .'* If you configure an IP address whitelist, only the CIDR blocks in the whitelist are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '公网IP白名单', + 'description' => 'The CIDR blocks in the whitelist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.x.x/24', + ], + 'deprecated' => true, + 'required' => false, + ], + ], + 'required' => true, + ], + ], + 'required' => true, + ], + 'commodityCode' => [ + 'description' => 'The commodity code. Valid values:'."\n" + ."\n" + .'* ons_rmqpost_public_intl: pay-as-you-go'."\n" + .'* ons_rmqsub_public_intl: subscription'."\n" + .'* ons_rmqsrvlesspost_public_intl: serverless instance'."\n" + .'serverless instance requires this parameter', + 'type' => 'string', + 'required' => false, + 'example' => 'ons_ rmqpost_public_cn', + ], + 'resourceGroupId' => [ + 'title' => '资源组ID', + 'description' => 'The ID of the resource group to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzy6pist7uuna', + ], + 'tags' => [ + 'description' => 'The tags that you want to add to the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags that are used to filter instances.'."\n", + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => 'The `key` of the tag.', + 'type' => 'string', + 'required' => false, + 'example' => 'aaa', + ], + 'value' => [ + 'description' => 'The `value` of the tag.', + 'type' => 'string', + 'required' => false, + 'example' => 'bbb', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'aclInfo' => [ + 'title' => '访问控制信息', + 'type' => 'object', + 'properties' => [ + 'defaultVpcAuthFree' => [ + 'title' => '是否支持vpc免密访问', + 'type' => 'boolean', + ], + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<String>', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The ID of the created instance.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code returned if the call failed.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": \\"rmq-cn-7e22ody****\\",\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"Success\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'CreateInstance', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n", + ], + 'UpdateInstance' => [ + 'summary' => 'Updates the basic information and specifications of an ApsaraMQ for RocketMQ instance.', + 'path' => '/instances/{instanceId}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance whose basic information and specifications you want to update.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceName' => [ + 'title' => '实例名称', + 'description' => 'The updated name of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_instance', + ], + 'remark' => [ + 'title' => '实例备注', + 'description' => 'The updated description of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is the remark for test.', + ], + 'networkInfo' => [ + 'title' => '网络信息', + 'description' => 'The updated network information about the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'internetInfo' => [ + 'title' => '公网信息', + 'description' => 'The information about the Internet over which the instance is accessed. This parameter takes effect only if the Internet access feature is enabled for the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'ipWhitelist' => [ + 'title' => '公网IP白名单列表', + 'description' => 'The whitelist that includes the IP addresses that are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n" + ."\n" + .'* If you do not configure an IP address whitelist, all CIDR blocks are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n" + .'* If you configure an IP address whitelist, only the IP addresses in the whitelist are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '公网IP白名单', + 'description' => 'The IP addresses in the whitlist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.x.x/24', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'productInfo' => [ + 'title' => '扩展配置', + 'description' => 'Additional configurations of the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'sendReceiveRatio' => [ + 'title' => '消息收发比例', + 'description' => 'The ratio of the number of messages that you can send to the number of messages that you can receive on the instance.'."\n" + ."\n" + .'Value values: 0.25 to 1.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.5', + ], + 'autoScaling' => [ + 'title' => '自适应弹性伸缩', + 'description' => 'Specifies whether to enable the elastic transactions per second (TPS) feature for the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'After you enable the elastic TPS feature for an ApsaraMQ for RocketMQ instance, you can use a specific number of TPS that exceeds the specification limit. You are charged for using the elastic TPS feature. For more information, see [Computing fees](~~427237~~).'."\n" + ."\n" + .'> The elastic TPS feature is supported only by specific instance editions. For more information, see [Instance editions](~~444715~~).'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'messageRetentionTime' => [ + 'title' => '消息保留时长', + 'description' => 'The retention period of messages. Unit: hours.'."\n" + ."\n" + .'For information about the valid values of this parameter, see the "Limits on resource quotas" section of the [Limits](~~440347~~) topic.'."\n" + ."\n" + .'ApsaraMQ for RocketMQ supports serverless scaling of message storage. You are charged storage fees based on your actual storage usage. You can change the retention period of messages to manage storage capacity. For more information, see [Storage fees](~~427238~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '72', + ], + 'traceOn' => [ + 'description' => 'Specifies whether to enable the message trace feature.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'This parameter is not in use. By default, the message trace feature is enabled for ApsaraMQ for RocketMQ instances, regardless of whether this parameter is configured.'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'false' => '', + 'true' => '', + ], + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'aclInfo' => [ + 'description' => 'The access control list for the instance.', + 'type' => 'object', + 'properties' => [ + 'aclTypes' => [ + 'description' => 'The authentication type of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The authentication type of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- default: intelligent identity authentication'."\n" + ."\n" + .'- apache_acl:access control list (ACL) identity authentication', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'default' => 'default', + 'apache_acl' => 'apache_acl', + ], + 'example' => 'apache_acl', + ], + 'required' => false, + ], + 'defaultVpcAuthFree' => [ + 'description' => 'Indicates whether the authentication-free in VPCs feature is enabled.'."\n" + .'Indicates whether the authentication-free in VPCs feature is enabled.'."\n" + .'Valid values:'."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'The response object.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.'."\n", + 'type' => 'string', + 'example' => 'AA87DE09-DA44-52F4-9515-78B1B607****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The result data that is returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AA87DE09-DA44-52F4-9515-78B1B607****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'UpdateInstance', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.', + ], + 'DeleteInstance' => [ + 'summary' => 'Releases an instance.', + 'path' => '/instances/{instanceId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The ID of the ApsaraMQ for RocketMQ instance that you want to delete.', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody0129', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '048242AA-BADA-5F29-B2CD-ED9FA344467F', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned result.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code returned if the call failed.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"048242AA-BADA-5F29-B2CD-ED9FA344467F\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'DeleteInstance', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'* After an instance is deleted, the instance cannot be restored. Exercise caution when you call this operation.'."\n" + .'* This operation is used to delete a pay-as-you-go instance. A subscription instance is automatically released after it expires. You do not need to manually delete a subscription instance.'."\n", + ], + 'ListInstances' => [ + 'summary' => 'Queries all ApsaraMQ for RocketMQ instances in a specific region.', + 'path' => '/instances', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '144675', + 'abilityTreeNodes' => [ + 'FEATUREonsICR0M4', + ], + ], + 'parameters' => [ + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => [ + 'title' => '过滤关键字', + 'description' => 'The filter condition that is used to query instances. If you do not configure this parameter, all instances are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码', + 'description' => 'The page number.'."\n" + ."\n" + .'Valid values: 1 to 100000000.'."\n" + ."\n" + .'If you set this parameter to a value smaller than 1, the system uses 1 as the value. If you set this parameter to a value greater than 100000000, the system uses 100000000 as the value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'Value values: 10 to 200.'."\n" + ."\n" + .'If you set this parameter to a value smaller than 10, the system uses 10 as the value. If you set this parameter to a value greater than 200, the system uses 200 as the value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '10', + 'example' => '10', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组ID', + 'description' => 'The ID of the resource group to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmx7caj******', + ], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tags that are used to filter instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"key": "rmq-test", "value": "test"}]', + ], + ], + [ + 'name' => 'seriesCodes', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => 'The primary edition of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* standard: Standard Edition'."\n" + .'* ultimate: Enterprise Platinum Edition'."\n" + .'* professional: Professional Edition'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The primary edition of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + ], + 'required' => false, + ], + ], + [ + 'name' => 'storageSecretKey', + 'in' => 'query', + 'schema' => [ + 'title' => '存储加密密钥Key', + 'description' => 'The storage encryption key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MyPage<InstanceDTO>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '84445A20-2B50-5306-A3C0-AF99FC1833C6', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'title' => '当前页码', + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页大小', + 'description' => 'The number of entries returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'totalCount' => [ + 'title' => '总记录数', + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'list' => [ + 'title' => '分页数据', + 'description' => 'The pagination information.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '区域ID', + 'description' => 'The ID of the region in which the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'instanceName' => [ + 'title' => '实例名称', + 'description' => 'The instance name.'."\n", + 'type' => 'string', + 'example' => 'test instance', + ], + 'status' => [ + 'title' => '实例状态', + 'description' => 'The status of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* RELEASED'."\n" + .'* RUNNING'."\n" + .'* STOPPED'."\n" + .'* CHANGING'."\n" + .'* CREATING'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'RELEASED' => '', + 'RUNNING' => '', + 'STOPPED' => '', + 'CHANGING' => '', + 'CREATING' => '', + ], + 'example' => 'RUNNING', + 'enum' => [ + 'CREATING', + 'CHANGING', + 'RUNNING', + 'STOPPED', + 'RELEASED', + ], + ], + 'startTime' => [ + 'title' => '开服时间', + 'description' => 'The time when the instance was created.'."\n", + 'type' => 'string', + 'example' => '2022-08-01 00:00:00', + ], + 'expireTime' => [ + 'title' => '过期时间', + 'description' => 'The time when the instance expires.'."\n", + 'type' => 'string', + 'example' => '2022-09-01 00:00:00', + ], + 'releaseTime' => [ + 'title' => '释放时间', + 'description' => 'The time when the instance was released.'."\n", + 'type' => 'string', + 'example' => '2022-09-07 00:00:00', + ], + 'userId' => [ + 'title' => '所属人ID', + 'description' => 'The ID of the user who owns the instance.'."\n", + 'type' => 'string', + 'example' => '6W0xz2uPfiwp****', + ], + 'commodityCode' => [ + 'title' => '商品编码', + 'description' => 'The commodity code of the instance. The commodity code of ApsaraMQ for RocketMQ 5.0 instances has a similar format to ons_rmqsub_public_cn.'."\n", + 'type' => 'string', + 'example' => 'ons_rmqsub_public_cn', + ], + 'serviceCode' => [ + 'title' => '服务编码', + 'description' => 'The code of the service to which the instance belongs. The service code of ApsaraMQ for RocketMQ is rmq.'."\n", + 'type' => 'string', + 'example' => 'rmq', + ], + 'seriesCode' => [ + 'title' => '系列编码', + 'description' => 'The primary edition of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* standard: Standard Edition'."\n" + .'* ultimate: Enterprise Platinum Edition'."\n" + .'* professional: Professional Edition'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'standard' => '', + 'ultimate' => '', + 'professional' => '', + ], + 'example' => 'standard', + ], + 'subSeriesCode' => [ + 'title' => '子系列编码', + 'description' => 'The sub-category edition of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* cluster_ha: Cluster High-availability Edition'."\n" + .'* single_node: Standalone Edition'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'cluster_ha' => '', + 'single_node' => '', + ], + 'example' => 'cluster_ha', + ], + 'paymentType' => [ + 'title' => '付费类型', + 'description' => 'The billing method of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PayAsYouGo'."\n" + .'* Subscription'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'PayAsYouGo' => '', + 'Subscription' => '', + ], + 'example' => 'Subscription', + 'enum' => [ + 'Subscription', + 'PayAsYouGo', + ], + ], + 'remark' => [ + 'title' => '备注', + 'description' => 'The instance description.'."\n", + 'type' => 'string', + 'example' => 'This is remark for instance.', + ], + 'topicCount' => [ + 'title' => '主题数量', + 'description' => 'The number of topics that are created on the instance.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'groupCount' => [ + 'title' => '消费组数量', + 'description' => 'The number of consumer groups that are created on the instance.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the version of the instance was updated.'."\n", + 'type' => 'string', + 'example' => '2022-08-01 00:00:00', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the instance was last modified.'."\n", + 'type' => 'string', + 'example' => '2022-08-02 00:00:00', + ], + 'resourceGroupId' => [ + 'title' => '资源组ID', + 'description' => 'The ID of the resource group to which the instance belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmx7caj******', + ], + 'tags' => [ + 'title' => '资源标签列表。', + 'description' => 'The resource tags.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '资源标签。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '资源标签key值。', + 'description' => 'The tag key of the resource.'."\n", + 'type' => 'string', + 'example' => 'key', + ], + 'value' => [ + 'title' => '资源标签value值。', + 'description' => 'The tag value of the resource.'."\n", + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'productInfo' => [ + 'description' => 'The product information.'."\n", + 'type' => 'object', + 'properties' => [ + 'traceOn' => [ + 'description' => 'Indicates whether the message trace feature is enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'This parameter is not in use. By default, the message trace feature is enabled for ApsaraMQ for RocketMQ instances, regardless of whether this parameter is configured.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'capacityType' => [ + 'type' => 'string', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code returned if the call failed.'."\n", + 'type' => 'string', + 'example' => 'MissingPageNumber', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter pageNumber is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'PageNumber', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'pageNumber', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"84445A20-2B50-5306-A3C0-AF99FC1833C6\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 100,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"instanceName\\": \\"test instance\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"startTime\\": \\"2022-08-01 00:00:00\\",\\n \\"expireTime\\": \\"2022-09-01 00:00:00\\",\\n \\"releaseTime\\": \\"2022-09-07 00:00:00\\",\\n \\"userId\\": \\"6W0xz2uPfiwp****\\",\\n \\"commodityCode\\": \\"ons_rmqsub_public_cn\\",\\n \\"serviceCode\\": \\"rmq\\",\\n \\"seriesCode\\": \\"standard\\",\\n \\"subSeriesCode\\": \\"cluster_ha\\",\\n \\"paymentType\\": \\"Subscription\\",\\n \\"remark\\": \\"This is remark for instance.\\",\\n \\"topicCount\\": 20,\\n \\"groupCount\\": 10,\\n \\"createTime\\": \\"2022-08-01 00:00:00\\",\\n \\"updateTime\\": \\"2022-08-02 00:00:00\\",\\n \\"resourceGroupId\\": \\"rg-acfmx7caj******\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"key\\",\\n \\"value\\": \\"value\\"\\n }\\n ],\\n \\"productInfo\\": {\\n \\"traceOn\\": true,\\n \\"capacityType\\": \\"provisioned\\"\\n }\\n }\\n ]\\n },\\n \\"code\\": \\"MissingPageNumber\\",\\n \\"message\\": \\"Parameter pageNumber is mandatory for this action .\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"PageNumber\\",\\n \\"dynamicMessage\\": \\"pageNumber\\"\\n}","type":"json"}]', + 'title' => 'ListInstances', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n", + ], + 'GetInstance' => [ + 'summary' => 'Queries the detailed information about an instance.', + 'path' => '/instances/{instanceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147017', + 'abilityTreeNodes' => [ + 'FEATUREonsHF2FLP', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<InstanceDTO>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '05AB7FBD-F1D3-5D87-BF78-BD782249****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '区域ID', + 'description' => 'The ID of the region in which the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'instanceName' => [ + 'title' => '实例名称', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'test instance', + ], + 'status' => [ + 'title' => '实例状态', + 'description' => 'The status of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* RELEASED'."\n" + .'* RUNNING'."\n" + .'* STOPPED'."\n" + .'* CHANGING'."\n" + .'* CREATING'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'RELEASED' => '', + 'RUNNING' => '', + 'STOPPED' => '', + 'CHANGING' => '', + 'CREATING' => '', + ], + 'example' => 'RUNNING', + 'enum' => [ + 'CREATING', + 'CHANGING', + 'RUNNING', + 'STOPPED', + 'RELEASED', + ], + ], + 'startTime' => [ + 'title' => '开服时间', + 'description' => 'The time when the instance was started.'."\n", + 'type' => 'string', + 'example' => '2022-08-01 00:00:00', + ], + 'expireTime' => [ + 'title' => '过期时间', + 'description' => 'The time when the instance expires.'."\n", + 'type' => 'string', + 'example' => '2022-09-01 00:00:00', + ], + 'releaseTime' => [ + 'title' => '释放时间', + 'description' => 'The time when the instance was released.'."\n", + 'type' => 'string', + 'example' => '2022-09-07 00:00:00', + ], + 'userId' => [ + 'title' => '所属人ID', + 'description' => 'The ID of the user who owns the instance.'."\n", + 'type' => 'string', + 'example' => '111111111111111', + ], + 'bid' => [ + 'title' => 'BID', + 'description' => 'The business ID (BID) of the commodity.'."\n", + 'type' => 'string', + 'example' => '26842', + ], + 'commodityCode' => [ + 'title' => '商品编码', + 'description' => 'The commodity code of the instance. The commodity code of a ApsaraMQ for RocketMQ 5.0 instance has a similar format as ons_rmqsub_public_cn.', + 'type' => 'string', + 'example' => 'ons_rmqsub_public_cn', + ], + 'serviceCode' => [ + 'title' => '服务编码', + 'description' => 'The code of the service to which the instance belongs. The service code of ApsaraMQ for RocketMQ is rmq.', + 'type' => 'string', + 'example' => 'rmq', + ], + 'seriesCode' => [ + 'title' => '系列编码', + 'description' => 'The primary edition of the instance. For information about the differences between primary edition instances, see [Instance selection](~~444722~~).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* standard: Standard Edition'."\n" + .'* ultimate: Enterprise Platinum Edition'."\n" + .'* professional: Professional Edition'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'standard' => '', + 'ultimate' => '', + 'professional' => '', + ], + 'example' => 'standard', + ], + 'subSeriesCode' => [ + 'title' => '子系列编码', + 'description' => 'The sub-category edition of the instance. For information about the differences between sub-category edition instances, see [Instance selection](~~444722~~).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* cluster_ha: Cluster High-availability Edition'."\n" + .'* single_node: Standalone Edition'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'cluster_ha' => '', + 'single_node' => '', + ], + 'example' => 'cluster_ha', + ], + 'paymentType' => [ + 'title' => '付费类型', + 'description' => 'The billing method of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PayAsYouGo'."\n" + .'* Subscription'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'PayAsYouGo' => '', + 'Subscription' => '', + ], + 'example' => 'Subscription', + 'enum' => [ + 'Subscription', + 'PayAsYouGo', + ], + ], + 'remark' => [ + 'title' => '备注', + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'example' => 'This is remark for instance.', + ], + 'networkInfo' => [ + 'title' => '网络信息', + 'description' => 'The network information.'."\n", + 'type' => 'object', + 'properties' => [ + 'vpcInfo' => [ + 'title' => '专有网络信息', + 'description' => 'The virtual private cloud (VPC) information.'."\n", + 'type' => 'object', + 'properties' => [ + 'vpcId' => [ + 'title' => '专有网络ID', + 'description' => 'The ID of the VPC with which the instance is associated.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf6of9452b2pba82c****', + ], + 'vSwitchId' => [ + 'title' => '交换机ID', + 'description' => 'The ID of the vSwitch with which the instance is associated.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'example' => 'vsw-uf6gwtbn6etadpvz7****', + ], + 'vSwitches' => [ + 'title' => '交换机列表', + 'description' => 'The vSwitches.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'vSwitchId' => [ + 'title' => '交换机ID', + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-uf6gwtbn6etadpvz7****', + ], + 'zoneId' => [ + 'title' => '可用区ID', + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'description' => '', + ], + ], + 'securityGroupIds' => [ + 'description' => 'The security group ID.'."\n", + 'type' => 'string', + 'example' => 'sg-hp35r2hc3a3sv8q2sb16', + ], + ], + ], + 'endpoints' => [ + 'title' => '接入点列表', + 'description' => 'The endpoints.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The endpoint.'."\n", + 'type' => 'object', + 'properties' => [ + 'endpointType' => [ + 'title' => '接入点类型', + 'description' => 'The type of the endpoint that is used to access the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* TCP_VPC: VPC endpoint'."\n" + .'* TCP_INTERNET: public endpoint'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'TCP_VPC' => '', + 'TCP_INTERNET' => '', + ], + 'example' => 'TCP_INTERNET', + 'enum' => [ + 'TCP_INTERNET', + 'TCP_VPC', + ], + ], + 'endpointUrl' => [ + 'title' => '接入点地址', + 'description' => 'The endpoint that is used to access the instance.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080', + ], + 'ipWhitelist' => [ + 'description' => 'The whitelist that includes the IP addresses that are allowed to access the ApsaraMQ for RocketMQ broker over the Internet. This parameter can be configured only if you use the public endpoint to access the instance.'."\n" + ."\n" + .'* If you do not configure an IP address whitelist, all CIDR blocks are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n" + .'* If you configure an IP address whitelist, only the IP addresses in the whitelist are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n" + ."\n" + .'We recommend that you configure internetInfo.ipWhitelist instead of this parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The whitelist that includes the IP addresses that are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n", + 'type' => 'string', + 'example' => '192.168.x.x/24', + ], + 'example' => '192.168.x.x/24', + 'title' => '', + ], + 'endpointId' => [ + 'title' => '关联的pvl ep实例', + 'type' => 'string', + 'example' => 'ep-bpxxx', + ], + ], + ], + ], + 'internetInfo' => [ + 'title' => '公网信息', + 'description' => 'The information about the Internet.'."\n", + 'type' => 'object', + 'properties' => [ + 'internetSpec' => [ + 'title' => '是否开通公网', + 'description' => 'Specifies whether to enable the Internet access feature.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* enable'."\n" + .'* disable'."\n" + ."\n" + .'By default, ApsaraMQ for RocketMQ instances are accessed in virtual private clouds (VPCs). If you enable the Internet access feature, you are charged for Internet outbound bandwidth. For more information, see [Internet access fee](~~427240~~).', + 'type' => 'string', + 'enumValueTitles' => [ + 'enable' => '', + 'disable' => '', + ], + 'example' => 'enable', + ], + 'flowOutType' => [ + 'title' => '公网计费类型', + 'description' => 'The metering method for Internet usage.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PayByBandwidth: pay-by-bandwidth. If the Internet access feature is enabled, specify this value for the parameter.'."\n" + .'* uninvolved: N/A. If the Internet access feature is not enabled, specify this value for the parameter.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'payByBandwidth' => '', + 'uninvolved' => '', + ], + 'example' => 'payByBandwidth', + ], + 'flowOutBandwidth' => [ + 'title' => '公网带宽规格', + 'description' => 'The Internet bandwidth. Unit: MB/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ipWhitelist' => [ + 'title' => '公网IP白名单列表', + 'description' => 'The whitelist that includes the IP addresses that are allowed to access the ApsaraMQ for RocketMQ broker.'."\n" + ."\n" + .'* If this parameter is not configured, all IP addresses are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.'."\n" + .'* If this parameter is configured, only the IP addresses that are included in the whitelist can access the ApsaraMQ for RocketMQ broker over the Internet.', + 'type' => 'array', + 'items' => [ + 'title' => '公网IP白名单', + 'description' => 'The whitelist that includes the IP addresses that are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.', + 'type' => 'string', + 'example' => '192.168.x.x/24', + ], + ], + ], + ], + ], + ], + 'accountInfo' => [ + 'title' => '账号信息', + 'description' => 'The account information.'."\n", + 'type' => 'object', + 'properties' => [ + 'username' => [ + 'title' => '用户名', + 'description' => 'The username of the instance. If you access a ApsaraMQ for RocketMQ instance over the Internet, you must configure the username and password of the instance in the SDK code for authentication.', + 'type' => 'string', + 'example' => '6W0xz2uPfiwp****', + ], + ], + ], + 'instanceQuotas' => [ + 'title' => '容量信息', + 'description' => 'The instance quotas.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'quotaName' => [ + 'title' => '配额名称', + 'description' => 'The quota name.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* TOPIC_COUNT: the number of topics that can be created on the instance'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'TOPIC_COUNT' => '', + ], + 'example' => 'TOPIC_COUNT', + ], + 'usedCount' => [ + 'title' => '已使用量', + 'description' => 'The number of used topics on the instance.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'freeCount' => [ + 'title' => '免费', + 'description' => 'The number of topics that are free of charge on the instance.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '20', + ], + 'totalCount' => [ + 'title' => '总配额', + 'description' => 'The total number of topics on the instance.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + ], + ], + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the instance was created.'."\n", + 'type' => 'string', + 'example' => '2022-08-01 00:00:00 ', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the instance was last modified.'."\n", + 'type' => 'string', + 'example' => '2022-08-02 00:00:00 ', + ], + 'extConfig' => [ + 'title' => '扩展配置，不再推荐使用，建议使用产品信息、网络信息中的字段替换', + 'description' => 'The extended configurations. We recommend you configure productInfo, internetInfo, or aclInfo instead of this parameter.'."\n", + 'type' => 'object', + 'properties' => [ + 'aclType' => [ + 'title' => '鉴权类型', + 'description' => 'The authentication type of the instance.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* default: intelligent authentication'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'default' => '', + ], + 'example' => 'default', + 'enum' => [ + 'default', + 'aliyun_ram', + 'apache_acl', + ], + ], + 'sendReceiveRatio' => [ + 'title' => '消息收发比例', + 'description' => 'The ratio between sent messages and received messages in the instance.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'autoScaling' => [ + 'title' => '自适应弹性伸缩', + 'description' => 'Specifies whether to enable the elastic TPS feature for the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true: enable'."\n" + .'* false: disable'."\n" + ."\n" + .'This parameter is valid only when the supportAutoScaling parameter is set to enable.'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'messageRetentionTime' => [ + 'title' => '消息保留时长', + 'description' => 'The retention period of messages. Unit: hours.'."\n" + ."\n" + .'For information about the valid values of this parameter, see the "Limits on resource quotas" section in [Usage limits](~~440347~~).'."\n" + ."\n" + .'The storage of messages in ApsaraMQ for RocketMQ is serverless and scalable. You are charged for message storage based on your actual usage. You can change the retention period of messages to adjust storage capacity. For more information, see [Storage fee](~~427238~~).', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '72', + ], + 'supportAutoScaling' => [ + 'title' => '是否支持自适应弹性伸缩', + 'description' => 'Specifies whether the elastic TPS feature is supported by the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true: enable'."\n" + .'* false: disable'."\n" + ."\n" + .'After you enable the elastic TPS feature for a ApsaraMQ for RocketMQ instance, you can use a specific amount of TPS that exceeds the specification limit. You are charged for the elastic TPS feature. For more information, see [Computing fee](~~427237~~).'."\n" + ."\n" + .'> The elastic TPS feature is supported only by specific instance editions. For more information, see [Instance specifications](~~444715~~).', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'internetSpec' => [ + 'title' => '是否开通公网', + 'description' => 'Indicates whether Internet access is enabled.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* enable'."\n" + .'* disable'."\n" + ."\n" + .'By default, you can access ApsaraMQ for RocketMQ instances in virtual private clouds (VPCs). If you enable the Internet access feature, you are charged for Internet outbound bandwidth. For more information, see [Internet access fees](~~427240~~).'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'enable' => '', + 'disable' => '', + ], + 'example' => 'enable', + 'enum' => [ + 'enable', + 'disable', + ], + ], + 'flowOutType' => [ + 'title' => '公网计费类型', + 'description' => 'The metering method of Internet usage.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PayByTraffic: pay-by-traffic'."\n" + .'* paybybandwidth: pay-by-bandwidth'."\n" + .'* uninvolved: N/A'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'payByTraffic' => '', + 'payByBandwidth' => '', + 'uninvolved' => '', + ], + 'example' => 'payByBandwidth', + 'enum' => [ + 'uninvolved', + 'payByTraffic', + 'payByBandwidth', + ], + ], + 'flowOutBandwidth' => [ + 'title' => '公网带宽规格', + 'description' => 'The Internet bandwidth. Unit: MB/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'msgProcessSpec' => [ + 'title' => '消息收发计算规格', + 'description' => 'The computing specification that is used to send and receive messages. For information about the upper limit of TPS, see [Instance specifications](~~444715~~).'."\n", + 'type' => 'string', + 'example' => 'rmq.s2.2xlarge', + ], + ], + 'deprecated' => true, + ], + 'resourceGroupId' => [ + 'title' => '资源组ID', + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-acfm3tmjruyribi', + ], + 'productInfo' => [ + 'title' => '产品信息', + 'description' => 'The extended configurations of the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'msgProcessSpec' => [ + 'title' => '消息收发规格', + 'description' => 'The computing specification that is used to send and receive messages. For information about the upper limit of TPS, see [Instance specifications](~~444715~~).'."\n", + 'type' => 'string', + 'example' => 'rmq.s2.2xlarge', + ], + 'sendReceiveRatio' => [ + 'title' => '消息收发比例', + 'description' => 'The ratio between sent messages and received messages in the instance.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'autoScaling' => [ + 'title' => '是否开启弹性伸缩', + 'description' => 'Specifies whether to enable the elastic TPS feature for the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true: enable'."\n" + .'* false: disable'."\n" + ."\n" + .'This parameter is valid only when the supportAutoScaling parameter is set to enable.'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'messageRetentionTime' => [ + 'title' => '消息保留时长', + 'description' => 'The retention period of messages. Unit: hours.'."\n" + ."\n" + .'For information about the valid values of this parameter, see the "Limits on resource quotas" section in [Usage limits](~~440347~~).'."\n" + ."\n" + .'The storage of messages in ApsaraMQ for RocketMQ is serverless and scalable. You are charged for message storage based on your actual usage. You can change the retention period of messages to adjust storage capacity. For more information, see [Storage fee](~~427238~~).', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '72', + ], + 'supportAutoScaling' => [ + 'title' => '是否支持弹性伸缩', + 'description' => 'Specifies whether to enable the elastic TPS feature for the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true: enable'."\n" + .'* false: disable'."\n" + ."\n" + .'After you enable the elastic TPS feature for a ApsaraMQ for RocketMQ instance, you can use a specific amount of TPS that exceeds the specification limit. You are charged for the elastic TPS feature. For more information, see [Computing fee](~~427237~~).'."\n" + ."\n" + .'> The elastic TPS feature is supported by only specific instance editions. For more information, see [Instance specifications](~~444715~~).', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'traceOn' => [ + 'description' => 'Indicates whether the message trace feature is enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'This parameter is not in use. By default, the message trace feature is enabled for ApsaraMQ for RocketMQ instances, regardless of whether this parameter is configured.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'storageEncryption' => [ + 'title' => '是否开启存储加密', + 'description' => 'Indicates whether storage encryption is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'storageSecretKey' => [ + 'title' => '存储加密密钥Key', + 'description' => 'The storage encryption key.'."\n", + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'capacityType' => [ + 'type' => 'string', + ], + 'provisionedCapacity' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'aclInfo' => [ + 'title' => '访问控制信息', + 'description' => 'The information about access control.'."\n", + 'type' => 'object', + 'properties' => [ + 'aclTypes' => [ + 'description' => 'The authentication types of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The authentication type of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- default: intelligent identity authentication'."\n" + ."\n" + .'- apache_acl:access control list (ACL) identity authentication', + 'type' => 'string', + 'enumValueTitles' => [ + 'default' => '', + 'apache_acl' => '', + ], + 'example' => 'default', + ], + ], + 'defaultVpcAuthFree' => [ + 'description' => 'Indicates whether the authentication-free in VPCs feature is enabled.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'aclType' => [ + 'description' => 'The authentication type of the instance. This parameter is no longer in use. We recommend that you configure aclTypes.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- default: intelligent identity authentication'."\n" + ."\n" + .'- apache_acl:access control list (ACL) identity authentication**', + 'type' => 'string', + 'deprecated' => true, + 'enumValueTitles' => [ + 'default' => 'default', + 'apache_acl' => '', + ], + 'example' => 'default', + 'title' => '', + ], + ], + ], + 'software' => [ + 'title' => '实例软件信息', + 'description' => 'The instance software information.', + 'type' => 'object', + 'properties' => [ + 'softwareVersion' => [ + 'title' => '软件版本', + 'description' => 'The version of software.', + 'type' => 'string', + 'example' => '5.0-rmq-20230619-1', + ], + 'maintainTime' => [ + 'title' => '升级时间段', + 'description' => 'The period of upgrade time.', + 'type' => 'string', + 'example' => '02:00-06:00', + ], + 'upgradeMethod' => [ + 'title' => '升级方式，auto自动升级，manual手动升级', + 'description' => 'The upgrade method.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Auto: automatic upgrade'."\n" + ."\n" + .'- Manual: manual upgrade', + 'type' => 'string', + 'enumValueTitles' => [ + 'auto' => '', + 'maunal' => '', + ], + 'example' => 'auto', + ], + ], + ], + 'topicCount' => [ + 'title' => '主题数量', + 'description' => 'The number of topics.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'groupCount' => [ + 'title' => '消费组数量', + 'description' => 'The number of groups.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'tags' => [ + 'title' => '资源标签列表。', + 'description' => 'The resource tags.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '资源标签。', + 'description' => 'The resource tags.', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '资源标签key值。', + 'description' => 'The tag key of the resource.'."\n", + 'type' => 'string', + 'example' => 'key', + ], + 'value' => [ + 'title' => '资源标签value值。', + 'description' => 'The tag value of the resource.'."\n", + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code returned if the call failed.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"05AB7FBD-F1D3-5D87-BF78-BD782249****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"instanceName\\": \\"test instance\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"startTime\\": \\"2022-08-01 00:00:00\\",\\n \\"expireTime\\": \\"2022-09-01 00:00:00\\",\\n \\"releaseTime\\": \\"2022-09-07 00:00:00\\",\\n \\"userId\\": \\"111111111111111\\",\\n \\"bid\\": \\"26842\\",\\n \\"commodityCode\\": \\"ons_rmqsub_public_cn\\",\\n \\"serviceCode\\": \\"rmq\\",\\n \\"seriesCode\\": \\"standard\\",\\n \\"subSeriesCode\\": \\"cluster_ha\\",\\n \\"paymentType\\": \\"Subscription\\",\\n \\"remark\\": \\"This is remark for instance.\\",\\n \\"networkInfo\\": {\\n \\"vpcInfo\\": {\\n \\"vpcId\\": \\"vpc-uf6of9452b2pba82c****\\",\\n \\"vSwitchId\\": \\"vsw-uf6gwtbn6etadpvz7****\\",\\n \\"vSwitches\\": [\\n {\\n \\"vSwitchId\\": \\"vsw-uf6gwtbn6etadpvz7****\\",\\n \\"zoneId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"securityGroupIds\\": \\"sg-hp35r2hc3a3sv8q2sb16\\"\\n },\\n \\"endpoints\\": [\\n {\\n \\"endpointType\\": \\"TCP_INTERNET\\",\\n \\"endpointUrl\\": \\"rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080\\",\\n \\"ipWhitelist\\": [\\n \\"192.168.x.x/24\\"\\n ],\\n \\"endpointId\\": \\"ep-bpxxx\\"\\n }\\n ],\\n \\"internetInfo\\": {\\n \\"internetSpec\\": \\"enable\\",\\n \\"flowOutType\\": \\"payByBandwidth\\",\\n \\"flowOutBandwidth\\": 1,\\n \\"ipWhitelist\\": [\\n \\"192.168.x.x/24\\"\\n ]\\n }\\n },\\n \\"accountInfo\\": {\\n \\"username\\": \\"6W0xz2uPfiwp****\\"\\n },\\n \\"instanceQuotas\\": [\\n {\\n \\"quotaName\\": \\"TOPIC_COUNT\\",\\n \\"usedCount\\": 10,\\n \\"freeCount\\": 20,\\n \\"totalCount\\": 100\\n }\\n ],\\n \\"createTime\\": \\"2022-08-01 00:00:00 \\",\\n \\"updateTime\\": \\"2022-08-02 00:00:00 \\",\\n \\"extConfig\\": {\\n \\"aclType\\": \\"default\\",\\n \\"sendReceiveRatio\\": 0.5,\\n \\"autoScaling\\": true,\\n \\"messageRetentionTime\\": 72,\\n \\"supportAutoScaling\\": true,\\n \\"internetSpec\\": \\"enable\\",\\n \\"flowOutType\\": \\"payByBandwidth\\",\\n \\"flowOutBandwidth\\": 10,\\n \\"msgProcessSpec\\": \\"rmq.s2.2xlarge\\"\\n },\\n \\"resourceGroupId\\": \\"rg-acfm3tmjruyribi\\",\\n \\"productInfo\\": {\\n \\"msgProcessSpec\\": \\"rmq.s2.2xlarge\\",\\n \\"sendReceiveRatio\\": 0.5,\\n \\"autoScaling\\": true,\\n \\"messageRetentionTime\\": 72,\\n \\"supportAutoScaling\\": true,\\n \\"traceOn\\": true,\\n \\"storageEncryption\\": false,\\n \\"storageSecretKey\\": \\"xxxxx\\",\\n \\"capacityType\\": \\"provisioned\\",\\n \\"provisionedCapacity\\": 3000\\n },\\n \\"aclInfo\\": {\\n \\"aclTypes\\": [\\n \\"default\\"\\n ],\\n \\"defaultVpcAuthFree\\": true,\\n \\"aclType\\": \\"default\\"\\n },\\n \\"software\\": {\\n \\"softwareVersion\\": \\"5.0-rmq-20230619-1\\",\\n \\"maintainTime\\": \\"02:00-06:00\\",\\n \\"upgradeMethod\\": \\"auto\\"\\n },\\n \\"topicCount\\": 10,\\n \\"groupCount\\": 10,\\n \\"tags\\": [\\n {\\n \\"key\\": \\"key\\",\\n \\"value\\": \\"value\\"\\n }\\n ]\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'GetInstance', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n", + ], + 'CreateTopic' => [ + 'summary' => 'Create Topic', + 'path' => '/instances/{instanceId}/topics/{topicName}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsHZ457W', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance to which the topic to be created belongs.', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'title' => '主题名称', + 'description' => 'The name of the topic to be created, used for identifying the topic, and it must be globally unique.'."\n" + ."\n" + .'Value specifications are as follows:'."\n" + ."\n" + .'- Character restrictions: Supports letters a\\~z or A\\~Z, numbers 0~9, and underscores (_), hyphens (-).'."\n" + .'- Length restrictions: 1 to 60 characters.'."\n" + ."\n" + .'For reserved character restrictions, please refer to [Parameter Restrictions](~~440347~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'topic_test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '消息类型', + 'description' => 'The information about the topic.'."\n", + 'type' => 'object', + 'properties' => [ + 'messageType' => [ + 'title' => '消息类型', + 'description' => 'The type of messages in the topic that you want to create.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* TRANSACTION: transactional messages'."\n" + .'* FIFO: ordered messages'."\n" + .'* DELAY: scheduled or delayed messages'."\n" + .'* NORMAL: normal messages'."\n" + ."\n" + .'> The type of messages in the topic must be the same as the type of messages that you want to send. For example, if you create a topic whose message type is ordered messages, you can use the topic to send and receive only ordered messages.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'TRANSACTION' => '', + 'FIFO' => '', + 'DELAY' => '', + 'NORMAL' => '', + ], + 'example' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'FIFO', + 'DELAY', + 'TRANSACTION', + ], + ], + 'remark' => [ + 'title' => '备注', + 'description' => 'The description of the topic that you want to create.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is the remark for test.', + ], + 'maxSendTps' => [ + 'description' => 'The maximum TPS for message sending.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1500', + ], + 'liteTopicExpiration' => [ + 'title' => 'liteTopic过期时间，单位：分钟'."\n" + .'取值范围：15-720。'."\n" + .'默认-1，表示永久存在', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + 'default' => '-1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID, each request\'s ID is unique and can be used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the execution was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'Return result.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'Topic.Existed', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'The topic already exists.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code.', + 'type' => 'string', + 'example' => 'TopicName', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'Dynamic error message.', + 'type' => 'string', + 'example' => 'topicName', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.Existed\\",\\n \\"message\\": \\"The topic already exists.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"TopicName\\",\\n \\"dynamicMessage\\": \\"topicName\\"\\n}","type":"json"}]', + 'title' => 'CreateTopic', + 'translator' => 'machine', + ], + 'UpdateTopic' => [ + 'summary' => 'Update Topic', + 'path' => '/instances/{instanceId}/topics/{topicName}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '144678', + 'abilityTreeNodes' => [ + 'FEATUREonsCON1A8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance to which the topic to be updated belongs.', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'title' => '主题名称', + 'description' => 'The name of the topic to be updated.', + 'type' => 'string', + 'required' => true, + 'example' => 'topic_test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Request body structure.', + 'type' => 'object', + 'properties' => [ + 'remark' => [ + 'title' => '备注', + 'description' => 'Updated remarks for the topic.', + 'type' => 'string', + 'required' => false, + 'example' => 'This is the remark for test.', + ], + 'maxSendTps' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'description' => 'Maximum send message tps', + 'example' => '500', + ], + 'liteTopicExpiration' => [ + 'title' => 'liteTopic过期时间，单位：分钟'."\n" + .'取值范围：15-720。'."\n" + .'默认-1，表示永久存在', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID, each request has a unique ID that can be used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Whether the execution result is successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'Return result.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'The topic cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code', + 'type' => 'string', + 'example' => 'TopicName', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => '动态错误信息', + 'type' => 'string', + 'example' => 'topicName', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic cannot be found.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"TopicName\\",\\n \\"dynamicMessage\\": \\"topicName\\"\\n}","type":"json"}]', + 'title' => 'UpdateTopic', + 'translator' => 'machine', + ], + 'DeleteTopic' => [ + 'summary' => 'Deletes a specified topic.', + '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' => 'The ID of the instance to which the topic belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'title' => '主题名称', + 'description' => 'The name of the topic.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'topic_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'The response object.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.'."\n", + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The result data that is returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The topic cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'TopicName', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'topicName', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic cannot be found.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"TopicName\\",\\n \\"dynamicMessage\\": \\"topicName\\"\\n}","type":"json"}]', + 'title' => 'DeleteTopic', + 'description' => 'If you delete the topic, the publishing and subscription relationships that are established based on the topic are cleared. Exercise caution when you call this operation.'."\n", + ], + 'ListTopics' => [ + 'summary' => 'Query Topic List', + 'path' => '/instances/{instanceId}/topics', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '144680', + 'abilityTreeNodes' => [ + 'FEATUREonsXSOU1Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'Specifies which instance\'s topic list to retrieve.', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => [ + 'title' => '过滤条件', + 'description' => 'The filter condition for the query. If not provided, all topics under the instance will be queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'topic_test', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码', + 'description' => 'Page number, indicating which page of results to return.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => 'Page size, the maximum number of results to display per page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '10', + 'example' => '3', + ], + ], + [ + 'name' => 'messageTypes', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => 'The message type of the topic.', + 'type' => 'array', + 'items' => [ + 'description' => 'The type of topic to query under the instance. If not provided, all topics under the instance will be queried.'."\n" + .'Parameter values are as follows:'."\n" + .'- TRANSACTION: Transactional messages'."\n" + .'- FIFO: Ordered messages'."\n" + .'- DELAY: Timed/Delayed messages'."\n" + .'- NORMAL: Normal messages', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TRANSACTION' => 'TRANSACTION', + 'FIFO' => 'FIFO', + 'DELAY' => 'DELAY', + 'NORMAL' => 'NORMAL', + ], + 'example' => 'NORMAL', + ], + 'required' => false, + 'enumValueTitles' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MyPage<TopicDTO>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID, each request has a unique ID that can be used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the execution was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'title' => '当前页码', + 'description' => 'Current page number.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页大小', + 'description' => 'Page size.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'totalCount' => [ + 'title' => '总记录数', + 'description' => 'Total number of results returned.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'list' => [ + 'title' => '分页数据', + 'description' => 'The topics.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '区域ID', + 'description' => 'The region ID to which the instance belongs.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'Instance ID.', + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'topicName' => [ + 'title' => 'Topic编码', + 'description' => 'Topic name.', + 'type' => 'string', + 'example' => 'topic_test', + ], + 'messageType' => [ + 'title' => '消息类型,MessageTypeEnum[UNSPECIFIED,NORMAL(普通),FIFO(顺序),DELAY(延迟),TRANSACTION(事务),UNRECOGNIZED(无法识别),code,desc]', + 'description' => 'The type of messages in the topic.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* TRANSACTION: transactional messages'."\n" + .'* FIFO: ordered messages'."\n" + .'* DELAY: scheduled or delayed messages'."\n" + .'* NORMAL: normal messages'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'TRANSACTION' => 'TRANSACTION', + 'FIFO' => 'FIFO', + 'DELAY' => 'DELAY', + 'NORMAL' => 'NORMAL', + ], + 'example' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'FIFO', + 'DELAY', + 'TRANSACTION', + ], + ], + 'status' => [ + 'title' => 'Topic状态,TopicStatusEnum[CREATING(创建中),RUNNING(运行中),code,desc]', + 'description' => 'The topic status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* RUNNING'."\n" + .'* CREATING'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'RUNNING' => 'RUNNING', + 'CREATING' => 'CREATING', + ], + 'example' => 'RUNNING', + 'enum' => [ + 'CREATING', + 'RUNNING', + ], + ], + 'remark' => [ + 'title' => '备注', + 'description' => 'Remark information of the topic.', + 'type' => 'string', + 'example' => 'This is the remark for test.', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => 'Creation time.', + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => 'Last update time of the topic.', + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'maxSendTps' => [ + 'description' => 'The maximum TPS for message sending.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'liteTopicExpiration' => [ + 'title' => 'liteTopic过期时间，单位：分钟', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'The topic cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code.', + 'type' => 'string', + 'example' => 'TopicName', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'Dynamic error message.', + 'type' => 'string', + 'example' => 'topicName', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 3,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageType\\": \\"NORMAL\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"remark\\": \\"This is the remark for test.\\",\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\",\\n \\"maxSendTps\\": 1000,\\n \\"liteTopicExpiration\\": 20\\n }\\n ]\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic cannot be found.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"TopicName\\",\\n \\"dynamicMessage\\": \\"topicName\\"\\n}","type":"json"}]', + 'title' => 'ListTopics', + 'translator' => 'machine', + ], + 'GetTopic' => [ + 'summary' => 'Query Topic Details', + 'path' => '/instances/{instanceId}/topics/{topicName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '144800', + 'abilityTreeNodes' => [ + 'FEATUREons8BETJT', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance to which the topic to be queried belongs.', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'title' => '主题名称', + 'description' => 'The name of the topic to be queried.', + 'type' => 'string', + 'required' => true, + 'example' => 'topic_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<TopicDTO>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID, each request\'s ID is unique and can be used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the execution was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '区域ID', + 'description' => 'The region ID to which the instance belongs.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance to which the topic belongs.', + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'topicName' => [ + 'title' => 'Topic编码', + 'description' => 'Topic name.', + 'type' => 'string', + 'example' => 'topic_test', + ], + 'messageType' => [ + 'title' => '消息类型,MessageTypeEnum[UNSPECIFIED,NORMAL(普通),FIFO(顺序),DELAY(延迟),TRANSACTION(事务),UNRECOGNIZED(无法识别),code,desc]', + 'description' => 'The type of messages in the topic.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* TRANSACTION: transactional messages'."\n" + .'* FIFO: ordered messages'."\n" + .'* DELAY: scheduled or delayed messages'."\n" + .'* NORMAL: normal messages'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* TRANSACTION: transactional messages'."\n" + .'* FIFO: ordered messages'."\n" + .'* DELAY: scheduled or delayed messages'."\n" + .'* NORMAL: normal messages'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'TRANSACTION' => 'TRANSACTION', + 'FIFO' => 'FIFO', + 'DELAY' => 'DELAY', + 'NORMAL' => 'NORMAL', + ], + 'example' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'FIFO', + 'DELAY', + 'TRANSACTION', + ], + ], + 'status' => [ + 'title' => '主题状态', + 'description' => 'The topic status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* RUNNING'."\n" + .'* CREATING'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'RUNNING' => 'RUNNING', + 'CREATING' => 'CREATING', + ], + 'example' => 'RUNNING', + 'enum' => [ + 'CREATING', + 'RUNNING', + ], + ], + 'remark' => [ + 'title' => '备注', + 'description' => 'Remark information of the topic.', + 'type' => 'string', + 'example' => 'This is the remark for test.'."\n", + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => 'Creation time of the topic.', + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => 'Last modification time of the topic.', + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'maxSendTps' => [ + 'description' => 'The maximum TPS for message sending.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000'."\n" + ."\n", + ], + 'liteTopicExpiration' => [ + 'title' => 'liteTopic过期时间，单位：分钟', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'The topic cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code.', + 'type' => 'string', + 'example' => 'TopicName', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'Dynamic error message.', + 'type' => 'string', + 'example' => 'topicName', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageType\\": \\"NORMAL\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"remark\\": \\"This is the remark for test.\\\\n\\",\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\",\\n \\"maxSendTps\\": 1000,\\n \\"liteTopicExpiration\\": 60\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic cannot be found.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"TopicName\\",\\n \\"dynamicMessage\\": \\"topicName\\"\\n}","type":"json"}]', + 'title' => 'GetTopic', + 'translator' => 'machine', + ], + 'CreateConsumerGroup' => [ + 'summary' => 'Creates a consumer group.', + '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' => 'The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => [ + 'title' => '消费组ID', + 'description' => 'The result data that is returned.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'GID_test_groupId', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'remark' => [ + 'title' => '备注', + 'description' => 'The description of the consumer group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is the remark for test.', + ], + 'deliveryOrderType' => [ + 'title' => '投递顺序性', + 'description' => 'The message delivery method of the consumer group.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Concurrently: concurrent delivery'."\n" + .'* Orderly: ordered delivery'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Concurrently' => '', + 'Orderly' => '', + ], + 'example' => 'Concurrently', + 'enum' => [ + 'Orderly', + 'Concurrently', + ], + ], + 'consumeRetryPolicy' => [ + 'title' => '消费重试策略', + 'description' => 'The consumption retry policy of the consumer group. For more information, see [Consumption retry](~~440356~~).'."\n", + 'type' => 'object', + 'properties' => [ + 'maxRetryTimes' => [ + 'title' => '最大重试次数', + 'description' => 'The maximum number of retries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '16', + ], + 'retryPolicy' => [ + 'title' => '重试策略类型', + 'description' => 'The retry policy. For more information, see [Message retry](~~440356~~).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* FixedRetryPolicy: fixed-interval retry. This value is valid only if you set deliveryOrderType to Orderly.'."\n" + .'* DefaultRetryPolicy: exponential backoff retry. This value is valid only if you set deliveryOrderType to Concurrently.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'FixedRetryPolicy' => '', + 'DefaultRetryPolicy' => '', + ], + 'example' => 'DefaultRetryPolicy', + 'enum' => [ + 'DefaultRetryPolicy', + 'FixedRetryPolicy', + ], + ], + 'deadLetterTargetTopic' => [ + 'description' => 'The dead-letter topic.'."\n" + ."\n" + .'If a message still fails to be consumed after the maximum number of retries specified in the consumption retry policy is reached, the message is delivered to the dead-letter topic for subsequent business recovery or backtracking. For more information, see [Consumption retry and dead-letter messages](~~440356~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DLQ_mqtest', + ], + 'fixedIntervalRetryTime' => [ + 'description' => 'The fixed interval. Unit: seconds. This parameter takes effect only if you set retryPolicy to FixedRetryPolicy. Valid values:'."\n" + ."\n" + .'* Concurrent delivery: 10 to 1800'."\n" + .'* Ordered delivery: 1 to 600', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => true, + ], + 'maxReceiveTps' => [ + 'description' => 'The maximum number of messages that can be processed by consumers per second.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '300', + ], + 'messageModel' => [ + 'title' => '消费模式', + 'type' => 'string', + 'example' => 'CLUSTERING', + 'default' => 'CLUSTERING', + 'enum' => [ + 'CLUSTERING', + 'LITE_SELECTIVE', + ], + ], + 'topicName' => [ + 'title' => 'lite类型的topicName', + 'type' => 'string', + 'example' => 'test1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The result data that is returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'InvalidConsumerGroupId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter consumerGroupId is invalid.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'ConsumerGroupId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'consumerGroupId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"InvalidConsumerGroupId\\",\\n \\"message\\": \\"Parameter consumerGroupId is invalid.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"ConsumerGroupId\\",\\n \\"dynamicMessage\\": \\"consumerGroupId\\"\\n}","type":"json"}]', + 'title' => 'CreateConsumerGroup', + 'description' => 'The ID of the consumer group. The ID is globally unique and is used to identify a consumer group.'."\n" + ."\n" + .'The following limits are imposed on the ID:'."\n" + ."\n" + .'* Character limit: The ID can contain letters, digits, underscores (\\_), hyphens (-), and percent signs (%).'."\n" + .'* Length limit: The ID must be 1 to 60 characters in length.'."\n" + ."\n" + .'For more information about strings that are reserved for the system, see [Limits on parameters](~~440347~~).'."\n", + ], + 'UpdateConsumerGroup' => [ + 'summary' => 'Update ConsumerGroup', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '144683', + 'abilityTreeNodes' => [ + 'FEATUREonsTBTXFL', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance to which the consumer group to be updated belongs.', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22on9****', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => [ + 'title' => '消费组ID', + 'description' => 'The ID of the consumer group to be updated.', + 'type' => 'string', + 'required' => true, + 'example' => 'CID-TEST', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'remark' => [ + 'title' => '备注', + 'description' => 'The new description of the consumer group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is the remark for test.', + ], + 'deliveryOrderType' => [ + 'title' => '投递顺序性', + 'description' => 'The new message delivery method of the consumer group.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Concurrently: concurrent delivery'."\n" + .'* Orderly: ordered delivery'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Concurrently' => 'Concurrently', + 'Orderly' => 'Orderly', + ], + 'example' => 'Concurrently', + 'enum' => [ + 'Concurrently', + 'Orderly', + ], + 'deprecated' => true, + ], + 'consumeRetryPolicy' => [ + 'title' => '消费重试策略', + 'description' => 'The new consumption retry policy of the consumer group. For more information, see [Consumption retry](~~440356~~).'."\n", + 'type' => 'object', + 'properties' => [ + 'retryPolicy' => [ + 'title' => '重试策略类型', + 'description' => 'The retry policy. For more information, see [Message retry](~~440356~~).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* FixedRetryPolicy: fixed-interval retry. This value is valid only if you set deliveryOrderType to Orderly.'."\n" + .'* DefaultRetryPolicy: exponential backoff retry. This value is valid only if you set deliveryOrderType to Concurrently.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'FixedRetryPolicy' => 'FixedRetryPolicy', + 'DefaultRetryPolicy' => 'DefaultRetryPolicy', + ], + 'example' => 'DefaultRetryPolicy', + 'enum' => [ + 'DefaultRetryPolicy', + 'FixedRetryPolicy', + ], + ], + 'maxRetryTimes' => [ + 'title' => '最大重试次数', + 'description' => 'The maximum number of retries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '16', + ], + 'deadLetterTargetTopic' => [ + 'description' => 'The dead-letter topic.'."\n" + ."\n" + .'If a message still fails to be consumed after the maximum number of retries specified in the consumption retry policy is reached, the message is delivered to the dead-letter topic for subsequent business recovery or backtracking. For more information, see [Consumption retry and dead-letter messages](~~440356~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DLQ_mqtest', + ], + 'fixedIntervalRetryTime' => [ + 'description' => 'Fixed retry interval, unit: seconds.This option is effective when retryPolicy is FixedRetryPolicy.Value range：'."\n" + .' - Concurrently:10-1800'."\n" + .' - Orderly:1-600', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => true, + ], + 'maxReceiveTps' => [ + 'description' => 'The maximum number of messages that can be processed by consumers per second.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID, which is unique for each request and can be used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => 'C7F94090-3358-506A-97DC-34BC803C****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the execution was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The result returned.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'InvalidDeliveryOrderType', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'Parameter deliveryOrderType is invalid.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code.', + 'type' => 'string', + 'example' => 'xxx', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'Dynamic error message.', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7F94090-3358-506A-97DC-34BC803C****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"InvalidDeliveryOrderType\\",\\n \\"message\\": \\"Parameter deliveryOrderType is invalid.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"DeliveryOrderType\\",\\n \\"dynamicMessage\\": \\"deliveryOrderType\\"\\n}","type":"json"}]', + 'title' => 'UpdateConsumerGroup', + 'description' => '><notice>The OpenAPI provided by Alibaba Cloud is a management API used for managing and querying related resources of Alibaba Cloud services. It is recommended to integrate it only in the management chain. It is strictly prohibited to rely on OpenAPI implementation in the core data chain of message sending and receiving, otherwise it may lead to risks in the chain.></notice>', + 'translator' => 'machine', + ], + 'DeleteConsumerGroup' => [ + 'summary' => 'Deletes a specified consumer group.', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance from which you want to delete the consumer group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => [ + 'title' => '消费组ID', + 'description' => 'The ID of the consumer group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CID-TEST', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'The response object.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.'."\n", + 'type' => 'string', + 'example' => 'C7F94090-3358-506A-97DC-34BC803C****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The result data that is returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'InvalidConsumerGroupId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter consumerGroupId is invalid.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'ConsumerGroupId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'consumerGroupId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7F94090-3358-506A-97DC-34BC803C****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"InvalidConsumerGroupId\\",\\n \\"message\\": \\"Parameter consumerGroupId is invalid.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"ConsumerGroupId\\",\\n \\"dynamicMessage\\": \\"consumerGroupId\\"\\n}","type":"json"}]', + 'title' => 'DeleteConsumerGroup', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n" + ."\n" + .'After you delete a consumer group, the consumer client associated with the consumer group cannot consume messages. Exercise caution when you call this operation.'."\n", + ], + 'ListConsumerGroups' => [ + 'summary' => 'List Consumer Groups', + 'path' => '/instances/{instanceId}/consumerGroups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '144685', + 'abilityTreeNodes' => [ + 'FEATUREonsYVMMCL', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'Specifies which instance\'s consumer group list to retrieve.', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => [ + 'title' => '过滤条件', + 'description' => 'The filter condition for the query. If not provided, all consumer groups under the specified instance will be queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'CID-TEST', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码', + 'description' => 'Page number, indicating which page of results to return.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => 'Page size, the maximum number of results to display per page.'."\n" + ."\n" + .'Value range: [10, 100].', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MyPage<ConsumerGroupDTO>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID, each request has a unique ID that can be used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => '5503A460-98ED-5543-92CF-4853DE28****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the execution was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'title' => '当前页码', + 'description' => 'Current page number.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页大小', + 'description' => 'Page size.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'totalCount' => [ + 'title' => '总记录数', + 'description' => 'Total number of returned results.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'list' => [ + 'title' => '分页数据', + 'description' => 'The consumer groups.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '区域ID', + 'description' => 'The region ID to which the instance belongs.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'Instance ID.', + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'consumerGroupId' => [ + 'title' => '消费组ID', + 'description' => 'Consumer group ID.', + 'type' => 'string', + 'example' => 'GID-TEST', + ], + 'status' => [ + 'title' => '消费组状态', + 'description' => 'Status of the consumer group.', + 'type' => 'string', + 'enumValueTitles' => [ + 'RUNNING' => 'RUNNING', + 'CREATING' => 'CREATING', + ], + 'example' => 'RUNNING', + 'enum' => [ + 'CREATING', + 'RUNNING', + ], + ], + 'remark' => [ + 'title' => '备注', + 'description' => 'Remark information of the consumer group.', + 'type' => 'string', + 'example' => 'This is the remark for test.', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => 'Creation time of the consumer group.', + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => 'Last update time of the consumer group.', + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'maxReceiveTps' => [ + 'description' => 'The maximum TPS for message sending.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'messageModel' => [ + 'title' => '消费模式', + 'type' => 'string', + 'example' => 'LITE_SELECTIVE', + ], + 'topicName' => [ + 'title' => 'lite类型的topicName', + 'type' => 'string', + 'example' => 'test1', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'Parameter InstanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code.', + 'type' => 'string', + 'example' => 'xxx', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5503A460-98ED-5543-92CF-4853DE28****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"consumerGroupId\\": \\"GID-TEST\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"remark\\": \\"This is the remark for test.\\",\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\",\\n \\"maxReceiveTps\\": 1000,\\n \\"messageModel\\": \\"LITE_SELECTIVE\\",\\n \\"topicName\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter InstanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'ListConsumerGroups', + 'description' => '><notice>The OpenAPI provided by Alibaba Cloud is a management API used for managing and querying related resources of Alibaba Cloud services. It is recommended to integrate it only in the management chain. Do not rely on OpenAPI implementation in the core data chain for message sending and receiving, as this may lead to risks in the chain.></notice>', + 'translator' => 'machine', + ], + 'GetConsumerGroup' => [ + 'summary' => 'Queries the details of a specified consumer group.', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '144684', + 'abilityTreeNodes' => [ + 'FEATUREonsJCXOZ6', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance to which the consumer group belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => [ + 'title' => '消费者组ID', + 'description' => 'The ID of the consumer group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CID-TEST', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<ConsumerGroupDTO>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.'."\n", + 'type' => 'string', + 'example' => 'C7F94090-3358-506A-97DC-34BC803C****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '区域ID', + 'description' => 'The ID of the region in which the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'consumerGroupId' => [ + 'title' => '消费组ID', + 'description' => 'The ID of the consumer group.'."\n", + 'type' => 'string', + 'example' => 'CID-TEST', + ], + 'status' => [ + 'title' => '消费组状态', + 'description' => 'The status of the consumer group.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* RUNNING'."\n" + .'* CREATING'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'RUNNING' => '', + 'CREATING' => '', + ], + 'example' => 'RUNNING', + 'enum' => [ + 'CREATING', + 'RUNNING', + ], + ], + 'remark' => [ + 'title' => '备注', + 'description' => 'The remarks on the consumer group.'."\n", + 'type' => 'string', + 'example' => 'This is the remark for test.', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the consumer group was created.'."\n", + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the consumer group was last updated.'."\n", + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'deliveryOrderType' => [ + 'title' => '投递顺序性', + 'description' => 'The message delivery method of the consumer group.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Concurrently: concurrent delivery'."\n" + .'* Orderly: ordered delivery'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Concurrently' => '', + 'Orderly' => '', + ], + 'example' => 'Concurrently', + 'enum' => [ + 'Orderly', + 'Concurrently', + ], + ], + 'consumeRetryPolicy' => [ + 'title' => '消费重试策略', + 'description' => 'The consumption retry policy of the consumer group. For more information, see [Consumption retry](~~440356~~).'."\n", + 'type' => 'object', + 'properties' => [ + 'retryPolicy' => [ + 'title' => '重试策略类型', + 'description' => 'The retry policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* FixedRetryPolicy: fixed-interval retry'."\n" + .'* DefaultRetryPolicy: exponential backoff retry'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'FixedRetryPolicy' => '', + 'DefaultRetryPolicy' => '', + ], + 'example' => 'DefaultRetryPolicy', + 'enum' => [ + 'DefaultRetryPolicy', + 'FixedRetryPolicy', + ], + ], + 'maxRetryTimes' => [ + 'title' => '最大重试次数', + 'description' => 'The maximum number of retries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'deadLetterTargetTopic' => [ + 'description' => 'The dead-letter topic.'."\n" + ."\n" + .'If a consumer still fails to consume a message after the message is retried for a specified number of times, the message is delivered to a dead-letter topic for subsequent business recovery or troubleshooting. For more information, see [Consumption retry and dead-letter messages](~~440356~~).'."\n", + 'type' => 'string', + 'example' => 'DLQ_mqtest', + ], + 'fixedIntervalRetryTime' => [ + 'description' => 'Fixed interval retry time,Value range, unit: seconds'."\n" + .' - Concurrently:10-1800'."\n" + .' - Orderly:1-600', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'maxReceiveTps' => [ + 'description' => 'Maximum received message tps', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'messageModel' => [ + 'title' => '消费模式：'."\n" + .' CLUSTERING：集群消费'."\n" + .' LITE_SELECTIVE：LITE_SELECTIVE', + 'type' => 'string', + 'example' => 'LITE_SELECTIVE', + ], + 'topicName' => [ + 'title' => 'lite类型的topicName', + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'InvalidConsumerGroupId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter consumerGroupId is invalid.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'ConsumerGroupId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'consumerGroupId', + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'GetConsumerGroup', + 'description' => '> API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.'."\n", + ], + 'ListTopicSubscriptions' => [ + 'summary' => 'Queries the subscriptions of a specific topic.', + 'path' => '/instances/{instanceId}/topics/{topicName}/subscriptions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RocketMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-zpr34udri0w', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the topic on the ApsaraMQ for RocketMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dev4-HMH_INSURANCE_NOMAL_TOPIC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<SubscriptionDTO>>', + 'description' => 'Result\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '92A9BE4E-B794-50C8-979C-0456E4D32943', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The subscriptions of the topic.'."\n", + 'type' => 'object', + 'properties' => [ + 'consumerGroupId' => [ + 'title' => '消费者组', + 'description' => 'The consumer group ID.'."\n", + 'type' => 'string', + 'example' => 'CID-TEST', + ], + 'topicName' => [ + 'title' => '订阅主题', + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'example' => 'topic_test', + ], + 'messageModel' => [ + 'title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', + 'description' => 'The consumption mode. Valid values: BROADCASTING and CLUSTERING.'."\n", + 'type' => 'string', + 'example' => 'BROADCASTING', + ], + 'subscriptionStatus' => [ + 'title' => '订阅状态,SubscriptionStatusEnum[ONLINE(在线),OFFLINE(离线),code,desc]', + 'description' => 'The subscription status. Valid values: ONLINE and OFFLINE.'."\n", + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'filterExpression' => [ + 'title' => '过滤表达式', + 'description' => 'The filter expression.'."\n", + 'type' => 'string', + 'example' => '*', + ], + 'filterExpressionType' => [ + 'title' => '过滤表达式类型,SubscriptionExpressionTypeEnum[SQL(SQL过滤),TAG(TAG过滤),UNSPECIFIED(FILTER_TYPE_UNSPECIFIED 过滤类型未指定),code,desc]', + 'description' => 'The type of the filter expression. Valid values: SQL, TAG, and UNSPECIFIED. The value SQL indicates that messages are filtered by using SQL expressions. The value TAG indicates that messages are filtered by using tags. The value UNSPECIFIED indicates that no filter expression type is specified.'."\n", + 'type' => 'string', + 'example' => 'SQL', + ], + 'consistency' => [ + 'description' => 'Indicates whether message consumption is consistent. Valid values:'."\n" + ."\n" + .'* false: Unconsumed messages exist in the consumer group.'."\n" + .'* true: No unconsumed message exists in the consumer group.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'Topic', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"92A9BE4E-B794-50C8-979C-0456E4D32943\\",\\n \\"success\\": true,\\n \\"data\\": [\\n {\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageModel\\": \\"BROADCASTING\\",\\n \\"subscriptionStatus\\": \\"ONLINE\\",\\n \\"filterExpression\\": \\"*\\",\\n \\"filterExpressionType\\": \\"SQL\\",\\n \\"consistency\\": \\"true\\"\\n }\\n ],\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"Topic\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'ListTopicSubscriptions', + ], + 'ListConsumerGroupSubscriptions' => [ + 'summary' => 'Queries the subscriptions of a specific consumer group.', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '145821', + 'abilityTreeNodes' => [ + 'FEATUREons0MOUAZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RocketMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-tl32wwz1r05', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the consumer group whose subscriptions you want to query.'."\n" + ."\n" + .'If you do not configure this parameter, the subscriptions of all consumer groups on the specified instance are queried.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PRINT_RETRY_CONSUMER', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'query', + 'schema' => [ + 'title' => '主题名称', + 'description' => 'The topic name. If you do not specify this parameter, all subscriptions of the consumer group are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'topic_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<SubscriptionDTO>>', + 'description' => 'Result\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5F4D9D5F-625B-59FF-BD4F-DA8284575DB4', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The subscriptions of the consumer group.'."\n", + 'type' => 'object', + 'properties' => [ + 'consumerGroupId' => [ + 'title' => '消费者组', + 'description' => 'The ID of the consumer group.'."\n", + 'type' => 'string', + 'example' => 'CID-TEST', + ], + 'topicName' => [ + 'title' => '订阅主题', + 'description' => 'The topic to which the consumer group subscribes.'."\n", + 'type' => 'string', + 'example' => 'topic_test', + ], + 'messageModel' => [ + 'title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', + 'description' => 'The consumption mode of the consumer group. Valid values:'."\n" + ."\n" + .'* BROADCASTING: broadcasting consumption'."\n" + .'* CLUSTERING: clustering consumption'."\n", + 'type' => 'string', + 'example' => 'BROADCASTING', + ], + 'subscriptionStatus' => [ + 'title' => '订阅状态,SubscriptionStatusEnum[ONLINE(在线),OFFLINE(离线),code,desc]', + 'description' => 'The subscription status. Valid values:'."\n" + ."\n" + .'* ONLINE: The consumer group is online. If the consumer group contains multiple consumers, this value is returned as long as one of the consumers is online.'."\n" + .'* OFFLINE: The consumer group is offline. If the consumer group contains multiple consumers, this value is returned only if all consumers are offline.'."\n", + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'filterExpression' => [ + 'title' => '过滤表达式', + 'description' => 'The filter expression.'."\n", + 'type' => 'string', + 'example' => '*', + ], + 'filterExpressionType' => [ + 'title' => '过滤表达式类型,SubscriptionExpressionTypeEnum[SQL(SQL过滤),TAG(TAG过滤),UNSPECIFIED(FILTER_TYPE_UNSPECIFIED 过滤类型未指定),code,desc]', + 'description' => 'The type of the filter expression. Valid values:'."\n" + ."\n" + .'* SQL: filters messages by using SQL expressions.'."\n" + .'* TAG: filters messages by using tags.'."\n", + 'type' => 'string', + 'example' => 'SQL', + ], + 'topicCreated' => [ + 'description' => 'Indicates whether the topic is created.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'consistency' => [ + 'description' => 'Indicates whether message consumption is consistent. Valid values:'."\n" + ."\n" + .'* false: Unconsumed messages exist in the consumer group.'."\n" + .'* true: No unconsumed message exists in the consumer group.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5F4D9D5F-625B-59FF-BD4F-DA8284575DB4\\",\\n \\"success\\": true,\\n \\"data\\": [\\n {\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageModel\\": \\"CLUSTERING\\",\\n \\"subscriptionStatus\\": \\"ONLINE\\",\\n \\"filterExpression\\": \\"*\\",\\n \\"filterExpressionType\\": \\"SQL\\",\\n \\"topicCreated\\": true,\\n \\"consistency\\": true\\n }\\n ],\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\"\\n}","type":"json"}]', + 'title' => 'ListConsumerGroupSubscriptions', + ], + 'GetConsumerGroupSubscription' => [ + 'summary' => 'Queries the subscriptions of a consumer group.', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions/{topicName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-uqm32kqyy11', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the consumer group whose subscriptions you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'common_dev', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the topic to which the consumer group subscribes.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'mq003', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<SubscriptionDetailDTO>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '157DF7D4-53FB-58C6-BEBC-A9400E7EF68A', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The subscriptions.'."\n", + 'type' => 'object', + 'properties' => [ + 'subscriptionDTO' => [ + 'description' => 'The subscription details.'."\n", + 'type' => 'object', + 'properties' => [ + 'consumerGroupId' => [ + 'title' => '消费者组', + 'description' => 'The consumer group ID.'."\n", + 'type' => 'string', + 'example' => 'GID_inspector_group', + ], + 'topicName' => [ + 'title' => '订阅主题', + 'description' => 'The topic to which the consumer group subscribes.'."\n", + 'type' => 'string', + 'example' => 'Topic_normal_inspector', + ], + 'messageModel' => [ + 'title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', + 'description' => 'The consumption mode of the consumer group. Valid values:'."\n" + ."\n" + .'* BROADCASTING: broadcasting consumption'."\n" + .'* CLUSTERING: clustering consumption'."\n", + 'type' => 'string', + 'example' => 'BROADCASTING', + ], + 'subscriptionStatus' => [ + 'title' => '订阅状态,SubscriptionStatusEnum[ONLINE(在线),OFFLINE(离线),code,desc]', + 'description' => 'The subscription status. Valid values:'."\n" + ."\n" + .'* ONLINE: The consumer group is online. If the consumer group contains multiple consumers, this value is returned if at least one of the consumers is online.'."\n" + .'* OFFLINE: The consumer group is offline. If the consumer group contains multiple consumers, this value is returned only if all consumers are offline.'."\n", + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'filterExpression' => [ + 'title' => '过滤表达式', + 'description' => 'The filter expression.'."\n", + 'type' => 'string', + 'example' => '*', + ], + 'filterExpressionType' => [ + 'title' => '过滤表达式类型,SubscriptionExpressionTypeEnum[SQL(SQL过滤),TAG(TAG过滤),UNSPECIFIED(FILTER_TYPE_UNSPECIFIED 过滤类型未指定),code,desc]', + 'description' => 'The type of the filter expression. Valid values:'."\n" + ."\n" + .'* SQL: filters messages by using SQL expressions.'."\n" + .'* TAG: filters messages by using tags.'."\n", + 'type' => 'string', + 'example' => 'UNSPECIFIED', + ], + ], + ], + 'connectionDTO' => [ + 'description' => 'The connection details.'."\n", + 'type' => 'object', + 'properties' => [ + 'clientId' => [ + 'title' => '客户端ID', + 'description' => 'The client ID.'."\n", + 'type' => 'string', + 'example' => '192.168.50.191@19908#-2093249153#1534215565#40385215750900', + ], + 'hostname' => [ + 'title' => '主机名', + 'description' => 'The host name.'."\n", + 'type' => 'string', + 'example' => 'nginx', + ], + 'egressIp' => [ + 'title' => '宿主机IP/公网出网IP', + 'description' => 'The public IP address of the host.'."\n", + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'language' => [ + 'title' => '客户端语言', + 'description' => 'The language used by the client.'."\n", + 'type' => 'string', + 'example' => 'zh', + ], + 'version' => [ + 'title' => '客户端版本', + 'description' => 'The client version.'."\n", + 'type' => 'string', + 'example' => '1.0.0', + ], + 'messageModel' => [ + 'title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', + 'description' => 'The consumption mode of the consumer group. Valid values:'."\n" + ."\n" + .'* BROADCASTING: broadcasting consumption'."\n" + .'* CLUSTERING: clustering consumption'."\n", + 'type' => 'string', + 'example' => 'BROADCASTING', + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Instance.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"157DF7D4-53FB-58C6-BEBC-A9400E7EF68A\\",\\n \\"success\\": true,\\n \\"data\\": [\\n {\\n \\"subscriptionDTO\\": {\\n \\"consumerGroupId\\": \\"GID_inspector_group\\",\\n \\"topicName\\": \\"Topic_normal_inspector\\",\\n \\"messageModel\\": \\"BROADCASTING\\",\\n \\"subscriptionStatus\\": \\"ONLINE\\",\\n \\"filterExpression\\": \\"*\\",\\n \\"filterExpressionType\\": \\"UNSPECIFIED\\"\\n },\\n \\"connectionDTO\\": {\\n \\"clientId\\": \\"192.168.50.191@19908#-2093249153#1534215565#40385215750900\\",\\n \\"hostname\\": \\"nginx\\",\\n \\"egressIp\\": \\"xx.xx.xx.xx\\",\\n \\"language\\": \\"zh\\",\\n \\"version\\": \\"1.0.0\\",\\n \\"messageModel\\": \\"BROADCASTING\\"\\n }\\n }\\n ],\\n \\"code\\": \\"Instance.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'GetConsumerGroupSubscription', + 'translator' => 'machine', + ], + 'DeleteConsumerGroupSubscription' => [ + 'summary' => 'Deletes the subscriptions of a consumer group.', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the consumer group for which you want to delete subscriptions.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CID-TEST', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'topic_test', + ], + ], + [ + 'name' => 'filterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the filter expression. Valid values:'."\n" + ."\n" + .'* SQL: filters messages by using SQL expressions.'."\n" + .'* TAG: filters messages by using tags.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'TAG' => '', + 'SQL' => '', + ], + 'example' => 'TAG', + ], + ], + [ + 'name' => 'filterExpression', + 'in' => 'query', + 'schema' => [ + 'description' => 'The filter expression.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '*', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '723CDA5C-E25C-5EAF-9601-******', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"723CDA5C-E25C-5EAF-9601-08C286DF8A4D\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'DeleteConsumerGroupSubscription', + 'translator' => 'machine', + ], + 'ListConsumerConnections' => [ + 'summary' => 'Queries the connections of a specific consumer client.', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/connections', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREons0MOUAZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-uax32mf9h1f', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The consumer group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'GID_TEST_STOCK_OPEND_GW', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'query', + 'schema' => [ + 'title' => 'lite类型的topic名称', + 'type' => 'string', + 'example' => 'test1', + ], + ], + [ + 'name' => 'liteTopicName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Lite消息队列主题名称', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<ConsumerConnectionsDTO>', + 'description' => 'Result<ConsumerConnectionsDTO>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '区域ID', + 'description' => 'The ID of the region in which the instance resides.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'consumerGroupId' => [ + 'title' => '主题名称', + 'description' => 'The consumer group ID.'."\n", + 'type' => 'string', + 'example' => 'CID-TEST', + ], + 'connections' => [ + 'title' => '客户端连接列表', + 'description' => 'The client connection list', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'clientId' => [ + 'title' => '客户端ID', + 'description' => 'The ID of the client.', + 'type' => 'string', + 'example' => '172.17.135.197@17392#1936705963#551717232#9873695589062458', + ], + 'hostname' => [ + 'title' => '客户端IP', + 'description' => 'The `hostname` of the cloud-native box.'."\n", + 'type' => 'string', + 'example' => 'vos', + ], + 'egressIp' => [ + 'title' => '宿主机IP/公网出网IP', + 'description' => 'Host IP/Public IP', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'language' => [ + 'title' => '客户端语言', + 'description' => 'The language of the client.', + 'type' => 'string', + 'example' => 'java', + ], + 'version' => [ + 'title' => '客户端版本', + 'description' => 'The version of the client.', + 'type' => 'string', + 'example' => '1.0', + ], + 'messageModel' => [ + 'title' => '消费模式,ConsumptionModelEnum[BROADCASTING(广播模式),CLUSTERING(集群模式),code,desc]', + 'description' => 'Consumption Mode'."\n" + .'- BROADCASTING'."\n" + .'- CLUSTERING', + 'type' => 'string', + 'example' => 'BROADCASTING', + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The returned error code.'."\n", + 'type' => 'string', + 'example' => 'MissingPageNumber', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"connections\\": [\\n {\\n \\"clientId\\": \\"172.17.135.197@17392#1936705963#551717232#9873695589062458\\",\\n \\"hostname\\": \\"vos\\",\\n \\"egressIp\\": \\"xx.xx.xx.xx\\",\\n \\"language\\": \\"java\\",\\n \\"version\\": \\"1.0\\",\\n \\"messageModel\\": \\"BROADCASTING\\"\\n }\\n ]\\n },\\n \\"code\\": \\"MissingPageNumber\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'ListConsumerConnections', + ], + 'GetConsumerGroupLag' => [ + 'summary' => 'Query Consumer Group Backlog Information', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/lag', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '145824', + 'abilityTreeNodes' => [ + 'FEATUREonsJCXOZ6', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-2r42vrvde0j', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The consumer Group ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'CID-TEST', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The topic name.'."\n", + 'example' => 'normal-topic-1', + ], + ], + [ + 'name' => 'liteTopicName', + 'in' => 'query', + 'schema' => [ + 'title' => '轻量主题名称', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<ConsumerGroupLagDTO>', + 'description' => 'Result<ConsumerGroupLagDTO>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'F5764C40-FB8C-53AE-B95D-96AB3D0E9375', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '区域ID', + 'description' => 'Region ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'consumerGroupId' => [ + 'title' => '消费组ID', + 'description' => 'Consumer Group ID', + 'type' => 'string', + 'example' => 'CID-TEST', + ], + 'totalLag' => [ + 'title' => '整体堆积量', + 'description' => 'Total lag count', + 'type' => 'object', + 'properties' => [ + 'readyCount' => [ + 'title' => '就绪消息量', + 'description' => 'Ready message count', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'inflightCount' => [ + 'title' => '处理中消息量', + 'description' => 'The number of messages being consumed.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'deliveryDuration' => [ + 'title' => '投递延迟时间', + 'description' => 'Delivery delay time, in seconds', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'lastConsumeTimestamp' => [ + 'title' => '最新消费时间', + 'description' => 'Last consumption time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1735629607846', + ], + ], + ], + 'topicLagMap' => [ + 'title' => '各主题堆积量', + 'description' => 'Backlog for each topic', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'readyCount' => [ + 'title' => '就绪消息量', + 'description' => 'Ready message count', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'inflightCount' => [ + 'title' => '处理中消息量', + 'description' => 'The number of messages being consumed.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'deliveryDuration' => [ + 'title' => '投递延迟时间', + 'description' => 'Delivery delay time, in seconds', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'lastConsumeTimestamp' => [ + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1735629607846', + 'description' => 'lastConsumeTimestamp', + ], + ], + 'description' => 'Total message count', + ], + ], + 'topicName' => [ + 'title' => '订阅的topic名称', + 'type' => 'string', + 'example' => 'test1', + ], + 'liteTopicLagMap' => [ + 'title' => '轻量主题的消费堆积', + 'type' => 'object', + 'additionalProperties' => [ + 'title' => 'lite类型topic的消费堆积', + 'type' => 'object', + 'properties' => [ + 'readyCount' => [ + 'title' => '堆积消息量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'deliveryDuration' => [ + 'title' => '投递延迟时间，单位：秒', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code', + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message', + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code', + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F5764C40-FB8C-53AE-B95D-96AB3D0E9375\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"totalLag\\": {\\n \\"readyCount\\": 1,\\n \\"inflightCount\\": 1,\\n \\"deliveryDuration\\": 12,\\n \\"lastConsumeTimestamp\\": 1735629607846\\n },\\n \\"topicLagMap\\": {\\n \\"key\\": {\\n \\"readyCount\\": 1,\\n \\"inflightCount\\": 1,\\n \\"deliveryDuration\\": 12,\\n \\"lastConsumeTimestamp\\": 1735629607846\\n }\\n },\\n \\"topicName\\": \\"test1\\",\\n \\"liteTopicLagMap\\": {\\n \\"key\\": {\\n \\"readyCount\\": 300,\\n \\"deliveryDuration\\": 30\\n }\\n }\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'GetConsumerGroupLag', + 'translator' => 'machine', + ], + 'GetConsumerStack' => [ + 'summary' => 'Queries the stack information about a consumer.', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/stack', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-tl32upjeb08', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The consumer Group ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'GID_TT_TASK', + ], + ], + [ + 'name' => 'clientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '172.26.76.48@Lqd7dImlp9KJ5V84', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<ConsumerJstackDTO>', + 'description' => 'The result.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '30F2CBC7-F69D-5D78-9661-0254C9E1FBFA', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '区域ID', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'consumerGroupId' => [ + 'title' => '主题名称', + 'description' => 'The ID of the consumer group.'."\n", + 'type' => 'string', + 'example' => 'CID-TEST', + ], + 'stacks' => [ + 'title' => '堆栈信息', + 'description' => 'Stack Information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Consume stack information.', + 'type' => 'object', + 'properties' => [ + 'thread' => [ + 'title' => '线程ID', + 'description' => 'Thread id.', + 'type' => 'string', + 'example' => '123', + ], + 'tracks' => [ + 'title' => '堆栈信息', + 'description' => 'Stack Information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Stack Information.', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"30F2CBC7-F69D-5D78-9661-0254C9E1FBFA\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"stacks\\": [\\n {\\n \\"thread\\": \\"123\\",\\n \\"tracks\\": [\\n \\"xxx\\"\\n ]\\n }\\n ]\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'GetConsumerStack', + ], + 'ResetConsumeOffset' => [ + 'summary' => 'Resets the consumer offset of a consumer group. If you reset a consumer offset, the offset from which a consumer starts to consume messages is changed. If faults occur or wrong messages are consumed during message consumption, you can reset the consumer offset to roll back the consumption to a specific offset for reconsumption. You can also reset the consumer offset to the latest offset and temporarily leave the accumulated messages unhandled.', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeOffsets/{topicName}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-tl32ue44x0g', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The consumer group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dolphin_status', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'AMZN_REPORT_TOPIC', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'resetType' => [ + 'title' => '重置方式,ConsumeOffsetResetTypeEnum[LATEST_OFFSET(最新位点),SPECIFIED_TIME(指定时间),code,desc]', + 'description' => 'The method that is used to reset the consumer offset. Valid values: LATEST_OFFSET and SPECIFIED_TIME.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'LATEST_OFFSET', + ], + 'resetTime' => [ + 'title' => '重置时间', + 'description' => 'The time when the consumer offset is reset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-22 12:17:08', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Void>', + 'description' => 'Result'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F9A95891-EAD4-5A2B-8A30-676CD18921AF', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The returned error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The returned error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The returned HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The returned dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The returned dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F9A95891-EAD4-5A2B-8A30-676CD18921AF\\",\\n \\"success\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'ResetConsumeOffset', + ], + 'ListMessages' => [ + 'summary' => 'Queries messages.', + 'path' => '/instances/{instanceId}/topics/{topicName}/messages', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsNPGYUW', + 'FEATUREonsKQSI06', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-zvp2vtypu05', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_delay_queue', + ], + ], + [ + 'name' => 'messageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Message Id.', + 'type' => 'string', + 'required' => false, + 'example' => '7F00000100207A4F0F294A938F7807AE', + ], + ], + [ + 'name' => 'messageKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'Message key.', + 'type' => 'string', + 'required' => false, + 'example' => 'XSCBillResult', + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024-09-09 08:00:00', + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024-09-09 09:00:00', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The page number. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'scrollId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The scroll ID of the request.'."\n" + ."\n" + .'You do not need to configure this parameter for the first page. This parameter is included in the pagination request based on the result returned for the first page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00', + ], + ], + [ + 'name' => 'liteTopicName', + 'in' => 'query', + 'schema' => [ + 'title' => '轻量主题名称', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MyPage<MessageDTO>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'title' => '当前页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页大小', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'totalCount' => [ + 'title' => '总记录数', + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'list' => [ + 'title' => '分页数据', + 'description' => 'The pagination information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The message information.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '区域ID', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'topicName' => [ + 'title' => '主题名称', + 'description' => 'The name of the topic.'."\n", + 'type' => 'string', + 'example' => 'topic_test', + ], + 'messageId' => [ + 'title' => '消息ID', + 'description' => 'Message Id.', + 'type' => 'string', + 'example' => '7F000001000114B4340C5ABF94500079', + ], + 'bornTime' => [ + 'title' => '生成时间', + 'description' => 'Message born time.', + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + 'storeTime' => [ + 'title' => '存储时间', + 'description' => 'Message store time.', + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + 'body' => [ + 'title' => '消息体', + 'description' => 'Message body.', + 'type' => 'string', + 'example' => '{}', + ], + 'bodySize' => [ + 'description' => 'Message body size.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'bornHost' => [ + 'title' => '消息来自哪里', + 'description' => 'The client on which messages are produced.'."\n", + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'storeHost' => [ + 'title' => '消息存储位置', + 'description' => 'The broker on which messages are stored.'."\n", + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'messageType' => [ + 'title' => '消息类型', + 'description' => 'Message type.', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'messageTag' => [ + 'title' => '标签列表', + 'description' => 'The message tag.'."\n", + 'type' => 'string', + 'example' => 'xx', + ], + 'messageGroup' => [ + 'title' => '以前的shardingkey，顺序消息独有', + 'description' => 'The message group. This parameter is returned only for ordered messages.'."\n", + 'type' => 'string', + 'example' => 'xx', + ], + 'messageKeys' => [ + 'title' => '业务标识', + 'description' => 'Message keys.', + 'type' => 'array', + 'items' => [ + 'description' => 'Message key.', + 'type' => 'string', + 'example' => 'xx', + ], + ], + 'userProperties' => [ + 'title' => '用户属性', + 'description' => 'Message user properties.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'Message user properties.', + 'example' => 'xx', + ], + ], + 'liteTopicName' => [ + 'title' => '轻量主题名称', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + ], + 'scrollId' => [ + 'description' => 'The scroll ID of the request.'."\n" + ."\n" + .'The ID is automatically generated by the system. The result can be paginated only if this parameter is included in the pagination request.'."\n", + 'type' => 'string', + 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00', + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 50,\\n \\"totalCount\\": 0,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageId\\": \\"7F000001000114B4340C5ABF94500079\\",\\n \\"bornTime\\": \\"2023-03-22 12:17:08\\",\\n \\"storeTime\\": \\"2023-03-22 12:17:08\\",\\n \\"body\\": \\"{}\\",\\n \\"bodySize\\": 100,\\n \\"bornHost\\": \\"xx.xx.xx.xx\\",\\n \\"storeHost\\": \\"xx.xx.xx.xx\\",\\n \\"messageType\\": \\"NORMAL\\",\\n \\"messageTag\\": \\"xx\\",\\n \\"messageGroup\\": \\"xx\\",\\n \\"messageKeys\\": [\\n \\"xx\\"\\n ],\\n \\"userProperties\\": {\\n \\"key\\": \\"xx\\"\\n },\\n \\"liteTopicName\\": \\"abc\\"\\n }\\n ],\\n \\"scrollId\\": \\"B13D0B07-F24B-4790-88D8-D47A38063D00\\"\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'ListMessages', + ], + 'GetMessageDetail' => [ + 'summary' => 'Obtains the details of a specific message.', + 'path' => '/instances/{instanceId}/topics/{topicName}/messages/{messageId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsNPGYUW', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-lbj31fs790d', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flink_test', + ], + ], + [ + 'name' => 'messageId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The message ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0A792FDB001F7591083D30ADB1DA11D5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MessageDTO>', + 'description' => 'The result.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FAEBD71F-E839-52F9-BD7B-8F1290525841', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '区域ID', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'topicName' => [ + 'title' => '主题名称', + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'example' => 'topic_test', + ], + 'messageId' => [ + 'title' => '消息ID', + 'description' => 'The message ID.'."\n", + 'type' => 'string', + 'example' => '01BE87E485F0C7808C04543CAF00000001', + ], + 'bornTime' => [ + 'title' => '生成时间', + 'description' => 'The time when the message was generated.'."\n", + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + 'storeTime' => [ + 'title' => '存储时间', + 'description' => 'The time when the message was stored.'."\n", + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + 'body' => [ + 'title' => '消息体', + 'description' => 'The message body.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'bodySize' => [ + 'description' => 'The size of the message body.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'bornHost' => [ + 'title' => '消息来自哪里', + 'description' => 'The client on which the message was produced.'."\n", + 'type' => 'string', + 'example' => 'xxx.xx.xxx.xx', + ], + 'storeHost' => [ + 'title' => '消息存储位置', + 'description' => 'The broker on which the message was stored.'."\n", + 'type' => 'string', + 'example' => 'xxx.xx.xxx.xx', + ], + 'messageType' => [ + 'title' => '消息类型', + 'description' => 'The message type.'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'messageTag' => [ + 'title' => '标签列表', + 'description' => 'The tags.'."\n", + 'type' => 'string', + 'example' => 'xx', + ], + 'messageGroup' => [ + 'title' => '以前的shardingkey，顺序消息独有', + 'description' => 'The sharding key. This parameter is returned only for ordered messages.'."\n", + 'type' => 'string', + 'example' => 'xx', + ], + 'messageKeys' => [ + 'title' => '业务标识', + 'description' => 'The message keys.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The message key.'."\n", + 'type' => 'string', + 'example' => 'xx', + ], + ], + 'userProperties' => [ + 'title' => '用户属性', + 'description' => 'The user attributes.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'xxx', + 'description' => 'The user attribute.'."\n", + ], + ], + 'systemProperties' => [ + 'description' => 'The default system attributes.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'xx', + 'description' => 'The default system attribute.'."\n", + ], + ], + 'liteTopicName' => [ + 'title' => '轻量主题名称', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FAEBD71F-E839-52F9-BD7B-8F1290525841\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageId\\": \\"01BE87E485F0C7808C04543CAF00000001\\",\\n \\"bornTime\\": \\"2023-03-22 12:17:08\\",\\n \\"storeTime\\": \\"2023-03-22 12:17:08\\",\\n \\"body\\": \\"{}\\",\\n \\"bodySize\\": 123,\\n \\"bornHost\\": \\"xxx.xx.xxx.xx\\",\\n \\"storeHost\\": \\"xxx.xx.xxx.xx\\",\\n \\"messageType\\": \\"NORMAL\\",\\n \\"messageTag\\": \\"xx\\",\\n \\"messageGroup\\": \\"xx\\",\\n \\"messageKeys\\": [\\n \\"xx\\"\\n ],\\n \\"userProperties\\": {\\n \\"key\\": \\"xxx\\"\\n },\\n \\"systemProperties\\": {\\n \\"key\\": \\"xx\\"\\n },\\n \\"liteTopicName\\": \\"abc\\"\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'GetMessageDetail', + 'translator' => 'machine', + ], + 'VerifySendMessage' => [ + 'summary' => 'Verifies the message sending feature of a specific topic on a specific instance.', + 'path' => '/instances/{instanceId}/topics/{topicName}/messages', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsB0E8FD', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-wwo32kqfm10', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'card_status_topic', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'message' => [ + 'title' => '消息内容', + 'description' => 'The message body.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'successful', + ], + 'messageTag' => [ + 'title' => '消息标签', + 'description' => 'The message tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xx', + ], + 'messageKey' => [ + 'title' => '业务标识', + 'description' => 'The message key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xx', + ], + 'liteTopicName' => [ + 'title' => '轻量主题名称', + 'type' => 'string', + 'example' => 'abc', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<String>', + 'description' => 'The result.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '3BD2C19B-66DE-59C7-B2F6-FD1BE21DC8C1', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'string', + 'example' => '0A64228900207A4F0F2931A4E0D40BE5', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'InvalidConsumerGroupId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'ConsumerGroupId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'consumerGroupId', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3BD2C19B-66DE-59C7-B2F6-FD1BE21DC8C1\\",\\n \\"success\\": true,\\n \\"data\\": \\"0A64228900207A4F0F2931A4E0D40BE5\\",\\n \\"code\\": \\"InvalidConsumerGroupId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"ConsumerGroupId\\",\\n \\"dynamicMessage\\": \\"consumerGroupId\\"\\n}","type":"json"}]', + 'title' => 'VerifySendMessage', + ], + 'VerifyConsumeMessage' => [ + 'summary' => 'Verifies the consumption status of a message in a specific topic on a specific instance.', + 'path' => '/instances/{instanceId}/topics/{topicName}/messages/{messageId}/action/verifyConsume', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-i7m2vc1vx01', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'delay_topic', + ], + ], + [ + 'name' => 'messageId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The message ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'A9FE190A59AA421ED014743DFDBF017D', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'TEST_FINANCE_STOCK_OUT_GROUP', + ], + ], + [ + 'name' => 'clientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'zeekr-settlement-server-dc555456f-v2lcg@1@1@qfvorazqns', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'The result.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5304143F-AB0E-5AB4-A227-7C5489216FD5', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5304143F-AB0E-5AB4-A227-7C5489216FD5\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'VerifyConsumeMessage', + ], + 'ListTraces' => [ + 'summary' => 'Queries the message traces of a specific topic.', + 'path' => '/instances/{instanceId}/topics/{topicName}/traces', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsNKYZ9K', + 'FEATUREonsJEU5XG', + 'FEATUREonsYT2OK3', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-tl32upjeb08', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'topic_hpms_product_price_change', + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2023-05-10 10:42:11', + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2023-05-19 10:10:09', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100000000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'queryType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* MESSAGE_ID'."\n" + .'* MESSAGE_KEY'."\n" + .'* TOPIC'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'MESSAGE_ID' => 'MESSAGE_ID', + 'MESSAGE_KEY' => 'MESSAGE_KEY', + 'TOPIC' => 'TOPIC', + ], + 'example' => 'MESSAGE_ID', + ], + ], + [ + 'name' => 'messageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The message ID.'."\n" + ."\n" + .'This parameter is required if you set queryType to MESSAGE_ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0100163E0EC1F1965C04C7906700000000', + ], + ], + [ + 'name' => 'messageKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The message key.'."\n" + ."\n" + .'This parameter is required if you set queryType to MESSAGE_ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'order_ceating', + ], + ], + [ + 'name' => 'liteTopicName', + 'in' => 'query', + 'schema' => [ + 'title' => '轻量主题名称', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'EDFF77E1-1ED1-5389-B6A8-651D9433BBE5', + ], + 'success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'totalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'list' => [ + 'description' => 'Trace list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Trace list.', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'topicName' => [ + 'description' => 'The name of the topic.'."\n", + 'type' => 'string', + 'example' => 'topic_test', + ], + 'messageId' => [ + 'description' => 'Message id.', + 'type' => 'string', + 'example' => '7F00000100207A4F0F294A938F7807AE', + ], + 'bornTime' => [ + 'description' => 'Message born time.', + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + 'messageTag' => [ + 'description' => 'Message tag.', + 'type' => 'string', + 'example' => 'xx', + ], + 'messageKeys' => [ + 'description' => 'Message keys.', + 'type' => 'array', + 'items' => [ + 'description' => 'Message key.', + 'type' => 'string', + 'example' => 'xx', + ], + ], + ], + ], + ], + ], + ], + 'httpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"EDFF77E1-1ED1-5389-B6A8-651D9433BBE5\\",\\n \\"success\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"messageId\\": \\"7F00000100207A4F0F294A938F7807AE\\",\\n \\"bornTime\\": \\"2023-03-22 12:17:08\\",\\n \\"messageTag\\": \\"xx\\",\\n \\"messageKeys\\": [\\n \\"xx\\"\\n ]\\n }\\n ]\\n },\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\"\\n}","type":"json"}]', + 'title' => 'ListTraces', + ], + 'GetTrace' => [ + 'summary' => 'Queries the trace of a specific message in a specific topic.', + 'path' => '/instances/{instanceId}/topics/{topicName}/traces/{messageId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '172963', + 'abilityTreeNodes' => [ + 'FEATUREonsNKYZ9K', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-zvp2vtypu05', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'linkedcare-image', + ], + ], + [ + 'name' => 'messageId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The message ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '012A5AB0BBEC8A000104C6342B00001ECF', + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.'."\n", + 'type' => 'string', + 'example' => '7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49', + ], + 'success' => [ + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'topicName' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'example' => 'topic_test', + ], + 'messageInfo' => [ + 'description' => 'The message information.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'instanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-u0t2ygjq505', + ], + 'topicName' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'example' => 'Topic_normal_inspector', + ], + 'messageId' => [ + 'description' => 'The message ID.', + 'type' => 'string', + 'example' => '0A79275A00207A4F0F2916C92F9A0B94', + ], + 'bornTime' => [ + 'description' => 'Message born time.', + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + 'storeTime' => [ + 'description' => 'Message store time.', + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + 'body' => [ + 'description' => 'Message body.', + 'type' => 'string', + 'example' => '{}', + ], + 'bornHost' => [ + 'description' => 'Message born host.', + 'type' => 'string', + 'example' => 'x.x.x.x', + ], + 'storeHost' => [ + 'description' => 'Message store host.', + 'type' => 'string', + 'example' => 'x.x.x.x', + ], + 'messageType' => [ + 'description' => 'Message type.', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'messageTag' => [ + 'description' => 'Message tag.', + 'type' => 'string', + 'example' => 'xx', + ], + 'messageGroup' => [ + 'description' => 'Message grpup.', + 'type' => 'string', + 'example' => 'xx', + ], + 'messageKeys' => [ + 'description' => 'Message keys.', + 'type' => 'array', + 'items' => [ + 'description' => 'Message key.', + 'type' => 'string', + 'example' => 'xx', + ], + ], + 'userProperties' => [ + 'description' => 'Message user properties.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'xx', + 'description' => 'Message user properties.', + ], + ], + 'transactionId' => [ + 'description' => 'Message transaction id.', + 'type' => 'string', + 'example' => 'xx', + ], + 'liteTopicName' => [ + 'title' => '轻量主题名称', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + 'producerInfo' => [ + 'description' => 'The producer trace.'."\n", + 'type' => 'object', + 'properties' => [ + 'records' => [ + 'description' => 'The production records.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The production record.'."\n", + 'type' => 'object', + 'properties' => [ + 'userName' => [ + 'description' => 'Producer name.', + 'type' => 'string', + 'example' => 'xxx', + ], + 'clientHost' => [ + 'description' => 'Client host.', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'produceTime' => [ + 'description' => 'Producer time.', + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + 'produceDuration' => [ + 'description' => 'Producer duration.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'produceStatus' => [ + 'description' => 'Producer status.', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'arriveTime' => [ + 'description' => 'Arrive time.', + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + 'messageSource' => [ + 'description' => 'Message source.', + 'type' => 'string', + 'example' => 'CONSOLE', + ], + 'dlqOriginTopic' => [ + 'description' => 'Dead-letter queue topic.', + 'type' => 'string', + 'example' => 'test_topic', + ], + 'dlqOriginMessageId' => [ + 'description' => 'Dead-letter queue message ID.', + 'type' => 'string', + 'example' => '0A79275A00207A4F0F2916C92F9A0B94', + ], + 'recallTime' => [ + 'description' => 'The time when the scheduled message withdrawal request was initiated', + 'type' => 'string', + 'example' => '2023-03-22 12:17:08'."\n", + ], + ], + ], + ], + ], + ], + 'brokerInfo' => [ + 'description' => 'The broker trace.'."\n", + 'type' => 'object', + 'properties' => [ + 'presetDelayTime' => [ + 'description' => 'Preset delivery time.', + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + 'delayStatus' => [ + 'description' => 'Delay status.', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'operations' => [ + 'description' => 'Operation list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Operation list.', + 'type' => 'object', + 'properties' => [ + 'operateType' => [ + 'description' => 'Operation type.', + 'type' => 'string', + 'example' => 'ADD', + ], + 'operateTime' => [ + 'description' => 'Operation time.', + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + ], + ], + ], + 'recallResult' => [ + 'description' => 'Withdraw scheduled message request result', + 'type' => 'string', + 'example' => 'RECALL_OK', + ], + ], + ], + 'consumerInfos' => [ + 'description' => 'Consumer trace info.', + 'type' => 'array', + 'items' => [ + 'description' => 'Consumer trace info.', + 'type' => 'object', + 'properties' => [ + 'consumerGroupId' => [ + 'description' => 'The consumer group ID.'."\n", + 'type' => 'string', + 'example' => 'GID_inspector_group', + ], + 'records' => [ + 'description' => 'Consumer record list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Consumer record list.', + 'type' => 'object', + 'properties' => [ + 'userName' => [ + 'description' => 'Consumer name.', + 'type' => 'string', + 'example' => 'test', + ], + 'clientHost' => [ + 'description' => 'Client host.', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'fifoEnable' => [ + 'description' => 'Whether to consume fifo.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'consumeStatus' => [ + 'description' => 'Consume status.', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'operations' => [ + 'description' => 'Operation list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Operation list.', + 'type' => 'object', + 'properties' => [ + 'operateType' => [ + 'description' => 'Operation type.', + 'type' => 'string', + 'example' => 'ADD', + ], + 'operateTime' => [ + 'description' => 'Operation time.', + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + 'invisibleTime' => [ + 'description' => 'Invisible time, milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'deadMessage' => [ + 'description' => 'Whether it is a dead letter message.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'popCk' => [ + 'description' => 'POP_CK', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + 'consumeStatus' => [ + 'description' => 'Consume status.', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'deadMessage' => [ + 'description' => 'Whether it is a dead letter message.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'deadLetterInfo' => [ + 'description' => 'Dead letter info.', + 'type' => 'object', + 'properties' => [ + 'topicName' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'example' => 'Register_Sync', + ], + 'messageId' => [ + 'description' => 'MessageId.', + 'type' => 'string', + 'example' => '7F000001001F7A4F0F29463F0376047D', + ], + 'toDlqTime' => [ + 'description' => 'Arrival time in the dead letter queue.', + 'type' => 'string', + 'example' => '2023-03-22 12:17:08', + ], + ], + ], + ], + ], + ], + ], + ], + 'code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'InvalidConsumerGroupId', + ], + 'message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'GetTrace', + ], + 'CreateInstanceAccount' => [ + 'summary' => 'Creates an account that is used to access an instance.', + 'path' => '/instances/{instanceId}/accounts', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'password' => [ + 'title' => '用户密码', + 'description' => 'The password of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + ], + 'username' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.'."\n", + 'type' => 'string', + 'example' => '3AE0999C-8DBA-5CEE-8D9A-BE8D4A90DF8D', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned result.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code returned if the call failed.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'No permission details', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3AE0999C-8DBA-5CEE-8D9A-BE8D4A90DF8D\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'CreateInstanceAccount', + ], + 'UpdateInstanceAccount' => [ + 'summary' => 'Updates the information about a specific account in a specific instance.', + 'path' => '/instances/{instanceId}/accounts/{username}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '209887', + 'abilityTreeNodes' => [ + 'FEATUREonsGA7IC4', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'username', + 'in' => 'path', + 'schema' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'accountStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the account.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* DISABLE'."\n" + .'* ENABLE'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DISABLE' => '', + 'ENABLE' => '', + ], + 'example' => 'ENABLE', + ], + ], + [ + 'name' => 'password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned result.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Instance.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Instance.NotFound\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'UpdateInstanceAccount', + ], + 'DeleteInstanceAccount' => [ + 'summary' => 'Delete access control ACL user', + 'path' => '/instances/{instanceId}/accounts/{username}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'username', + 'in' => 'path', + 'schema' => [ + 'description' => 'Account name', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n" + ."\n", + 'type' => 'string', + 'example' => '157DF7D4-53FB-58C6-BEBC-A9400E7EF68A', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Instance.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"157DF7D4-53FB-58C6-BEBC-A9400E7EF68A\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Instance.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'DeleteInstanceAccount', + 'translator' => 'machine', + ], + 'ListInstanceAccount' => [ + 'summary' => 'Queries the accounts that are used to access a specific instance.', + 'path' => '/instances/{instanceId}/accounts', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '209888', + 'abilityTreeNodes' => [ + 'FEATUREonsGA7IC4', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '10', + 'example' => '10', + ], + ], + [ + 'name' => 'username', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'accountType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account type.'."\n" + .' - CUSTOMER'."\n" + .' - DEFAULT', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CUSTOMER' => '', + 'DEFAULT' => '', + ], + 'example' => 'CUSTOMER', + ], + ], + [ + 'name' => 'accountStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the account.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* DISABLE'."\n" + .'* ENABLE'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DISABLE' => '', + 'ENABLE' => '', + ], + 'example' => 'ENABLE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MyPage<InstanceAccountDTO>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'title' => '当前页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页大小', + 'description' => 'Number of items per page.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'totalCount' => [ + 'title' => '总记录数', + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'list' => [ + 'title' => '分页数据', + 'description' => 'The pagination information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The account information.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => 'regionId', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例id', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'username' => [ + 'title' => '用户名', + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'accountType' => [ + 'title' => '账号类型', + 'description' => 'The account type.'."\n" + .' - CUSTOMER'."\n" + .' - DEFAULT', + 'type' => 'string', + 'enumValueTitles' => [ + 'CUSTOMER' => '', + 'DEFAULT' => '', + ], + 'example' => 'CUSTOMER', + ], + 'accountStatus' => [ + 'title' => '账号状态', + 'description' => 'The status of the account.'."\n" + .'Valid values:'."\n" + .' - DISABLE'."\n" + .' - ENABLE', + 'type' => 'string', + 'enumValueTitles' => [ + 'DISABLE' => '', + 'ENABLE' => '', + ], + 'example' => 'ENABLE', + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C115601B-8736-5BBF-AC99-7FEAE1245A80\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 24,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"username\\": \\"test\\",\\n \\"accountType\\": \\"CUSTOMER\\",\\n \\"accountStatus\\": \\"ENABLE\\"\\n }\\n ]\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'ListInstanceAccount', + ], + 'GetInstanceAccount' => [ + 'summary' => 'Obtains the account used to access a specific instance.', + 'path' => '/instances/{instanceId}/account', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '150942', + 'abilityTreeNodes' => [ + 'FEATUREonsGA7IC4', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The instance ID.'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-20p36ja4m0y', + ], + ], + [ + 'name' => 'username', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the account.'."\n" + ."\n" + .'If you do not configure this parameter, the default username of the instance is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID, each request\'s ID is unique and can be used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => 'B5C59E80-FCFC-5796-ABE4-D39EAAE578E4', + ], + 'success' => [ + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'username' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'password' => [ + 'description' => 'The password of the account.'."\n", + 'type' => 'string', + 'example' => '*************', + ], + 'accountStatus' => [ + 'type' => 'string', + 'description' => 'The status of the account.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* DISABLE'."\n" + .'* ENABLE'."\n", + 'example' => 'ENABLE', + ], + ], + ], + 'code' => [ + 'description' => 'The error code.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'description' => 'The error message.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'description' => 'The dynamic error code.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ConsumerGroupId', + ], + 'dynamicMessage' => [ + 'description' => 'The dynamic error message.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B5C59E80-FCFC-5796-ABE4-D39EAAE578E4\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"username\\": \\"xxx\\",\\n \\"password\\": \\"*************\\",\\n \\"accountStatus\\": \\"ENABLE\\"\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"ConsumerGroupId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'GetInstanceAccount', + 'translator' => 'machine', + ], + 'CreateInstanceAcl' => [ + 'summary' => 'Creates an access control list (ACL) in a specific instance.', + 'path' => '/instances/{instanceId}/acl/account/{username}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '209893', + 'abilityTreeNodes' => [ + 'FEATUREonsO60XBD', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'username', + 'in' => 'path', + 'schema' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'abc', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'resourceType' => [ + 'title' => '授权的资源列表', + 'description' => 'The type of the resource on which you want to grant permissions.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Group'."\n" + .'* Topic'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Group' => '', + 'Topic' => '', + ], + 'example' => 'Topic', + 'enum' => [ + 'Topic', + 'Group', + ], + ], + 'resourceName' => [ + 'title' => '授权资源名称', + 'description' => 'The name of the resource on which you want to grant permissions.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'decision' => [ + 'title' => '决策,DecisionEnum[ALLOW,DENY,type,desc]', + 'description' => 'The decision result of the authorization.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Deny'."\n" + .'* Allow'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Deny' => '', + 'Allow' => '', + ], + 'example' => 'Allow', + 'enum' => [ + 'Allow', + 'Deny', + ], + ], + 'actions' => [ + 'description' => 'The type of operations that can be performed on the resource.'."\n" + ."\n" + .'The following types of operations are supported based on the resource type:'."\n" + ."\n" + .'* Topic: Pub, Sub, and Pub|Sub'."\n" + .'* Group: Sub'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Sub: subscribe'."\n" + .'* Pub|Sub: publish and subscribe'."\n" + .'* Pub: publish'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The type of operations that can be performed on the resource.'."\n" + ."\n" + .'The following types of operations are supported based on the resource type:'."\n" + ."\n" + .'* Topic: Pub, Sub, and Pub|Sub'."\n" + .'* Group: Sub'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Pub', + ], + 'required' => true, + 'enumValueTitles' => [ + 'Sub' => '', + 'Pub|Sub' => '', + 'Pub' => '', + ], + 'example' => 'Pub', + ], + 'ipWhitelists' => [ + 'description' => 'The IP addresses in the whitelist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address in the whitelist. IP addresses and CIDR blocks are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0.0/0', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'The result.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5F88833', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7E8AE3A-219B-52EE-BE32-4036F5F88833\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'CreateInstanceAcl', + 'translator' => 'machine', + ], + 'UpdateInstanceAcl' => [ + 'summary' => 'Updates the permissions on the resources of a specific instance for a specific user.', + 'path' => '/instances/{instanceId}/acl/account/{username}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '209892', + 'abilityTreeNodes' => [ + 'FEATUREonsO60XBD', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'username', + 'in' => 'path', + 'schema' => [ + 'description' => 'The username.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'resourceType' => [ + 'title' => '授权的资源列表,ResourceTypeEnum[TOPIC,GROUP,code,desc]', + 'description' => 'The type of the resource on which you want to grant permissions.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Group'."\n" + .'* Topic'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Group' => '', + 'Topic' => '', + ], + 'example' => 'Topic', + ], + 'resourceName' => [ + 'title' => '授权资源名称', + 'description' => 'The name of the resource on which you want to grant permissions.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'actions' => [ + 'description' => 'The following types of operations are supported based on the resource type:'."\n" + ."\n" + .'* Topic: Pub, Sub, and Pub|Sub'."\n" + .'* Group: Sub'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Sub: subscribe'."\n" + .'* Pub|Sub: publish and subscribe'."\n" + .'* Pub: publish'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The following types of operations are supported based on the resource type:'."\n" + ."\n" + .'* Topic: Pub, Sub, and Pub|Sub'."\n" + .'* Group: Sub'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Pub', + ], + 'required' => false, + 'enumValueTitles' => [ + 'Sub' => '', + 'Pub|Sub' => '', + 'Pub' => '', + ], + 'example' => 'Pub', + 'title' => '', + ], + 'decision' => [ + 'title' => '决策,DecisionEnum[ALLOW,DENY,type,desc]', + 'description' => 'The decision result of the authorization.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Deny'."\n" + .'* Allow'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Deny' => '', + 'Allow' => '', + ], + 'example' => 'Allow', + ], + 'ipWhitelists' => [ + 'title' => 'ip白名单', + 'description' => 'The IP addresses in the whitelist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address in the whitelist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0.0/0', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C115601B-8736-5BBF-AC99-7FEAE1245A80\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'UpdateInstanceAcl', + ], + 'DeleteInstanceAcl' => [ + 'summary' => 'Deletes the permissions of a specific account of an instance.', + 'path' => '/instances/{instanceId}/acl/account/{username}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'username', + 'in' => 'path', + 'schema' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource on which the permissions are granted.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Group'."\n" + .'* Topic'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Group' => 'Group', + 'Topic' => 'Topic', + ], + 'example' => 'Topic', + ], + ], + [ + 'name' => 'resourceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource on which the permissions are granted.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'The result.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7358418D-83BD-507A-8079-*****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied due to the reason that the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7358418D-83BD-507A-8079-611C63E05674\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'DeleteInstanceAcl', + 'translator' => 'machine', + ], + 'ListInstanceAcl' => [ + 'summary' => 'Queries the access control lists (ACLs) of an instance.', + 'path' => '/instances/{instanceId}/acl', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '209895', + 'abilityTreeNodes' => [ + 'FEATUREonsO60XBD', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '10', + 'example' => '10', + ], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => [ + 'description' => 'The condition that you specify to filter the ACLs. If you do not specify this parameter, all ACLs are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CID-TEST', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MyPage<InstanceAclDTO>>', + 'description' => 'The result.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DA4D2F89-E2C8-5F04-936B-60D55B055FA7', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'title' => '当前页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页大小', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'totalCount' => [ + 'title' => '总记录数', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'list' => [ + 'title' => '分页数据', + 'description' => 'The pagination information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ACL.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '区域ID', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'aclType' => [ + 'title' => '访问类型', + 'description' => 'The ACL type.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* APACHE: open source ACL.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'APACHE' => '', + ], + 'example' => 'APACHE', + ], + 'username' => [ + 'title' => '访问秘钥', + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'resourceType' => [ + 'title' => '资源类型', + 'description' => 'The resource type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Group'."\n" + .'* Topic'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Group' => '', + 'Topic' => '', + ], + 'example' => 'Topic', + ], + 'resourceName' => [ + 'title' => '资源名称', + 'description' => 'The resource name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'decision' => [ + 'title' => '决策,DecisionEnum[ALLOW,DENY,type,desc]', + 'description' => 'The decision result.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Deny: Access is denied.'."\n" + .'* Allow: Access is allowed.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Deny' => '', + 'Allow' => '', + ], + 'example' => 'Allow', + ], + 'actions' => [ + 'description' => 'The types of the operations that are allowed by the ACL.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the operation that is allowed by the ACL.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* SUB: message subscription.'."\n" + .'* Pub: message sending.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Sub' => '', + 'Pub' => '', + ], + 'example' => 'Pub', + ], + ], + 'ipWhitelists' => [ + 'title' => 'ip白名单', + 'description' => 'The IP address whitelists.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address whitelist.'."\n", + 'type' => 'string', + 'example' => '0.0.0.0/0', + ], + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied due to the reason that the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DA4D2F89-E2C8-5F04-936B-60D55B055FA7\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 24,\\n \\"list\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"aclType\\": \\"APACHE\\",\\n \\"username\\": \\"test\\",\\n \\"resourceType\\": \\"Topic\\",\\n \\"resourceName\\": \\"test\\",\\n \\"decision\\": \\"Allow\\",\\n \\"actions\\": [\\n \\"Pub\\"\\n ],\\n \\"ipWhitelists\\": [\\n \\"0.0.0.0/0\\"\\n ]\\n }\\n ]\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'ListInstanceAcl', + ], + 'GetInstanceAcl' => [ + 'summary' => 'Queries information about the access control list (ACL) of an instance.', + 'path' => '/instances/{instanceId}/acl/account/{username}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '263406', + 'abilityTreeNodes' => [ + 'FEATUREonsO60XBD', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'username', + 'in' => 'path', + 'schema' => [ + 'description' => 'The username.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'abc', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource on which you want to grant permissions.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Group'."\n" + .'* Topic'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Group' => '', + 'Topic' => '', + ], + 'example' => 'Topic', + ], + ], + [ + 'name' => 'resourceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource on which you want to grant permissions.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID'."\n", + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'aclType' => [ + 'description' => 'The authentication type of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* apache_acl: open source access control list (ACL)'."\n" + .'* default: the default account of the instance'."\n", + 'type' => 'string', + 'example' => 'apache_acl', + ], + 'username' => [ + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => 'abc', + ], + 'resourceType' => [ + 'description' => 'The type of the resource on which the permissions are granted.'."\n", + 'type' => 'string', + 'example' => 'Topic', + ], + 'resourceName' => [ + 'description' => 'The name of the resource on which the permissions are granted.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'decision' => [ + 'description' => 'The decision result of the authorization.'."\n", + 'type' => 'string', + 'example' => 'Allow', + ], + 'actions' => [ + 'description' => 'The type of operations that can be performed on the resource.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The type of operation that can be performed on the resource.'."\n", + 'type' => 'string', + 'example' => 'Pub', + ], + ], + 'ipWhitelists' => [ + 'description' => 'The IP address whitelists.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address whitelist. IP addresses and CIDR blocks are supported.'."\n", + 'type' => 'string', + 'example' => '0.0.0.0/0', + ], + ], + ], + ], + 'code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'dynamicMessage' => [ + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"aclType\\": \\"apache_acl\\",\\n \\"username\\": \\"abc\\",\\n \\"resourceType\\": \\"Topic\\",\\n \\"resourceName\\": \\"test\\",\\n \\"decision\\": \\"Allow\\",\\n \\"actions\\": [\\n \\"Pub\\"\\n ],\\n \\"ipWhitelists\\": [\\n \\"0.0.0.0/0\\"\\n ]\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'GetInstanceAcl', + ], + 'CreateInstanceIpWhitelist' => [ + 'summary' => 'Creates an IP address whitelist.', + 'path' => '/instances/{instanceId}/ip/whitelist', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'ipWhitelists' => [ + 'description' => 'The IP address whitelists.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address whitelist.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0.0.0.0/0', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'The result.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A07B41BD-6DD3-5349-9E76-00303DF04BBE', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A07B41BD-6DD3-5349-9E76-00303DF04BBE\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'CreateInstanceIpWhitelist', + 'translator' => 'machine', + ], + 'DeleteInstanceIpWhitelist' => [ + 'summary' => 'Deletes a specific IP address whitelist from an instance.', + 'path' => '/instances/{instanceId}/ip/whitelist', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '209878', + 'abilityTreeNodes' => [ + 'FEATUREonsO60XBD', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'ipWhitelist', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address whitelist.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '0.0.0.0/0', + ], + ], + [ + 'name' => 'ipWhitelists', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The IP address whitelist.', + 'example' => '0.0.0.0/0'."\n", + ], + 'required' => false, + 'description' => 'The IP address whitelist.', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'The result.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '16425867-C948-5A0C-9A24-5259727BE727', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied due to the reason that the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"16425867-C948-5A0C-9A24-5259727BE727\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'DeleteInstanceIpWhitelist', + 'translator' => 'machine', + ], + 'ListInstanceIpWhitelist' => [ + 'summary' => 'Queries the IP address whitelists of an instance.', + 'path' => '/instances/{instanceId}/ip/whitelist', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '209879', + 'abilityTreeNodes' => [ + 'FEATUREonsO60XBD', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '10', + 'example' => '10', + ], + ], + [ + 'name' => 'ipWhitelist', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP whitelist.', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0.0/0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MyPage<String>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '7358418D-83BD-507A-8079-611C63E05674', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'title' => '当前页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页大小', + 'description' => 'Number of items per page.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'totalCount' => [ + 'title' => '总记录数', + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'list' => [ + 'title' => '分页数据', + 'description' => 'The pagination information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address whitelist.'."\n", + 'type' => 'string', + 'example' => '0.0.0.0/0', + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Instance.NotFound'."\n", + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7358418D-83BD-507A-8079-611C63E05674\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 5,\\n \\"list\\": [\\n \\"0.0.0.0/0\\"\\n ]\\n },\\n \\"code\\": \\"Instance.NotFound\\\\n\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'ListInstanceIpWhitelist', + ], + 'GetInstanceIpWhitelist' => [ + 'summary' => 'Queries the information about the IP address whitelist of an instance.', + 'path' => '/instances/{instanceId}/ip/whitelists', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '260123', + 'abilityTreeNodes' => [ + 'FEATUREonsO60XBD', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'ipWhitelists', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => 'The filter IP address whitelists.', + 'type' => 'array', + 'items' => [ + 'description' => 'The filter IP address whitelist.', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0.0/0', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n" + ."\n", + 'type' => 'string', + 'example' => '0B962390-D84B-5D44-8C11-79DF40299D41', + ], + 'success' => [ + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'ipWhitelists' => [ + 'description' => 'The IP address whitelists.', + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address whitelist.', + 'type' => 'string', + 'example' => '0.0.0.0/0', + ], + ], + ], + ], + 'code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Instance.NotFound', + ], + 'message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'httpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B962390-D84B-5D44-8C11-79DF40299D41\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"ipWhitelists\\": [\\n \\"0.0.0.0/0\\"\\n ]\\n },\\n \\"code\\": \\"Instance.NotFound\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'GetInstanceIpWhitelist', + ], + 'ListMigrations' => [ + 'summary' => 'Queries migration tasks.', + 'path' => '/migrations', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xx', + ], + ], + [ + 'name' => 'migrationType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'RESOURCE_IMPORT', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MyPage<MigrationDTO>>', + 'description' => 'Result<MyPage<MigrationDTO>>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => '', + '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', + ], + 'list' => [ + 'title' => '分页数据', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'migrationId' => [ + 'title' => '迁移ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + 'migrationName' => [ + 'title' => '迁移名称', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'migrationType' => [ + 'title' => '迁移类型,MigrationTypeEnum[RESOURCE_IMPORT(资源导入),INSTANCE_MIGRATION(实例迁移),code(编码),desc(描述)]', + 'description' => '', + 'type' => 'string', + 'example' => 'INSTANCE_MIGRATION', + ], + 'migrationStatus' => [ + 'title' => '迁移状态,MigrationStatusEnum[CREATED(已创建),MIGRATING(迁移中),COMPLETED(已完成),code(编码),desc(描述)]', + 'description' => '', + 'type' => 'string', + 'example' => 'MIGRATING', + ], + 'userId' => [ + 'title' => '用户ID', + 'description' => '', + 'type' => 'string', + 'example' => '111', + ], + 'currentStage' => [ + 'title' => '当前阶段,MigrationStageTypeEnum[CONNECT_NETWORK(网络打通),MIGRATE_METADATA(迁移元数据),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(消息迁移),code(编码),desc(描述),type(类型)]', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'stageType' => [ + 'title' => '阶段类型,MigrationStageTypeEnum[CONNECT_NETWORK(网络打通),MIGRATE_METADATA(迁移元数据),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(消息迁移),code(编码),desc(描述),type(类型)]', + 'description' => '', + 'type' => 'string', + 'example' => 'MIGRATE_METADATA', + ], + 'stageStatus' => [ + 'title' => '阶段状态,MigrationStageStatusEnum[INIT(未开始),DOING(执行中),DONE(已完成),code(编码),desc(描述)]', + 'description' => '', + 'type' => 'string', + 'example' => 'DOING', + ], + 'stageData' => [ + 'title' => '阶段数据', + 'description' => '', + 'type' => 'any', + 'example' => '[]', + ], + ], + ], + 'migrationSource' => [ + 'title' => '迁移来源', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'sourceType' => [ + 'title' => '迁移来源类型,MigrationSourceTypeEnum[EXTERNAL_INSTANCE(外部实例),UPLOADED_FILE(上传文件),code(编码),desc(描述),type(类型)]', + 'description' => '', + 'type' => 'string', + 'example' => 'EXTERNAL_INSTANCE', + ], + 'sourceData' => [ + 'title' => '迁移来源数据', + 'description' => '', + 'type' => 'any', + 'example' => '[]', + ], + ], + ], + 'migrationTarget' => [ + 'title' => '迁移目标', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'targetType' => [ + 'title' => '迁移目标类型,MigrationTargetTypeEnum[INTERNAL_INSTANCE(内部实例),code(编码),desc(描述),type(类型)]', + 'description' => '', + 'type' => 'string', + 'example' => 'INTERNAL_INSTANCE', + ], + 'targetData' => [ + 'title' => '迁移目标数据', + 'description' => '', + 'type' => 'any', + 'example' => '[]', + ], + ], + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-08-01 00:00:00', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5897B2E-C3AC-56DC-A482-F0E9E53F48D5\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 3,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"migrationId\\": 21,\\n \\"migrationName\\": \\"xxx\\",\\n \\"migrationType\\": \\"INSTANCE_MIGRATION\\",\\n \\"migrationStatus\\": \\"MIGRATING\\",\\n \\"userId\\": \\"111\\",\\n \\"currentStage\\": {\\n \\"stageType\\": \\"MIGRATE_METADATA\\",\\n \\"stageStatus\\": \\"DOING\\",\\n \\"stageData\\": \\"[]\\"\\n },\\n \\"migrationSource\\": {\\n \\"sourceType\\": \\"EXTERNAL_INSTANCE\\",\\n \\"sourceData\\": \\"{\\\\n\\\\\\"clusterType\\\\\\":\\\\\\"INTERNET_NETWORK\\\\\\",\\\\n\\\\\\"aclType\\\\\\":\\\\\\"NONE\\\\\\",\\\\n\\\\\\"clusterName\\\\\\":\\\\\\"test\\\\\\",\\\\n\\\\\\"namesrvAddrList\\\\\\":\\\\\\"47.110.248.xxx:9876\\\\\\"],\\\\n\\\\\\"brokerObtainMethod\\\\\\":\\\\\\"AUTO_OBTAIN\\\\\\"\\\\n}\\"\\n },\\n \\"migrationTarget\\": {\\n \\"targetType\\": \\"INTERNAL_INSTANCE\\",\\n \\"targetData\\": \\"{\\\\n\\\\\\"clusterType\\\\\\":\\\\\\"ROCKETMQ_V5\\\\\\",\\\\n\\\\\\"instanceId\\\\\\":\\\\\\"rmq-cn-778429mp301\\\\\\",\\\\n\\\\\\"regionId\\\\\\":\\\\\\"cn-hangzhou\\\\\\"\\\\n}\\"\\n },\\n \\"createTime\\": \\"2022-08-01 00:00:00\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\"\\n }\\n ]\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'ListMigrations', + ], + 'ListMigrationOperations' => [ + 'summary' => 'Queries a list of migration operations.', + 'path' => '/migrations/{migrationId}/stages/{stageType}/operations', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'migrationId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '135', + ], + ], + [ + 'name' => 'stageType', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'MIGRATE_MESSAGE', + ], + ], + [ + 'name' => 'operationType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'IMPORT_CONSUMER_GROUP', + ], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rmq-cn-zxu37eiqq0x', + ], + ], + [ + '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' => 'Result<MyPage<MigrationOperationDTO>>', + 'description' => 'Result<MyPage<MigrationOperationDTO>>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5F88833', + ], + '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' => [ + 'operationId' => [ + 'title' => '迁移操作ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '183', + ], + 'migrationId' => [ + 'title' => '迁移ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'stageType' => [ + 'title' => '迁移阶段类型', + 'description' => '', + 'type' => 'string', + 'example' => 'CONNECT_NETWORK', + ], + 'operationType' => [ + 'title' => '操作类型,MigrationOperationTypeEnum[IMPORT_TOPIC(导入主题),IMPORT_CONSUMER_GROUP(导入消费者组),CONNECT_NETWORK(网络打通),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(迁移消息),code(编码),desc(描述),param(参数类型),result(结果类型)]', + 'description' => '', + 'type' => 'string', + 'example' => 'IMPORT_CONSUMER_GROUP', + ], + 'operationStatus' => [ + 'title' => '操作状态,MigrationOperationStatusEnum[INIT(未开始),DOING(执行中),DONE(已完成),FAIL(已失败),code(编码),desc(描述)]', + 'description' => '', + 'type' => 'string', + 'example' => 'DOING', + ], + 'operationKey' => [ + 'title' => '操作对象主键', + 'description' => '', + 'type' => 'string', + 'example' => 'xx', + ], + 'businessStatus' => [ + 'title' => '操作业务状态,ConnectNetworkBusinessStatusEnum[CONNECT_PENDING(等待打通),CONNECT_DOING(打通中),CONNECT_SUCCESS(打通成功),CONNECT_FAILURE(打通失败),code,desc]', + 'description' => '', + 'type' => 'string', + 'example' => 'CONNECT_PENDING', + ], + 'operationParam' => [ + 'title' => '操作参数', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'paramData' => [ + 'title' => '参数信息', + 'description' => '', + 'type' => 'any', + 'example' => '[]', + ], + ], + ], + 'operationResult' => [ + 'title' => '操作结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'resultData' => [ + 'title' => '操作结果', + 'description' => '', + 'type' => 'any', + 'example' => '[]', + ], + ], + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-08-01 00:00:00', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Instance.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'The topic already exists.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'consumerGroupId', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7E8AE3A-219B-52EE-BE32-4036F5F88833\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"operationId\\": 183,\\n \\"migrationId\\": 1,\\n \\"stageType\\": \\"MIGRATE_MESSAGE\\",\\n \\"operationType\\": \\"MIGRATE_MESSAGE\\",\\n \\"operationStatus\\": \\"DOING\\",\\n \\"operationKey\\": \\"normal-topic-1\\",\\n \\"businessStatus\\": \\"DOUBLE_READ\\",\\n \\"operationParam\\": {\\n \\"paramData\\": \\"{\\\\n \\\\\\"action\\\\\\": \\\\\\"MIGRATE_FORWARD\\\\\\",\\\\n \\\\\\"targetStage\\\\\\": \\\\\\"MIGRATE_FINISH\\\\\\"\\\\n}\\"\\n },\\n \\"operationResult\\": {\\n \\"resultData\\": \\"{\\\\n \\\\\\"checkStatus\\\\\\": \\\\\\"WAIT_CHECK\\\\\\",\\\\n \\\\\\"sourceTopicStatus\\\\\\": \\\\\\"PERM_6\\\\\\",\\\\n \\\\\\"targetTopicStatus\\\\\\": \\\\\\"PERM_4\\\\\\",\\\\n \\\\\\"checkResult\\\\\\": {},\\\\n \\\\\\"migrateStage\\\\\\": \\\\\\"DOUBLE_READ\\\\\\"\\\\n}\\"\\n },\\n \\"createTime\\": \\"2022-08-01 00:00:00\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\"\\n }\\n ]\\n },\\n \\"code\\": \\"Instance.NotFound\\",\\n \\"message\\": \\"The topic already exists.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"consumerGroupId\\"\\n}","type":"json"}]', + 'title' => 'ListMigrationOperations', + ], + 'ExecuteMigrationOperation' => [ + 'summary' => 'Executes a specific operation on a specific migration task.', + 'path' => '/migrations/{migrationId}/stages/{stageType}/operations/{operationId}/execute', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'migrationId', + 'in' => 'path', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '44', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'rmq-cn-x0r37kelk0o', + ], + ], + [ + 'name' => 'stageType', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'example' => 'MIGRATE_METADATA', + ], + ], + [ + 'name' => 'operationId', + 'in' => 'path', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2729', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'operationParam' => [ + 'title' => '操作参数', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'paramData' => [ + 'title' => '参数信息', + 'description' => '', + 'type' => 'any', + 'required' => false, + 'example' => '{}', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MigrationOperationDTO>', + 'description' => 'Result<MigrationOperationDTO>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '814BCD66-2D76-5080-AAD2-E50E5BDB0995', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'operationId' => [ + 'title' => '迁移操作ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '110', + ], + 'migrationId' => [ + 'title' => '迁移ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'stageType' => [ + 'title' => '迁移阶段类型', + 'description' => '', + 'type' => 'string', + 'example' => 'MIGRATE_METADATA', + ], + 'operationType' => [ + 'title' => '操作类型,MigrationOperationTypeEnum[IMPORT_TOPIC(导入主题),IMPORT_CONSUMER_GROUP(导入消费者组),CONNECT_NETWORK(网络打通),REPLACE_ENDPOINT(更换接入点),MIGRATE_MESSAGE(迁移消息),code(编码),desc(描述),param(参数类型),result(结果类型)]', + 'description' => '', + 'type' => 'string', + 'example' => 'CONNECT_NETWORK', + ], + 'operationStatus' => [ + 'title' => '操作状态,MigrationOperationStatusEnum[INIT(未开始),DOING(执行中),DONE(已完成),FAIL(已失败),code(编码),desc(描述)]', + 'description' => '', + 'type' => 'string', + 'example' => 'DONE', + ], + 'operationKey' => [ + 'title' => '操作对象主键', + 'description' => '', + 'type' => 'string', + 'example' => 'group01', + ], + 'businessStatus' => [ + 'title' => '操作业务状态,ConnectNetworkBusinessStatusEnum[CONNECT_PENDING(等待打通),CONNECT_DOING(打通中),CONNECT_SUCCESS(打通成功),CONNECT_FAILURE(打通失败),code,desc]', + 'description' => '', + 'type' => 'string', + 'example' => 'MIGRATE_WAIT', + ], + 'operationParam' => [ + 'title' => '操作参数', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'paramData' => [ + 'title' => '参数信息', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + ], + ], + 'operationResult' => [ + 'title' => '操作结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'resultData' => [ + 'title' => '操作结果', + 'description' => '', + 'type' => 'any', + 'example' => '{}', + ], + ], + ], + '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' => '', + '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\\": \\"814BCD66-2D76-5080-AAD2-E50E5BDB0995\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"operationId\\": 110,\\n \\"migrationId\\": 6,\\n \\"stageType\\": \\"MIGRATE_MESSAGE\\",\\n \\"operationType\\": \\"MIGRATE_MESSAGE\\",\\n \\"operationStatus\\": \\"DOING\\",\\n \\"operationKey\\": \\"normal-topic-1\\",\\n \\"businessStatus\\": \\"MIGRATE_WAIT\\",\\n \\"operationParam\\": {\\n \\"paramData\\": \\"{\\\\\\"action\\\\\\":\\\\\\"MIGRATE_FORWARD\\\\\\",\\\\\\"targetStage\\\\\\":\\\\\\"MIGRATE_FINISH\\\\\\"}\\"\\n },\\n \\"operationResult\\": {\\n \\"resultData\\": \\"{\\\\n \\\\\\"checkStatus\\\\\\": \\\\\\"WAIT_CHECK\\\\\\",\\\\n \\\\\\"sourceTopicStatus\\\\\\": \\\\\\"PERM_6\\\\\\",\\\\n \\\\\\"targetTopicStatus\\\\\\": \\\\\\"PERM_4\\\\\\",\\\\n \\\\\\"checkResult\\\\\\": {},\\\\n \\\\\\"migrateStage\\\\\\": \\\\\\"DOUBLE_READ\\\\\\"\\\\n}\\"\\n },\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\"\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic already exists.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'ExecuteMigrationOperation', + ], + 'FinishMigrationStage' => [ + 'summary' => '完成当前迁移阶段', + 'path' => '/migrations/{migrationId}/stages/{stageType}/finish', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'migrationId', + 'in' => 'path', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'rmq-cn-pe334f1nx04', + ], + ], + [ + 'name' => 'stageType', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'example' => 'CONNECT_NETWORK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => '', + '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' => '', + '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\\": \\"InvalidConsumerGroupId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + ], + 'CreateDisasterRecoveryPlan' => [ + 'summary' => 'Create Disaster Recovery Plan', + 'path' => '/disaster_recovery', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225047', + 'abilityTreeNodes' => [ + 'FEATUREonsOVRH1R', + 'FEATUREonsU22PJL', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'planName' => [ + 'title' => '计划名称', + 'description' => 'The name of the Global Replicator task. You must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'planDesc' => [ + 'title' => '计划描述', + 'description' => 'The description of the Global Replicator task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'planType' => [ + 'title' => '计划类型', + 'description' => 'The type of the Global Replicator task. You must specify this parameter. For more information, see [Global Replicator](~~2843187~~). Valid values:'."\n" + ."\n" + .'* ACTIVE_PASSIVE: one-way backup'."\n" + .'* ACTIVE_ACTIVE: two-way backup'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ACTIVE_ACTIVE' => 'ACTIVE_ACTIVE', + 'ACTIVE_PASSIVE' => 'ACTIVE_PASSIVE', + ], + 'example' => 'ACTIVE_ACTIVE', + ], + 'instances' => [ + 'title' => '容灾计划参与实例', + 'description' => 'The instances involved in the Global Replicator task. You must specify this parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance involved in the Global Replicator task.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceType' => [ + 'title' => '实例类型', + 'description' => 'The instance type. Valid values:'."\n" + ."\n" + .'* ALIYUN_ROCKETMQ: ApsaraMQ for RocketMQ instance'."\n" + .'* EXTERNAL_ROCKETMQ: external RocketMQ instance'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ALIYUN_ROCKETMQ: ApsaraMQ for RocketMQ instance'."\n" + .'* EXTERNAL_ROCKETMQ: external RocketMQ instance'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALIYUN_ROCKETMQ' => 'ALIYUN_ROCKETMQ', + 'EXTERNAL_ROCKETMQ' => 'EXTERNAL_ROCKETMQ', + ], + 'example' => 'ALIYUN_ROCKETMQ', + ], + 'regionId' => [ + 'title' => '实例所在区域', + 'description' => 'The region where the instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID. This parameter is required only if you set instanceType to ALIYUN_ROCKETMQ.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rmq-cn-******', + ], + 'instanceRole' => [ + 'title' => '实例角色', + 'description' => 'The instance role. Valid values:'."\n" + ."\n" + .'* ACTIVE: primary instance'."\n" + .'* Passive: secondary instance'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PASSIVE' => 'Secondary', + 'ACTIVE' => 'Primary', + ], + 'example' => 'PASSIVE', + ], + 'authType' => [ + 'title' => '认证方式', + 'description' => 'The authentication method. If you set instanceType to ALIYUN_ROCKETMQ and the instance is an ApsaraMQ for RocketMQ 4.0 instance, you do not need to specify this parameter.'."\n" + ."\n" + .'* NO_AUTH: no authentication'."\n" + .'* ACL_AUTH: access control list (ACL)-based authentication'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* NO_AUTH: no authentication'."\n" + .'* ACL_AUTH: access control list (ACL)-based authentication'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NO_AUTH' => 'No authentication required', + 'ACL_AUTH' => 'ACL authentication', + ], + 'example' => 'ACL_AUTH', + ], + 'username' => [ + 'title' => '认证用户名', + 'description' => 'The username used for authentication. This parameter is required only if you set authType to ACL_AUTH.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'password' => [ + 'title' => '认证密码', + 'description' => 'The password used for authentication. This parameter is required only if you set authType to ACL_AUTH. If you set instanceType to ALIYUN_ROCKETMQ, you do not need to specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'endpointUrl' => [ + 'title' => '接入点地址', + 'description' => 'The instance endpoint. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'networkType' => [ + 'title' => '网络类型', + 'description' => 'The network type. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ. Valid values:'."\n" + ."\n" + .'* TCP_INTERNET: Internet over TCP'."\n" + .'* TCP_VPC: virtual private cloud (VPC) over TCP.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TCP_VPC' => 'Virtual Private Cloud', + 'TCP_INTERNET' => 'TCP public network', + ], + 'example' => 'TCP_INTERNET', + ], + 'vpcId' => [ + 'title' => 'VPC ID', + 'description' => 'The ID of the VPC with which the instance is associated. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9qt50xhtj9krb******'."\n", + ], + 'vSwitchId' => [ + 'title' => '交换机ID', + 'description' => 'The ID of the vSwitch with which the instance is associated. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf6gwtbn6etadpv******'."\n", + ], + 'messageProperty' => [ + 'description' => 'The message attribute. When you synchronize a message to the destination cluster, the system automatically adds the attribute to the message for SQL-based filtering.'."\n", + 'type' => 'object', + 'properties' => [ + 'propertyKey' => [ + 'description' => 'The attribute key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'aaa', + ], + 'propertyValue' => [ + 'description' => 'The attribute value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bbb', + ], + ], + 'required' => false, + ], + 'securityGroupId' => [ + 'description' => 'The ID of the security group to which the instance belongs. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp17hpmgz9******', + ], + 'consumerGroupId' => [ + 'description' => 'The ID of the consumer group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GID_DS_XXX_YYY', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'autoSyncCheckpoint' => [ + 'title' => '自动消费进度同步开关', + 'description' => 'Specifies whether to enable automatic consumer progress synchronization.'."\n" + ."\n" + .'> This parameter takes effect only when you set `syncCheckpointEnabled` to true.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'open', + 'false' => 'close', + ], + 'example' => 'true', + ], + 'syncCheckpointEnabled' => [ + 'description' => 'Specifies whether to enable consumer progress synchronization.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'open', + 'false' => 'close', + ], + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Long>', + 'description' => 'Result<Long>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'C7E8AE3A-219B-52EE-BE32-4036F5xxxx', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the operation was successful', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The result, which is the backup plan ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message', + 'type' => 'string', + 'example' => 'xxx', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code', + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'Dynamic error message', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'Access denied details, provided only in scenarios where access is denied due to lack of RAM permissions', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7E8AE3A-219B-52EE-BE32-4036F5xxxx\\",\\n \\"success\\": true,\\n \\"data\\": 1234,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'CreateDisasterRecoveryPlan', + 'translator' => 'machine', + ], + 'DeleteDisasterRecoveryPlan' => [ + 'summary' => 'Deletes a global message backup plan.', + 'path' => '/disaster_recovery/{planId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'planId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the global message backup plan.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1300000016', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****'."\n", + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The data returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'DisasterRecoveryPlanStatus.Error', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The current status of the disaster recovery plan does not support this operation.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\\\n\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"DisasterRecoveryPlanStatus.Error\\",\\n \\"message\\": \\"The current status of the disaster recovery plan does not support this operation.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'DeleteDisasterRecoveryPlan', + ], + 'UpdateDisasterRecoveryPlan' => [ + 'summary' => 'Modifies a global message backup plan.', + 'path' => '/disaster_recovery/{planId}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225048', + 'abilityTreeNodes' => [ + 'FEATUREonsU22PJL', + ], + ], + 'parameters' => [ + [ + 'name' => 'planId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the global message backup plan.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1300000016', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'planName' => [ + 'title' => '计划名称', + 'description' => 'The name of the Global Replicator task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'planDesc' => [ + 'title' => '计划描述', + 'description' => 'The description of the Global Replicator task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'planType' => [ + 'title' => '计划类型', + 'description' => 'The type of the Global Replicator task. After you create a Global Replicator task, you cannot change the type of the task. Valid values:'."\n" + ."\n" + .'* ACTIVE_PASSIVE: one-way backup'."\n" + .'* ACTIVE_ACTIVE: two-way backup'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ACTIVE_ACTIVE' => '', + 'ACTIVE_PASSIVE' => '', + ], + 'example' => 'ACTIVE_PASSIVE', + ], + 'instances' => [ + 'title' => '容灾计划参与实例', + 'description' => 'The instances involved in the Global Replicator task. After you create a Global Replicator task, you cannot change the instances involved in the task. You can change only the message attribute and authentication type of the task.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance involved in the Global Replicator task.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceType' => [ + 'title' => '实例类型', + 'description' => 'The instance type. Valid values:'."\n" + ."\n" + .'* ALIYUN_ROCKETMQ: ApsaraMQ for RocketMQ instance'."\n" + .'* EXTERNAL_ROCKETMQ: open source RocketMQ cluster'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALIYUN_ROCKETMQ' => '', + 'EXTERNAL_ROCKETMQ' => '', + ], + 'example' => 'ALIYUN_ROCKETMQ', + ], + 'regionId' => [ + 'title' => '实例所在区域', + 'description' => 'The ID of the region where the instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rmq-cn-83l3r0xxxx', + ], + 'instanceRole' => [ + 'title' => '实例角色', + 'description' => 'The instance role. Valid values:'."\n" + ."\n" + .'* ACTIVE: primary instance'."\n" + .'* Passive: secondary instance'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PASSIVE' => '', + 'ACTIVE' => '', + ], + 'example' => 'ACTIVE', + ], + 'authType' => [ + 'title' => '认证方式', + 'description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'* NO_AUTH: no authentication'."\n" + .'* ACL_AUTH: access control list (ACL)-based authentication'."\n" + ."\n" + .'<!---->'."\n" + ."\n" + .'*'."\n" + .'*'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NO_AUTH' => '', + 'ACL_AUTH' => '', + ], + 'example' => 'NO_AUTH', + ], + 'username' => [ + 'title' => '认证用户名', + 'description' => 'The username used for authentication. This parameter is required only if you set authType to ACL_AUTH.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'password' => [ + 'title' => '认证密码', + 'description' => 'The password used for authentication. This parameter is required only if you set authType to ACL_AUTH.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'endpointUrl' => [ + 'title' => '接入点地址', + 'description' => 'The instance endpoint. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'networkType' => [ + 'title' => '网络类型', + 'description' => 'The network type. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ. Valid values:'."\n" + ."\n" + .'* TCP_INTERNET: Internet over TCP'."\n" + .'* TCP_VPC: virtual private cloud (VPC) over TCP.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TCP_VPC' => '', + 'TCP_INTERNET' => '', + ], + 'example' => 'TCP_INTERNET', + ], + 'vpcId' => [ + 'title' => 'VPC ID', + 'description' => 'The ID of the VPC with which the instance is associated. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9qt50xhtj9krb******'."\n", + ], + 'vSwitchId' => [ + 'title' => '交换机ID', + 'description' => 'The ID of the vSwitch with which the instance is associated. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf6gwtbn6etadpv******'."\n", + ], + 'messageProperty' => [ + 'description' => 'The message attribute. When you synchronize a message to the destination cluster, the system automatically adds the attribute to the message for SQL-based filtering.'."\n", + 'type' => 'object', + 'properties' => [ + 'propertyKey' => [ + 'description' => 'The attribute key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'aaa', + ], + 'propertyValue' => [ + 'description' => 'The attribute value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bbb', + ], + ], + 'required' => false, + ], + 'securityGroupId' => [ + 'description' => 'The ID of the security group to which the instance belongs. This parameter is required only if you set instanceType to EXTERNAL_ROCKETMQ and networkType to TCP_VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp17hpmgz9******'."\n", + ], + 'consumerGroupId' => [ + 'description' => 'The consumer group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GID_DS_XXX_YYY', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'autoSyncCheckpoint' => [ + 'title' => '自动消费进度同步开关', + 'description' => 'Specifies whether to enable automatic consumer progress synchronization.'."\n" + ."\n" + .'> This parameter takes effect only when you set `syncCheckpointEnabled` to true.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'syncCheckpointEnabled' => [ + 'description' => 'Specifies whether to enable consumer progress synchronization.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A07B41BD-6DD3-5349-9E76-00303Dxxxx', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The data returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'DisasterRecoveryPlanStatus.Error', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The current status of the disaster recovery plan does not support this operation.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A07B41BD-6DD3-5349-9E76-00303Dxxxx\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"DisasterRecoveryPlanStatus.Error\\",\\n \\"message\\": \\"The current status of the disaster recovery plan does not support this operation.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'UpdateDisasterRecoveryPlan', + ], + 'ListDisasterRecoveryPlans' => [ + 'summary' => 'Queries Global Replicator tasks.', + 'path' => '/disaster_recovery', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225050', + 'abilityTreeNodes' => [ + 'FEATUREonsOVRH1R', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rmq-cn-778xxx', + ], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => [ + 'description' => 'The filter condition. Global Replicator tasks are filtered by task name or description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MyPage<DisasterRecoveryPlanDTO>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '855EF8E6-9C1D-5DE2-9E84-924E13Exxxx', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the information about the service was queried.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'scrollId' => [ + 'title' => '滚动标识', + 'description' => 'The scroll ID of the request. The ID is automatically generated by the system. The result can be paginated only if this parameter is included in the pagination request.'."\n", + 'type' => 'string', + 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00'."\n", + ], + 'pageNumber' => [ + 'title' => '当前页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页大小', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'totalCount' => [ + 'title' => '总记录数', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '28', + ], + 'list' => [ + 'title' => '分页数据', + 'description' => 'The Global Replicator tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The Global Replicator task.'."\n", + 'type' => 'object', + 'properties' => [ + 'planId' => [ + 'title' => '计划ID', + 'description' => 'The ID of the Global Replicator task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1300000016', + ], + 'planName' => [ + 'title' => '计划名称', + 'description' => 'The name of the Global Replicator task.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'planDesc' => [ + 'title' => '计划描述', + 'description' => 'The description of the Global Replicator task.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'planType' => [ + 'title' => '计划类型,DisasterRecoveryTypeEnum[ACTIVE_PASSIVE(灾备),ACTIVE_ACTIVE(双活),code,desc]', + 'description' => 'The type of the Global Replicator task. Valid values:'."\n" + ."\n" + .'* ACTIVE_PASSIVE: one-way backup'."\n" + .'* ACTIVE_ACTIVE: two-way backup'."\n", + 'type' => 'string', + 'example' => 'ACTIVE_PASSIVE', + ], + 'planStatus' => [ + 'title' => '计划状态,DisasterRecoveryStatusEnum[CREATED(已创建),DELETED(已删除),code,desc]', + 'description' => 'The status of the Global Replicator task. Valid values:'."\n" + ."\n" + .'* CREATED'."\n" + .'* RUNNING'."\n" + .'* DELETED'."\n", + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'extInfo' => [ + 'title' => '扩展信息', + 'description' => 'The extended information.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The extended information.'."\n", + 'example' => 'xxx', + ], + ], + 'instances' => [ + 'title' => '容灾计划参与实例', + 'description' => 'The instances involved in the Global Replicator task.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance involved the Global Replicator task.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceType' => [ + 'title' => '实例类型', + 'description' => 'The instance type.'."\n", + 'type' => 'string', + 'example' => 'ALIYUN_ROCKETMQ', + ], + 'regionId' => [ + 'title' => '实例所在区域', + 'description' => 'The ID of the region where the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-ot93rbxxx', + ], + 'instanceRole' => [ + 'title' => '实例角色', + 'description' => 'The instance role.'."\n", + 'type' => 'string', + 'example' => 'ACTIVE', + ], + 'authType' => [ + 'title' => '认证方式', + 'description' => 'The authentication type.'."\n", + 'type' => 'string', + 'example' => 'NO_AUTH', + ], + 'username' => [ + 'title' => '认证用户名', + 'description' => 'The username used for authentication.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'password' => [ + 'title' => '认证密码', + 'description' => 'The password used for authentication.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'endpointUrl' => [ + 'title' => '接入点地址', + 'description' => 'The endpoint.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'networkType' => [ + 'title' => '网络类型', + 'description' => 'The network type.'."\n", + 'type' => 'string', + 'example' => 'TCP_INTERNET', + ], + 'vpcId' => [ + 'title' => 'VPC ID', + 'description' => 'The virtual private cloud (VPC) ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp13docqysrgxtbxxxx', + ], + 'vSwitchId' => [ + 'title' => '交换机ID', + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-uf6gwtbn6etadpv******'."\n", + ], + 'messageProperty' => [ + 'description' => 'The message attribute.'."\n", + 'type' => 'object', + 'properties' => [ + 'propertyKey' => [ + 'description' => 'The attribute key.'."\n", + 'type' => 'string', + 'example' => 'aaa', + ], + 'propertyValue' => [ + 'description' => 'The attribute value.'."\n", + 'type' => 'string', + 'example' => 'bbb', + ], + ], + ], + 'securityGroupId' => [ + 'description' => 'The security group ID.'."\n", + 'type' => 'string', + 'example' => 'sg-bp17hpmgz9******'."\n", + ], + 'consumerGroupId' => [ + 'description' => 'The ID of the consumer group.'."\n", + 'type' => 'string', + 'example' => 'GID_ui_xxx', + ], + ], + ], + ], + 'syncCheckpointEnabled' => [ + 'title' => '同步消费进度开关', + 'description' => 'Indicates whether consumer progress synchronization is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'autoSyncCheckpoint' => [ + 'title' => '是否自动同步消费进度', + 'description' => 'Indicates whether automatic consumer progress synchronization is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the query task was created.'."\n", + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the query task was last modified.'."\n", + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The returned dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"855EF8E6-9C1D-5DE2-9E84-924E13Exxxx\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"scrollId\\": \\"B13D0B07-F24B-4790-88D8-D47A38063D00\\\\n\\",\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 28,\\n \\"list\\": [\\n {\\n \\"planId\\": 1300000016,\\n \\"planName\\": \\"xxx\\",\\n \\"planDesc\\": \\"xxx\\",\\n \\"planType\\": \\"ACTIVE_PASSIVE\\",\\n \\"planStatus\\": \\"RUNNING\\",\\n \\"extInfo\\": {\\n \\"key\\": \\"xxx\\"\\n },\\n \\"instances\\": [\\n {\\n \\"instanceType\\": \\"ALIYUN_ROCKETMQ\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-ot93rbxxx\\",\\n \\"instanceRole\\": \\"ACTIVE\\",\\n \\"authType\\": \\"NO_AUTH\\",\\n \\"username\\": \\"xxx\\",\\n \\"password\\": \\"xxx\\",\\n \\"endpointUrl\\": \\"xxx\\",\\n \\"networkType\\": \\"TCP_INTERNET\\",\\n \\"vpcId\\": \\"vpc-bp13docqysrgxtbxxxx\\",\\n \\"vSwitchId\\": \\"vsw-uf6gwtbn6etadpv******\\\\n\\",\\n \\"messageProperty\\": {\\n \\"propertyKey\\": \\"aaa\\",\\n \\"propertyValue\\": \\"bbb\\"\\n },\\n \\"securityGroupId\\": \\"sg-bp17hpmgz9******\\\\n\\",\\n \\"consumerGroupId\\": \\"GID_xxx\\"\\n }\\n ],\\n \\"syncCheckpointEnabled\\": true,\\n \\"autoSyncCheckpoint\\": true,\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\"\\n }\\n ]\\n },\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'ListDisasterRecoveryPlans', + 'translator' => 'machine', + ], + 'GetDisasterRecoveryPlan' => [ + 'summary' => 'Queries the details of a Global Replicator task.', + 'path' => '/disaster_recovery/{planId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225054', + 'abilityTreeNodes' => [ + 'FEATUREonsOVRH1R', + ], + ], + 'parameters' => [ + [ + 'name' => 'planId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the Global Replicator task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<DisasterRecoveryPlanDTO>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7358418D-83BD-507A-8079-611C63E0xxx', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'planId' => [ + 'title' => '计划ID', + 'description' => 'The ID of the Global Replicator task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1300000016', + ], + 'planName' => [ + 'title' => '计划名称', + 'description' => 'The name of the Global Replicator task.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'planDesc' => [ + 'title' => '计划描述', + 'description' => 'The description of the Global Replicator task.'."\n", + 'type' => 'string', + 'example' => 'xxxx', + ], + 'planType' => [ + 'title' => '计划类型,DisasterRecoveryTypeEnum[ACTIVE_PASSIVE(灾备),ACTIVE_ACTIVE(双活),code,desc]', + 'description' => 'The type of the Global Replicator task. Valid values:'."\n" + ."\n" + .'* ACTIVE_PASSIVE: one-way backup'."\n" + .'* ACTIVE_ACTIVE: two-way backup'."\n", + 'type' => 'string', + 'example' => 'ACTIVE_PASSIVE', + ], + 'planStatus' => [ + 'title' => '计划状态,DisasterRecoveryStatusEnum[CREATED(已创建),DELETED(已删除),code,desc]', + 'description' => 'The status of the Global Replicator task. Valid values:'."\n" + ."\n" + .'* CREATED'."\n" + .'* RUNNING'."\n" + .'* DELETED'."\n", + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'extInfo' => [ + 'title' => '扩展信息', + 'description' => 'The extended information.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'xxxx', + 'description' => 'The extended information.'."\n", + ], + ], + 'instances' => [ + 'title' => '容灾计划参与实例', + 'description' => 'The instances involved in the Global Replicator task.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance involved in the Global Replicator task.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceType' => [ + 'title' => '实例类型', + 'description' => 'The instance type.'."\n", + 'type' => 'string', + 'example' => 'ALIYUN_ROCKETMQ', + ], + 'regionId' => [ + 'title' => '实例所在区域', + 'description' => 'The ID of the region where the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-gpz3qtcdxxx', + ], + 'instanceRole' => [ + 'title' => '实例角色', + 'description' => 'The instance role.'."\n", + 'type' => 'string', + 'example' => 'ACTIVE', + ], + 'authType' => [ + 'title' => '认证方式', + 'description' => 'The authentication type.'."\n", + 'type' => 'string', + 'example' => 'ACL_AUTH', + ], + 'username' => [ + 'title' => '认证用户名', + 'description' => 'The username used for authentication.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'password' => [ + 'title' => '认证密码', + 'description' => 'The password used for authentication.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'endpointUrl' => [ + 'title' => '接入点地址', + 'description' => 'The endpoint.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'networkType' => [ + 'title' => '网络类型', + 'description' => 'The network type.'."\n", + 'type' => 'string', + 'example' => 'TCP_INTERNET', + ], + 'vpcId' => [ + 'title' => 'VPC ID', + 'description' => 'The virtual private cloud (VPC) ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-wz9qt50xhtj9krb******'."\n", + ], + 'vSwitchId' => [ + 'title' => '交换机ID', + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-uf6gwtbn6etadpv******'."\n", + ], + 'messageProperty' => [ + 'description' => 'The message attribute.'."\n", + 'type' => 'object', + 'properties' => [ + 'propertyKey' => [ + 'description' => 'The attribute key.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'propertyValue' => [ + 'description' => 'The attribute value.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + 'securityGroupId' => [ + 'description' => 'The security group ID.'."\n", + 'type' => 'string', + 'example' => 'sg-bp17hpmgz9******'."\n", + ], + 'consumerGroupId' => [ + 'description' => 'The consumer Group ID.', + 'type' => 'string', + 'example' => 'GID_DS_XXX_YYY', + ], + ], + ], + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the query task was created.'."\n", + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the query task was last modified.'."\n", + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'autoSyncCheckpoint' => [ + 'description' => 'Indicates whether automatic consumer progress synchronization is enabled.'."\n" + ."\n" + .'> This parameter takes effect only when `syncCheckpointEnabled` is set to true.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'syncCheckpointEnabled' => [ + 'description' => 'Indicates whether consumer progress synchronization is enabled.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7358418D-83BD-507A-8079-611C63E0xxx\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"planId\\": 1300000016,\\n \\"planName\\": \\"xxx\\",\\n \\"planDesc\\": \\"xxxx\\",\\n \\"planType\\": \\"ACTIVE_PASSIVE\\",\\n \\"planStatus\\": \\"RUNNING\\",\\n \\"extInfo\\": {\\n \\"key\\": \\"xxxx\\"\\n },\\n \\"instances\\": [\\n {\\n \\"instanceType\\": \\"ALIYUN_ROCKETMQ\\",\\n \\"regionId\\": \\"cn-shanghai\\",\\n \\"instanceId\\": \\"rmq-cn-gpz3qtcdxxx\\",\\n \\"instanceRole\\": \\"ACTIVE\\",\\n \\"authType\\": \\"ACL_AUTH\\",\\n \\"username\\": \\"xxx\\",\\n \\"password\\": \\"xxx\\",\\n \\"endpointUrl\\": \\"xxx\\",\\n \\"networkType\\": \\"TCP_INTERNET\\",\\n \\"vpcId\\": \\"vpc-wz9qt50xhtj9krb******\\\\n\\",\\n \\"vSwitchId\\": \\"vsw-uf6gwtbn6etadpv******\\\\n\\",\\n \\"messageProperty\\": {\\n \\"propertyKey\\": \\"xxx\\",\\n \\"propertyValue\\": \\"xxx\\"\\n },\\n \\"securityGroupId\\": \\"sg-bp17hpmgz9******\\\\n\\",\\n \\"consumerGroupId\\": \\"GID_DS_XXX_YYY\\"\\n }\\n ],\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\",\\n \\"autoSyncCheckpoint\\": true,\\n \\"syncCheckpointEnabled\\": true\\n },\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'GetDisasterRecoveryPlan', + ], + 'AddDisasterRecoveryItem' => [ + 'summary' => 'Adds a topic mapping to a Global Replicator task.', + 'path' => '/disaster_recovery/{planId}/items', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225043', + 'abilityTreeNodes' => [ + 'FEATUREonsOVRH1R', + 'FEATUREonsU22PJL', + ], + ], + 'parameters' => [ + [ + 'name' => 'planId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Backup plan ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1300000016', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'Request body structure. Required.', + 'type' => 'object', + 'properties' => [ + 'topics' => [ + 'title' => '容灾Item所包含的容灾主题', + 'description' => 'Topics included in the backup mapping. Required.', + 'type' => 'array', + 'items' => [ + 'description' => 'Topics included in the backup mapping', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => 'Region ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'instanceType' => [ + 'title' => '实例类型', + 'description' => 'Instance type'."\n" + .' - ALIYUN_ROCKETMQ: Alibaba Cloud instance'."\n" + .' - EXTERNAL_ROCKETMQ: External instance, open-source instance, open-source cluster', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALIYUN_ROCKETMQ' => 'ALIYUN_ROCKETMQ', + 'EXTERNAL_ROCKETMQ' => 'EXTERNAL_ROCKETMQ', + ], + 'example' => 'ALIYUN_ROCKETMQ'."\n", + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'Instance ID, an instance ID will be automatically generated when `instanceType` is `EXTERNAL_ROCKETMQ`, and it can be obtained by querying the backup plan.', + 'type' => 'string', + 'required' => false, + 'example' => 'rmq-cn-em93y94xxx', + ], + 'topicName' => [ + 'title' => '容灾主题名称', + 'description' => 'Disaster recovery topic name, required', + 'type' => 'string', + 'required' => false, + 'example' => 'Topic_xxx', + ], + 'consumerGroupId' => [ + 'title' => '消费者组ID', + 'description' => 'Consumer group ID, required for ACTIVE_ACTIVE bidirectional backup', + 'type' => 'string', + 'required' => false, + 'example' => 'GID_xxx', + 'deprecated' => true, + ], + 'deliveryOrderType' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The order in which messages are delivered to the target instance. The parameter values are as follows:'."\n" + .' - Concurrently: concurrent delivery'."\n" + .' - Orderly: sequential delivery', + 'example' => 'Concurrently', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Whether the operation was successful', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'description' => 'Return result, mapping task ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1300000016', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message', + 'type' => 'string', + 'example' => 'xxx', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code', + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'Dynamic error message', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'Access denied details, only in the scenario where the user is denied access due to RAM not having permission', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": 1300000016,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'AddDisasterRecoveryItem', + 'translator' => 'machine', + ], + 'UpdateDisasterRecoveryItem' => [ + 'summary' => 'Updates a topic mapping in a global message backup plan.', + 'path' => '/disaster_recovery/{planId}/items/{itemId}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263691', + 'abilityTreeNodes' => [ + 'FEATUREonsOVRH1R', + 'FEATUREonsU22PJL', + ], + ], + 'parameters' => [ + [ + 'name' => 'planId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the global message backup plan.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1300000016', + ], + ], + [ + 'name' => 'itemId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the topic mapping.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100070284', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'topics' => [ + 'description' => 'The topics involved in the topic mapping.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The topic involved in the topic mapping.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'instanceType' => [ + 'description' => 'The instance type. Valid values:'."\n" + ."\n" + .'* ALIYUN_ROCKETMQ: ApsaraMQ for RocketMQ instance'."\n" + .'* EXTERNAL_ROCKETMQ: open source RocketMQ cluster'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALIYUN_ROCKETMQ' => '', + 'EXTERNAL_ROCKETMQ' => '', + ], + 'example' => 'ALIYUN_ROCKETMQ'."\n", + ], + 'instanceId' => [ + 'description' => 'The instance ID. If you set instanceType to EXTERNAL_ROCKETMQ, the system automatically generates an ID for the instance. You can obtain the ID by querying the global message backup plan.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rmq-cn-em93y94xxx', + ], + 'topicName' => [ + 'description' => 'The topic name. You must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Topic_xxx', + ], + 'consumerGroupId' => [ + 'description' => 'The ID of the consumer group. If you use the two-way backup mode, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GID_xxx', + 'deprecated' => true, + ], + 'deliveryOrderType' => [ + 'description' => 'The method used to deliver messages to the destination instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Concurrently: concurrent delivery'."\n" + .'* Orderly: ordered delivery'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Concurrently' => '', + 'Orderly' => '', + ], + 'example' => 'Concurrently', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0C32BED2-FA9F-50AD-9DA7-8B70E26C9D0D', + ], + 'success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0C32BED2-FA9F-50AD-9DA7-8B70E26C9D0D\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'UpdateDisasterRecoveryItem', + ], + 'DeleteDisasterRecoveryItem' => [ + 'summary' => 'Deletes a topic mapping of a Global Replicator task.', + 'path' => '/disaster_recovery/{planId}/items/{itemId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'planId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Backup plan ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1300000016', + ], + ], + [ + 'name' => 'itemId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Backup mapping task ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100000650', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '0B962390-D84B-5D44-8C11-79DFxxxx', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Whether the operation was successful', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The return data', + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code', + 'type' => 'string', + 'example' => 'DisasterRecoveryItemStatus.Error', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message', + 'type' => 'string', + 'example' => 'The current status of the disaster recovery item does not support this operation.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code', + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'Dynamic error message', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'Access denied details, only in the scenario where the user is denied access due to RAM not having permission', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B962390-D84B-5D44-8C11-79DFxxxx\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"DisasterRecoveryItemStatus.Error\\",\\n \\"message\\": \\"The current status of the disaster recovery item does not support this operation.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'DeleteDisasterRecoveryItem', + ], + 'StartDisasterRecoveryItem' => [ + 'summary' => 'Starts a topic mapping of a Global Replicator task.', + 'path' => '/disaster_recovery/{planId}/items/{itemId}/start', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'planId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Backup plan ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1300000016', + ], + ], + [ + 'name' => 'itemId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Mapping task ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100000704', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'C7E8AE3A-219B-52EE-BE32-4036Fxxxxx', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Whether the operation was successful', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'Return result', + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code', + 'type' => 'string', + 'example' => 'DisasterRecoveryItemStatus.Error', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message', + 'type' => 'string', + 'example' => 'The current status of the disaster recovery item does not support this operation.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code', + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'Dynamic error message', + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied due to the reason that the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7E8AE3A-219B-52EE-BE32-4036Fxxxxx\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"DisasterRecoveryItemStatus.Error\\",\\n \\"message\\": \\"The current status of the disaster recovery item does not support this operation.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'StartDisasterRecoveryItem', + 'translator' => 'machine', + ], + 'StopDisasterRecoveryItem' => [ + 'summary' => 'Stops a topic mapping of a Global Replicator task.', + 'path' => '/disaster_recovery/{planId}/items/{itemId}/stop', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'planId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Backup plan ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1300000016', + ], + ], + [ + 'name' => 'itemId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Mapping task ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100070284', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'A07B41BD-6DD3-5349-9E76-00303xxxx', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Whether the operation was successful', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'Return result', + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code', + 'type' => 'string', + 'example' => 'DisasterRecoveryItemStatus.Error', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message', + 'type' => 'string', + 'example' => 'The current status of the disaster recovery item does not support this operation.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code', + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'Dynamic error message', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A07B41BD-6DD3-5349-9E76-00303xxxx\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"DisasterRecoveryItemStatus.Error\\",\\n \\"message\\": \\"The current status of the disaster recovery item does not support this operation.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'StopDisasterRecoveryItem', + 'translator' => 'machine', + ], + 'ListDisasterRecoveryItems' => [ + 'summary' => 'Queries the Global Replicator tasks of an instance.', + 'path' => '/disaster_recovery/{planId}/items', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225046', + 'abilityTreeNodes' => [ + 'FEATUREonsOVRH1R', + 'FEATUREonsU22PJL', + ], + ], + 'parameters' => [ + [ + 'name' => 'planId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the Global Replicator task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The topic name.'."\n", + 'example' => 'topic-test920', + ], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => [ + 'description' => 'The filter condition. Topics are filtered by topic name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'topic_test', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MyPage<DisasterRecoveryItemDTO>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C115601B-8736-5BBF-AC99-7FEAE12xxxx', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'scrollId' => [ + 'title' => '滚动标识', + 'description' => 'The scroll ID of the request. The ID is automatically generated by the system. The result can be paginated only if this parameter is included in the pagination request.'."\n", + 'type' => 'string', + 'example' => 'B13D0B07-F24B-4790-88D8-D47A38063D00'."\n", + ], + 'pageNumber' => [ + 'title' => '当前页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页大小', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'totalCount' => [ + 'title' => '总记录数', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '49', + ], + 'list' => [ + 'title' => '分页数据', + 'description' => 'The Global Replicator tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The Global Replicator task.'."\n", + 'type' => 'object', + 'properties' => [ + 'itemId' => [ + 'description' => 'The ID of the Global Replicator task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100070284', + ], + 'planId' => [ + 'title' => '容灾Item所在容灾计划ID', + 'description' => 'The ID of the topic mapping.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1300000016', + ], + 'itemStatus' => [ + 'title' => '容灾Item状态,DisasterRecoveryItemStatusEnum[CREATING(创建中),CHANGING(变更中),RUNNING(运行中),MANUAL_STOPPED(人工停用),OVERDUE_STOPPED(欠费停用),code,desc]', + 'description' => 'The status of the topic mapping. Valid values:'."\n" + ."\n" + .'* CREATING'."\n" + .'* CHANGING'."\n" + .'* RUNNING'."\n" + .'* MANUAL_STOPPED'."\n" + .'* OVERDUE_STOPPED'."\n", + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'topics' => [ + 'title' => '容灾Item所包含的容灾主题', + 'description' => 'The topics involved in the topic mapping.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The topic involved in the topic mapping.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => 'regionId'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceType' => [ + 'title' => '实例类型', + 'description' => 'The instance type.'."\n", + 'type' => 'string', + 'example' => 'ALIYUN_ROCKETMQ', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-kh43w0olz0c', + ], + 'topicName' => [ + 'title' => '容灾主题名称', + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'example' => 'topic-test', + ], + 'consumerGroupId' => [ + 'title' => '消费者组ID', + 'description' => 'The ID of the consumer group.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'example' => 'group-test', + ], + 'deliveryOrderType' => [ + 'description' => 'The method used to deliver messages to the destination instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Concurrently: concurrent delivery'."\n" + .'* Orderly: ordered delivery'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Concurrently' => '', + 'Orderly' => '', + ], + 'example' => 'Concurrently', + ], + ], + ], + ], + 'extInfo' => [ + 'title' => '扩展信息', + 'description' => 'The extended information.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The extended information.'."\n", + 'example' => '{}', + ], + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the query task was created.'."\n", + 'type' => 'string', + 'example' => '2024-09-20 03:38:28', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the query task was last modified.'."\n", + 'type' => 'string', + 'example' => '2024-10-04 02:19:44', + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C115601B-8736-5BBF-AC99-7FEAE12xxxx\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"scrollId\\": \\"B13D0B07-F24B-4790-88D8-D47A38063D00\\\\n\\",\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 49,\\n \\"list\\": [\\n {\\n \\"itemId\\": 100070284,\\n \\"planId\\": 1300000016,\\n \\"itemStatus\\": \\"RUNNING\\",\\n \\"topics\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceType\\": \\"ALIYUN_ROCKETMQ\\",\\n \\"instanceId\\": \\"rmq-cn-kh43w0olz0c\\",\\n \\"topicName\\": \\"topic-test\\",\\n \\"consumerGroupId\\": \\"group-test\\",\\n \\"deliveryOrderType\\": \\"Concurrently\\"\\n }\\n ],\\n \\"extInfo\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"createTime\\": \\"2024-09-20 03:38:28\\",\\n \\"updateTime\\": \\"2024-10-04 02:19:44\\"\\n }\\n ]\\n },\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'ListDisasterRecoveryItems', + 'translator' => 'machine', + ], + 'GetDisasterRecoveryItem' => [ + 'summary' => 'Queries the details of a topic mapping in a Global Replicator task.', + 'path' => '/disaster_recovery/{planId}/items/{itemId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225053', + 'abilityTreeNodes' => [ + 'FEATUREonsOVRH1R', + ], + ], + 'parameters' => [ + [ + 'name' => 'planId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the global message backup plan.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1300000016', + ], + ], + [ + 'name' => 'itemId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the topic mapping.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100070284', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<DisasterRecoveryItemDTO>', + 'description' => 'Result<DisasterRecoveryItemDTO>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'itemId' => [ + 'description' => 'The ID of the topic mapping', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100070284', + ], + 'planId' => [ + 'title' => '容灾Item所在容灾计划ID', + 'description' => 'The ID of the global message backup plan.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1300000016', + ], + 'itemStatus' => [ + 'title' => '容灾Item状态,DisasterRecoveryItemStatusEnum[CREATING(创建中),CHANGING(变更中),RUNNING(运行中),MANUAL_STOPPED(人工停用),OVERDUE_STOPPED(欠费停用),code,desc]', + 'description' => 'The topic mapping task status.', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'topics' => [ + 'title' => '容灾Item所包含的容灾主题', + 'description' => 'Topics included in the backup mapping', + 'type' => 'array', + 'items' => [ + 'description' => 'Topics included in the backup mapping', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => 'regionId', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceType' => [ + 'title' => '实例类型', + 'description' => 'Instance type'."\n" + .' - ALIYUN_ROCKETMQ: Alibaba Cloud instance'."\n" + .' - EXTERNAL_ROCKETMQ: External instance, open-source instance, open-source cluster', + 'type' => 'string', + 'example' => 'ALIYUN_ROCKETMQ', + ], + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'rmq-cn-wwo3xxx', + ], + 'topicName' => [ + 'title' => '容灾主题名称', + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'example' => 'order_push_xxx', + ], + 'consumerGroupId' => [ + 'title' => '消费者组ID', + 'description' => 'The consumer group ID.'."\n", + 'type' => 'string', + 'example' => 'xxx_reserve_group', + 'deprecated' => true, + ], + 'deliveryOrderType' => [ + 'description' => 'The order in which messages are delivered to the target instance. The parameter values are as follows:'."\n" + .' - Concurrently: concurrent delivery'."\n" + .' - Orderly: sequential delivery', + 'type' => 'string', + 'enumValueTitles' => [ + 'Concurrently' => 'Concurrently', + 'Orderly' => 'Orderly', + ], + 'example' => 'Concurrently', + ], + ], + ], + ], + 'extInfo' => [ + 'title' => '扩展信息', + 'description' => 'Additional Information', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{}', + 'description' => 'Additional Information', + ], + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the topic mapping task was created.', + 'type' => 'string', + 'example' => '2024-06-24 02:57:31', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the topic mapping task was last updated.', + 'type' => 'string', + 'example' => '2024-09-26 02:13:10', + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'accessDeniedDetail' => [ + 'title' => '访问拒绝详细信息，有且仅有在因RAM无权限拒绝用户访问的场景', + 'description' => 'The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"itemId\\": 100070284,\\n \\"planId\\": 1300000016,\\n \\"itemStatus\\": \\"RUNNING\\",\\n \\"topics\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceType\\": \\"ALIYUN_ROCKETMQ\\",\\n \\"instanceId\\": \\"rmq-cn-wwo3xxx\\",\\n \\"topicName\\": \\"order_push_xxx\\",\\n \\"consumerGroupId\\": \\"xxx_reserve_group\\",\\n \\"deliveryOrderType\\": \\"Concurrently\\"\\n }\\n ],\\n \\"extInfo\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"createTime\\": \\"2024-06-24 02:57:31\\",\\n \\"updateTime\\": \\"2024-09-26 02:13:10\\"\\n },\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"xxx\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\",\\n \\"accessDeniedDetail\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'GetDisasterRecoveryItem', + ], + 'ListDisasterRecoveryCheckpoints' => [ + 'summary' => 'Queries consumer progress synchronization tasks.', + 'path' => '/disaster_recovery/{planId}/items/{itemId}/checkpoints', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '251690', + 'abilityTreeNodes' => [ + 'FEATUREonsOVRH1R', + ], + ], + 'parameters' => [ + [ + 'name' => 'planId', + 'in' => 'path', + 'schema' => [ + 'title' => '备份计划ID', + 'description' => 'Backup Plan ID', + 'type' => 'string', + 'required' => true, + 'example' => '1300000016', + ], + ], + [ + 'name' => 'itemId', + 'in' => 'path', + 'schema' => [ + 'title' => '备份映射ID', + 'description' => 'Backup Mapping ID', + 'type' => 'string', + 'required' => true, + 'example' => '100070284', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '源实例ID', + 'description' => 'Source Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => [ + 'title' => '过滤条件', + 'description' => 'Filter Condition', + 'type' => 'string', + 'required' => false, + 'example' => 'topic_test', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Current page number, starting from 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page size, the maximum number of results returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response Result', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'description' => 'Whether the operation was successful', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'description' => 'Response Data', + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'description' => 'Current page number', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => 'Page size', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'totalCount' => [ + 'description' => 'Total number of records', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'list' => [ + 'description' => 'Paged data', + 'type' => 'array', + 'items' => [ + 'description' => 'Paged data', + 'type' => 'object', + 'properties' => [ + 'planId' => [ + 'description' => 'Backup Plan ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13000000xx', + ], + 'itemId' => [ + 'description' => 'Backup Mapping ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000000xx', + ], + 'checkpointId' => [ + 'description' => 'Consumption Progress ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000000xx', + ], + 'lastSyncTime' => [ + 'description' => 'Last synchronization time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1740724080343', + ], + 'sourceProgress' => [ + 'description' => 'Source consumption progress', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => 'Region ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => 'rmq-cn-3mp3vblzxxx', + ], + 'instanceType' => [ + 'description' => 'Instance type'."\n" + .' - ALIYUN_ROCKETMQ: Alibaba Cloud instance'."\n" + .' - EXTERNAL_ROCKETMQ: External instance, open-source instance, open-source cluster', + 'type' => 'string', + 'example' => 'ALIYUN_ROCKETMQ', + ], + 'consumerGroupId' => [ + 'description' => 'Consumer Group ID', + 'type' => 'string', + 'example' => 'GID_TEST', + ], + 'topicName' => [ + 'description' => 'The topic name.'."\n", + 'type' => 'string', + 'example' => 'TOPIC_TEST', + ], + 'lastFetchTime' => [ + 'description' => 'Last fetch time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1740724080343', + ], + 'progressData' => [ + 'description' => 'Consumption progress data', + 'type' => 'object', + 'properties' => [ + 'consumeTimestamp' => [ + 'description' => 'Latest consumption time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1740724080343', + ], + ], + ], + ], + ], + 'targetProgress' => [ + 'description' => 'Target consumption progress', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => 'Region ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'instanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => 'rmq-cn-nwy3i065xxx', + ], + 'instanceType' => [ + 'description' => 'Instance type'."\n" + .' - ALIYUN_ROCKETMQ: Alibaba Cloud instance'."\n" + .' - EXTERNAL_ROCKETMQ: External instance, open-source instance, open-source cluster', + 'type' => 'string', + 'example' => 'ALIYUN_ROCKETMQ', + ], + 'consumerGroupId' => [ + 'description' => 'Consumer group ID', + 'type' => 'string', + 'example' => 'GID_TEST', + ], + 'topicName' => [ + 'description' => 'Topic name', + 'type' => 'string', + 'example' => 'TOPIC_TEST', + ], + 'lastFetchTime' => [ + 'description' => 'Latest fetch time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1740724080343', + ], + 'progressData' => [ + 'description' => 'Consumption progress data', + 'type' => 'object', + 'properties' => [ + 'consumeTimestamp' => [ + 'description' => 'Latest consumption time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1740724080343', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'code' => [ + 'description' => 'Error code', + 'type' => 'string', + 'example' => '200', + ], + 'message' => [ + 'description' => 'Error message', + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'description' => 'Dynamic error code', + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"planId\\": 0,\\n \\"itemId\\": 0,\\n \\"checkpointId\\": 0,\\n \\"lastSyncTime\\": 1740724080343,\\n \\"sourceProgress\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-3mp3vblzxxx\\",\\n \\"instanceType\\": \\"ALIYUN_ROCKETMQ\\",\\n \\"consumerGroupId\\": \\"GID_TEST\\",\\n \\"topicName\\": \\"TOPIC_TEST\\",\\n \\"lastFetchTime\\": 1740724080343,\\n \\"progressData\\": {\\n \\"consumeTimestamp\\": 1740724080343\\n }\\n },\\n \\"targetProgress\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"instanceId\\": \\"rmq-cn-nwy3i065xxx\\",\\n \\"instanceType\\": \\"ALIYUN_ROCKETMQ\\",\\n \\"consumerGroupId\\": \\"GID_TEST\\",\\n \\"topicName\\": \\"TOPIC_TEST\\",\\n \\"lastFetchTime\\": 1740724080343,\\n \\"progressData\\": {\\n \\"consumeTimestamp\\": 1740724080343\\n }\\n }\\n }\\n ]\\n },\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'ListDisasterRecoveryCheckpoints', + 'translator' => 'machine', + ], + 'SyncDisasterRecoveryCheckpoint' => [ + 'summary' => 'Synchronize Disaster Recovery Plan Consumption Progress', + 'path' => '/disaster_recovery/{planId}/items/{itemId}/checkpoints/{checkpointId}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '251695', + 'abilityTreeNodes' => [ + 'FEATUREonsOVRH1R', + ], + ], + 'parameters' => [ + [ + 'name' => 'planId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Backup Plan ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '13000000xx', + ], + ], + [ + 'name' => 'itemId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Mapping ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '13000000xx', + ], + ], + [ + 'name' => 'checkpointId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Consumption Progress ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '13000000xx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response Result', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '7358418D-83BD-507A-8079-611C63E05674', + ], + 'success' => [ + 'description' => 'Success or Not', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'description' => 'Result Data', + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'description' => 'Error Code', + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'description' => 'Error Message', + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'description' => 'HTTP Status Code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'description' => 'Dynamic Error Code', + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7358418D-83BD-507A-8079-611C63E05674\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'SyncDisasterRecoveryCheckpoint', + 'translator' => 'machine', + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags that are added to resources.', + 'path' => '/resourceTag/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域ID。', + 'description' => 'Region ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型。', + 'description' => 'Resource type.', + 'type' => 'string', + 'required' => true, + 'example' => 'instance', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源ID列表，JSON格式。', + 'description' => 'List of resource IDs, in JSON format.', + 'type' => 'string', + 'required' => false, + 'example' => '["rmq-cn-pe334n08h08"]', + ], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'schema' => [ + 'title' => '标签列表，JSON格式。', + 'description' => 'List of tags, in JSON format.', + 'type' => 'string', + 'required' => false, + 'example' => '[{"key": "rmq-test", "value": "test"}]', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '下一个查询开始的位置。', + 'description' => 'The position from which the next query starts.', + 'type' => 'string', + 'required' => false, + 'example' => 'd09e2b63e1b12d905b7080ff70', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Resource group ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmx7caj******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<InnerListTagResourcesResponse>', + 'description' => 'Result<InnerListTagResourcesResponse>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'F00C6A70-C782-5DD6-9D11-0CFC710100C7', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Whether the operation was successful', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'nextToken' => [ + 'description' => 'The position from which the next query starts.', + 'type' => 'string', + 'example' => 'd09e2b63e1b12d905b7080ff70', + ], + 'requestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => 'F00C6A70-C782-5DD6-9D11-0CFC710100C7', + ], + 'tagResources' => [ + 'description' => 'Resource tag relationships.', + 'type' => 'array', + 'items' => [ + 'description' => 'Resource tag relationships.', + 'type' => 'object', + 'properties' => [ + 'resourceType' => [ + 'description' => 'Resource type.', + 'type' => 'string', + 'example' => 'instance', + ], + 'tagValue' => [ + 'description' => 'Tag value.', + 'type' => 'string', + 'example' => 'value', + ], + 'resourceId' => [ + 'description' => 'Resource ID.', + 'type' => 'string', + 'example' => 'rmq-cn-pe334n08h08', + ], + 'tagKey' => [ + 'description' => 'Tag key.', + 'type' => 'string', + 'example' => 'key', + ], + 'category' => [ + 'description' => 'Tag category.', + 'type' => 'string', + 'example' => 'custom', + ], + 'scope' => [ + 'description' => 'Visibility scope.', + 'type' => 'string', + 'example' => 'public', + ], + 'aliUid' => [ + 'description' => 'UID of the resource owner.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1876441048322426', + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code', + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message', + 'type' => 'string', + 'example' => 'The topic already exists.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code', + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'Dynamic error message', + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F00C6A70-C782-5DD6-9D11-0CFC710100C7\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"nextToken\\": \\"d09e2b63e1b12d905b7080ff70\\",\\n \\"requestId\\": \\"F00C6A70-C782-5DD6-9D11-0CFC710100C7\\",\\n \\"tagResources\\": [\\n {\\n \\"resourceType\\": \\"instance\\",\\n \\"tagValue\\": \\"value\\",\\n \\"resourceId\\": \\"rmq-cn-pe334n08h08\\",\\n \\"tagKey\\": \\"key\\",\\n \\"category\\": \\"custom\\",\\n \\"scope\\": \\"public\\",\\n \\"aliUid\\": 1876441048322426\\n }\\n ]\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic already exists.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'ListTagResources', + 'translator' => 'machine', + ], + 'TagResources' => [ + 'summary' => 'Creates resource tags.', + 'path' => '/resourceTag/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域ID。', + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型。', + 'description' => 'The type of resource.'."\n" + ."\n" + .'Set this parameter to **instance**. The value of this parameter cannot be changed.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'instance', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源ID列表，JSON格式。', + 'description' => 'The resource IDs, in the JSON format.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-pe3355cs707', + ], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'schema' => [ + 'title' => '标签列表，JSON格式。', + 'description' => 'tag, in JSON format.', + 'type' => 'string', + 'required' => true, + 'example' => '[{"key": "rmq-test", "value": "test"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0B962390-D84B-5D44-8C11-79DF40299D41', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned result.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B962390-D84B-5D44-8C11-79DF40299D41\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'TagResources', + ], + 'UntagResources' => [ + 'summary' => 'Removes tags from resources.', + 'path' => '/resourceTag/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域ID。', + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型。', + 'description' => 'The type of resource.'."\n" + ."\n" + .'Set this parameter to **instance**. The value of this parameter cannot be changed.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'instance', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源ID列表，JSON格式。', + 'description' => 'The resource IDs, in the JSON format.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-pe3355cs707', + ], + ], + [ + 'name' => 'tagKey', + 'in' => 'query', + 'schema' => [ + 'title' => '标签键列表，JSON格式。', + 'description' => 'The keys of tags.', + 'type' => 'string', + 'required' => false, + 'example' => '["key1", "key2"]', + ], + ], + [ + 'name' => 'all', + 'in' => 'query', + 'schema' => [ + 'title' => '是否删除所有标签。', + 'description' => 'Whether to delete all tags.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'A07B41BD-6DD3-5349-9E76-00303DF04BBE', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter deliveryOrderType is invalid.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A07B41BD-6DD3-5349-9E76-00303DF04BBE\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter deliveryOrderType is invalid.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'UntagResources', + ], + 'ChangeResourceGroup' => [ + 'summary' => 'Changes the resource group to which a ApsaraMQ for RocketMQ instance belongs.', + 'path' => '/resourceGroup/change', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource. Set this parameter to the ID of the ApsaraMQ for RocketMQ instance whose resource group you want to change.', + 'type' => 'string', + 'required' => true, + 'example' => 'c2c5d1274a8d4317a13bc5b0d4******', + ], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of resource.'."\n" + ."\n" + .'Set this parameter to **instance**. The value of this parameter cannot be changed.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'instance' => '', + ], + 'example' => 'instance', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the instance is changed.'."\n" + ."\n" + .'You can call the [ListResourceGroups](https://www.alibabacloud.com/help/resource-management/latest/listresourcegroups) operation to query existing resource groups.', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-9gLOoK****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'code' => [ + 'description' => 'The error code returned if the call failed.'."\n", + 'type' => 'string', + 'example' => 'Instance.NotFound', + ], + 'message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The instance cannot be found.', + ], + 'httpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'dynamicCode' => [ + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": true,\\n \\"code\\": \\"Instance.NotFound\\",\\n \\"message\\": \\"The instance cannot be found.\\",\\n \\"httpStatusCode\\": 400,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'ChangeResourceGroup', + ], + 'GetConsumeTimespan' => [ + 'summary' => 'Queries the time range within which the consumer offset in a topic can be reset.', + 'path' => '/instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeTimespan/{topicName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREons0MOUAZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rmq-cn-7e22ody****', + ], + ], + [ + 'name' => 'consumerGroupId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CID-TEST', + ], + ], + [ + 'name' => 'topicName', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'topicxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Result', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'C115601B-8736-5BBF-AC99-7FEAE1245A80', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rmq-cn-7e22ody****', + ], + 'topicName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'topic_test', + ], + 'consumerGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CID-TEST', + ], + 'minTimestamp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570761026222', + ], + 'maxTimestamp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570761026833', + ], + 'consumeTimestamp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570761026400', + ], + ], + ], + 'code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'dynamicMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C115601B-8736-5BBF-AC99-7FEAE1245A80\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"instanceId\\": \\"rmq-cn-7e22ody****\\",\\n \\"topicName\\": \\"topic_test\\",\\n \\"consumerGroupId\\": \\"CID-TEST\\",\\n \\"minTimestamp\\": 1570761026222,\\n \\"maxTimestamp\\": 1570761026833,\\n \\"consumeTimestamp\\": 1570761026400\\n },\\n \\"code\\": \\"MissingInstanceId\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"xxx\\",\\n \\"dynamicMessage\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => 'GetConsumeTimespan', + ], + 'ListRegions' => [ + 'summary' => 'Queries regions in which ApsaraMQ for RocketMQ is available.', + 'path' => '/regions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<RegionDTO>>', + 'description' => 'Result\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0B962390-D84B-5D44-8C11-79DF40299D41', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The regions.'."\n", + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => 'regionId,类似 cn-hangzhou', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'regionName' => [ + 'title' => '中文region，类似杭州', + 'description' => 'The region name.'."\n", + 'type' => 'string', + 'example' => 'hangzhou', + ], + 'supportRocketmqV5' => [ + 'title' => '是否开通新服 v5版本', + 'description' => 'Indicates whether ApsaraMQ for RocketMQ V5 is activated.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'supportRocketmqV4' => [ + 'title' => '是否开通旧服 v4版本', + 'description' => 'Indicates whether ApsaraMQ for RocketMQ V4 is activated.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the ApsaraMQ for RocketMQ instance was created.'."\n", + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the ApsaraMQ for RocketMQ instance was last modified.'."\n", + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'tags' => [ + 'description' => 'The region tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The region tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'tagCode' => [ + 'description' => 'The tag code.'."\n", + 'type' => 'string', + 'example' => 'xx', + ], + 'tagValue' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'any', + 'example' => 'xx', + ], + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'MissingPageNumber', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'ConsumerGroupId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + ], + ], + ], + ], + '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' => 'ListRegions', + ], + 'ListAvailableZones' => [ + 'summary' => 'Queries the supported zones.', + 'path' => '/zones', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<ZoneDTO>>', + 'description' => 'Result<List<ZoneDTO>>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'AF9A8B10-C426-530F-A0DD-96320B39****', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'The result data that is returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'zoneId' => [ + 'title' => '可用区id', + 'description' => 'The ID of the current zone.'."\n", + 'type' => 'string', + 'example' => 'cn-qingdao-b', + ], + 'zoneName' => [ + 'title' => '可用区名称', + 'description' => 'The name of the current zone.', + 'type' => 'string', + 'example' => 'ha-cn-t9b30w902vm_qrs', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the zone was created.', + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + 'updateTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the zone was last updated.', + 'type' => 'string', + 'example' => '2022-08-01 20:05:50', + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'The error code returned if the call failed.'."\n", + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Parameter instanceId is mandatory for this action .', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'InstanceId', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AF9A8B10-C426-530F-A0DD-96320B39****\\",\\n \\"success\\": true,\\n \\"data\\": [\\n {\\n \\"zoneId\\": \\"cn-qingdao-b\\",\\n \\"zoneName\\": \\"ha-cn-t9b30w902vm_qrs\\",\\n \\"createTime\\": \\"2022-08-01 20:05:50\\",\\n \\"updateTime\\": \\"2022-08-01 20:05:50\\"\\n }\\n ],\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"Parameter instanceId is mandatory for this action .\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"InstanceId\\"\\n}","type":"json"}]', + 'title' => 'ListAvailableZones', + ], + 'ListMetricMeta' => [ + 'summary' => 'Query Monitoring Items List', + 'path' => '/monitor/metrics/meta', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number, indicating which page of the results to return.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100000000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page size, indicating the maximum number of results per page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<MyPage<MetricMetaDTO>>', + 'description' => 'Result<MyPage<MetricMetaDTO>>', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '8B459455-4A35-5796-BA9D-98EF1AB9A931', + ], + 'success' => [ + 'title' => '是否成功', + 'description' => 'Whether the operation was successful', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'title' => '返回结果', + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'title' => '当前页码', + 'description' => 'Current page number', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页大小', + 'description' => 'Page size', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'totalCount' => [ + 'title' => '总记录数', + 'description' => 'Total record count', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'list' => [ + 'title' => '分页数据', + 'description' => 'Paged data', + 'type' => 'array', + 'items' => [ + 'description' => 'List of monitoring items.', + 'type' => 'object', + 'properties' => [ + 'metricName' => [ + 'title' => '监控项名称', + 'description' => 'Monitoring item name', + 'type' => 'string', + 'example' => 'SendMessageCountPerInstance', + ], + 'description' => [ + 'title' => '监控项描述', + 'description' => 'Monitoring item description', + 'type' => 'string', + 'example' => 'Using Serverless Devs to deploy the infrastructure of project:get-userinfo-v1-infrastructure-as-template-project', + ], + 'category' => [ + 'title' => '监控项标签', + 'description' => 'Monitoring item tag', + 'type' => 'string', + 'example' => 'Bug', + ], + ], + ], + ], + ], + ], + 'code' => [ + 'title' => '错误码', + 'description' => 'Error code', + 'type' => 'string', + 'example' => 'Topic.NotFound', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => 'Error message', + 'type' => 'string', + 'example' => 'The topic already exists.', + ], + 'httpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'dynamicCode' => [ + 'title' => '动态错误码', + 'description' => 'Dynamic error code', + 'type' => 'string', + 'example' => 'xxx', + ], + 'dynamicMessage' => [ + 'title' => '动态错误信息', + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8B459455-4A35-5796-BA9D-98EF1AB9A931\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 1,\\n \\"list\\": [\\n {\\n \\"metricName\\": \\"SendMessageCountPerInstance\\",\\n \\"description\\": \\"Using Serverless Devs to deploy the infrastructure of project:get-userinfo-v1-infrastructure-as-template-project\\",\\n \\"category\\": \\"Bug\\"\\n }\\n ]\\n },\\n \\"code\\": \\"Topic.NotFound\\",\\n \\"message\\": \\"The topic already exists.\\",\\n \\"httpStatusCode\\": 200,\\n \\"dynamicCode\\": \\"InstanceId\\",\\n \\"dynamicMessage\\": \\"instanceId\\"\\n}","type":"json"}]', + 'title' => 'ListMetricMeta', + 'translator' => 'machine', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'rocketmq.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'rocketmq.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'rocketmq.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'rocketmq.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'rocketmq.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'rocketmq.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'rocketmq.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'rocketmq.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'rocketmq.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'rocketmq.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'rocketmq.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'rocketmq.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'rocketmq.cn-guangzhou.aliyuncs.com ', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'rocketmq.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'rocketmq.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'rocketmq.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'rocketmq.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'rocketmq.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'rocketmq.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'rocketmq.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'rocketmq.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'rocketmq.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'rocketmq.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'rocketmq.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'rocketmq.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'rocketmq.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'rocketmq.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'rocketmq.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'rocketmq.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'rocketmq.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'rocketmq.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'rocketmq.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'rocketmq.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'rocketmq.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'rocketmq.na-south-1.aliyuncs.com', + ], + ], +]; |