From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/en_us/amqp-open/2019-12-12/api-docs.php | 4478 ++++++++++++++++++++++++++ 1 file changed, 4478 insertions(+) create mode 100644 data/en_us/amqp-open/2019-12-12/api-docs.php (limited to 'data/en_us/amqp-open') diff --git a/data/en_us/amqp-open/2019-12-12/api-docs.php b/data/en_us/amqp-open/2019-12-12/api-docs.php new file mode 100644 index 0000000..4f7d10d --- /dev/null +++ b/data/en_us/amqp-open/2019-12-12/api-docs.php @@ -0,0 +1,4478 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'amqp-open', + 'version' => '2019-12-12', + ], + 'directories' => [ + [ + 'id' => 121315, + 'title' => 'Instances', + 'type' => 'directory', + 'children' => [ + 'CreateInstance', + 'GetInstance', + 'UpdateInstance', + 'UpdateInstanceName', + 'GetMetadataAmount', + 'ListInstances', + ], + ], + [ + 'id' => 121325, + 'title' => 'Vhost', + 'type' => 'directory', + 'children' => [ + 'CreateVirtualHost', + 'DeleteVirtualHost', + 'ListVirtualHosts', + ], + ], + [ + 'id' => 121329, + 'title' => 'Queue', + 'type' => 'directory', + 'children' => [ + 'CreateQueue', + 'DeleteQueue', + 'ListQueueConsumers', + 'ListQueues', + 'ListQueueUpStreamBindings', + ], + ], + [ + 'id' => 121319, + 'title' => 'Exchange', + 'type' => 'directory', + 'children' => [ + 'CreateExchange', + 'DeleteExchange', + 'ListDownStreamBindings', + 'ListExchanges', + 'ListExchangeUpStreamBindings', + ], + ], + [ + 'id' => 121311, + 'title' => 'Binding', + 'type' => 'directory', + 'children' => [ + 'CreateBinding', + 'DeleteBinding', + 'ListBindings', + ], + ], + [ + 'id' => 177638, + 'title' => 'Account', + 'type' => 'directory', + 'children' => [ + 'CreateAccount', + 'DeleteAccount', + 'ListAccounts', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateInstance' => [ + 'summary' => 'Creates an ApsaraMQ for RabbitMQ instance.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '194334', + 'abilityTreeNodes' => [ + 'FEATUREonsQ3252I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => 'The client token.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c2c5d1274axxxxxxxx', + ], + ], + [ + 'name' => 'PaymentType', + 'in' => 'query', + 'schema' => [ + 'title' => '付费类型', + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'* Subscription: subscription instance'."\n" + .'* PayAsYouGo: serverless instance'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'PayAsYouGo' => 'PayAsYouGo', + 'Subscription' => 'Subscription', + ], + 'example' => 'Subscription', + 'enum' => [ + 'Subscription', + 'PayAsYouGo', + ], + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'title' => '预付费周期，单位: periodCycle', + 'description' => 'The subscription period. The unit of the subscription period is specified by periodCycle.'."\n" + ."\n" + .'> This parameter takes effect only if you set PaymentType to Subscription. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PeriodCycle', + 'in' => 'query', + 'schema' => [ + 'title' => '预付费周期单位', + 'description' => 'The unit of the subscription period. Valid values:'."\n" + ."\n" + .'* Month'."\n" + .'* Year'."\n" + ."\n" + .'This parameter is valid only if you set PaymentType to Subscription. Default value: Month.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Month' => 'Month', + 'Year' => 'Year', + ], + 'example' => 'Month', + 'default' => 'Month', + 'enum' => [ + 'Month', + 'Year', + 'M', + 'Y', + ], + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'title' => '续费方式', + 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" + ."\n" + .'* true: enables auto-renewal.'."\n" + .'* false: disables auto-renewal. If you select this value, you must manually renew the instance.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'AutoRenewal', + 'default' => 'false', + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'query', + 'schema' => [ + 'title' => '自动续费周期，单位：月', + 'description' => 'The auto-renewal period. The unit of the auto-renewal period is specified by RenewalDurationUnit. Default value: Month.'."\n" + ."\n" + .'> This parameter takes effect only if you set AutoRenew to true. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'RenewStatus', + 'in' => 'query', + 'schema' => [ + 'title' => 'autoRenew和renewStatus都是续费方式，当两个同时填写时，以renewStatus为准', + 'description' => 'The renewal status. This parameter is the same as AutoRenew. You can configure one of these parameters. Valid value:'."\n" + ."\n" + .'* AutoRenewal'."\n" + ."\n" + .'> If you configure both this parameter and AutoRenew, the value of this parameter is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RenewalDurationUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the auto-renewal period. Valid values:'."\n" + ."\n" + .'* Month'."\n" + .'* Year'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Month' => 'Month', + 'Year' => 'Year', + ], + 'example' => 'Month', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'title' => '实例规格类型', + 'description' => 'The instance edition. Valid values if you create a subscription instance:'."\n" + ."\n" + .'* professional: Professional Edition.'."\n" + .'* enterprise: Enterprise Edition'."\n" + .'* vip: Enterprise Platinum Edition'."\n" + ."\n" + .'If you create a serverless instance, you do not need to specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'enterprise' => 'enterprise', + 'vip' => 'vip', + 'professional' => 'professional', + ], + 'example' => 'professional', + 'enum' => [ + 'professional', + 'enterprise', + 'vip', + 'serverless', + ], + ], + ], + [ + 'name' => 'ServerlessChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the serverless instance. Valid value:'."\n" + ."\n" + .'* onDemand: You are charged based on your actual usage.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'onDemand', + 'enum' => [ + 'onDemand', + ], + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the instance. We recommend that you specify a name that does not exceed 64 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'amqp-xxxxx', + ], + ], + [ + 'name' => 'MaxPrivateTps', + 'in' => 'query', + 'schema' => [ + 'title' => '私网TPS流量，单位：次/秒', + 'description' => 'The maximum number of virtual private cloud (VPC)-based transactions per second (TPS) on the instance.'."\n" + ."\n" + .'Configure this parameter based on the values provided on the [ApsaraMQ for RocketMQ buy page](https://common-buy.aliyun.com/?commodityCode=ons_onsproxy_pre).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'SupportEip', + 'in' => 'query', + 'schema' => [ + 'title' => '是否支持公网', + 'description' => 'Specifies whether elastic IP addresses (EIPs) are supported. Valid values:'."\n" + ."\n" + .'* True'."\n" + .'* False'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'MaxEipTps', + 'in' => 'query', + 'schema' => [ + 'title' => '公网网TPS流量峰值，单位：TPS', + 'description' => 'The maximum number of Internet-based TPS on the instance.'."\n" + ."\n" + .'Configure this parameter based on the values provided on the [ApsaraMQ for RocketMQ buy page](https://common-buy.aliyun.com/?commodityCode=ons_onsproxy_pre).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '128', + 'default' => '128', + ], + ], + [ + 'name' => 'QueueCapacity', + 'in' => 'query', + 'schema' => [ + 'title' => '配置Queue的数量上限', + 'description' => 'The number of queues on the instance.'."\n" + ."\n" + .'Configure this parameter based on the values provided on the [ApsaraMQ for RocketMQ buy page](https://common-buy.aliyun.com/?commodityCode=ons_onsproxy_pre).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'MaxConnections', + 'in' => 'query', + 'schema' => [ + 'title' => '最大连接数', + 'description' => 'The maximum number of connections that can be established to the instance.'."\n" + ."\n" + .'Configure this parameter based on the values provided on the [ApsaraMQ for RocketMQ buy page](https://common-buy.aliyun.com/?commodityCode=ons_onsproxy_pre).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50000', + ], + ], + [ + 'name' => 'StorageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '配置消息存储空间', + 'description' => 'The storage capacity. Unit: GB. Valid values:'."\n" + ."\n" + .'* Professional Edition and Enterprise Edition instances: Set the value to 0.'."\n" + ."\n" + .'> The value 0 specifies that storage space is available for Professional Edition and Enterprise Edition instances, but no storage fees are generated.'."\n" + ."\n" + .'* Enterprise Platinum Edition instances: Set the value to m × 100, where m is an integer that ranges from 7 to 28.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'SupportTracing', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开通消息轨迹功能', + 'description' => 'Specifies whether to enable the message trace feature. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* Enterprise Platinum Edition instances allow you to retain message traces for 15 days free of charge. If you create an Enterprise Platinum Edition instance, you can set this parameter only to true and TracingStorageTime only to 15.'."\n" + ."\n" + .'* For instances of other editions, you can set this parameter to true or false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'TracingStorageTime', + 'in' => 'query', + 'schema' => [ + 'title' => '配置消息轨迹的保存时长', + 'description' => 'The retention period of messages. Unit: days. Valid values:'."\n" + ."\n" + .'* 3'."\n" + .'* 7'."\n" + .'* 15'."\n" + ."\n" + .'This parameter is valid only if you set SupportTracing to true.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + 'enum' => [ + '3', + '7', + '15', + ], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmvvajg5qkxhi', + ], + ], + [ + 'name' => 'EncryptedInstance', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开通磁盘存储加密', + 'description' => 'Specifies whether to enable storage encryption for the instance. This parameter is available only for exclusive instances.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'KmsKeyId', + 'in' => 'query', + 'schema' => [ + 'title' => 'kms Key Id', + 'description' => 'The ID of the Key Management Service (KMS)-managed key used for storage encryption. This parameter is available only for exclusive instances and required only if you set EncryptedInstance to true. The key must meet the following conditions:'."\n" + ."\n" + .'* The key cannot be a service key.'."\n" + .'* The key must be in the Enabled state.'."\n" + .'* The key must be a symmetric key.'."\n" + .'* The key must be used for encryption and decryption.'."\n" + .'* After the key is expired or deleted, you cannot read or write data and exceptions can occur in the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key-xxx', + ], + ], + [ + 'name' => 'ProvisionedCapacity', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'Edition', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'enum' => [ + 'shared', + 'dedicated', + ], + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '资源标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签对象', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '资源标签健', + 'type' => 'string', + 'example' => 'testKey', + ], + 'Value' => [ + 'title' => '资源标签值', + 'type' => 'string', + 'example' => 'testValue', + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'JsonResult', + 'description' => 'JsonResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID. You can use the ID to troubleshoot issues. This parameter is a common parameter.'."\n", + 'type' => 'string', + 'example' => 'CCBB1225-C392-480E-8C7F-D09AB2CD2***', + ], + 'Code' => [ + 'description' => 'The HTTP status code. The status code 200 indicates that the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'xxx failed,xxxx', + ], + 'Data' => [ + 'description' => 'The ID of the created instance.'."\n", + 'type' => 'any', + 'example' => 'amqp-cn-xxxxx', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CCBB1225-C392-480E-8C7F-D09AB2CD2***\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"xxx failed,xxxx\\",\\n \\"Data\\": \\"amqp-cn-xxxxx\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n CCBB1225-C392-480E-8C7F-D09AB2CD2***\\n 200\\n xxx failed,xxxx\\n amqp-cn-xxxxx\\n true\\n","errorExample":""}]', + 'title' => 'CreateInstance', + 'description' => '**Before you call this operation, make sure that you fully understand the [billing methods and pricing](~~606747~~) of ApsaraMQ for RabbitMQ.'."\n", + ], + 'GetInstance' => [ + 'summary' => '获取实例详情', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '204415', + 'abilityTreeNodes' => [ + 'FEATUREonsSGDS5X', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'amqp-cn-v0h1kb9nu***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResponse', + 'description' => 'OpenApiResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '92385FD2-624A-48C9-8FB5-753F2AFA***', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Tags' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签key', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Value' => [ + 'title' => '标签value', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SERVING', + ], + 'SupportEIP' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExpireTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1651507200000', + ], + 'OrderCreateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1651507200000', + ], + 'PrivateEndpoint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com'."\n", + ], + 'StorageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200'."\n", + ], + 'MaxEipTps' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'amqp-cn-*********', + ], + 'InstanceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'enterprise', + ], + 'PublicEndpoint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.cn-hangzhou.xxx.net.mq.amqp.aliyuncs.com', + ], + 'ClassicEndpoint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'amqp-cn-st21x7kv****.not-support'."\n", + ], + 'MaxVhost' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50'."\n", + ], + 'MaxTps' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'AutoRenewInstance' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'yunQi-instance', + ], + 'MaxQueue' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'OrderType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PRE_PAID', + ], + 'TracingStorageTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'SupportTracing' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'MaxConnections' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1500', + ], + 'ResourceGroupId' => [ + 'type' => 'string', + ], + 'EncryptedInstance' => [ + 'type' => 'boolean', + ], + 'KmsKeyId' => [ + 'type' => 'string', + ], + 'ProvisionedCapacity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Edition' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"92385FD2-624A-48C9-8FB5-753F2AFA***\\",\\n \\"Data\\": {\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"标签key\\",\\n \\"Value\\": \\"标签value\\"\\n }\\n ],\\n \\"Status\\": \\"SERVING\\",\\n \\"SupportEIP\\": true,\\n \\"ExpireTime\\": 1651507200000,\\n \\"OrderCreateTime\\": 1651507200000,\\n \\"PrivateEndpoint\\": \\"amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com\\\\n\\",\\n \\"StorageSize\\": 200,\\n \\"MaxEipTps\\": 1000,\\n \\"InstanceId\\": \\"amqp-cn-*********\\",\\n \\"InstanceType\\": \\"enterprise\\",\\n \\"PublicEndpoint\\": \\"xxx.cn-hangzhou.xxx.net.mq.amqp.aliyuncs.com\\",\\n \\"ClassicEndpoint\\": \\"amqp-cn-st21x7kv****.not-support\\\\n\\",\\n \\"MaxVhost\\": 50,\\n \\"MaxTps\\": 1000,\\n \\"AutoRenewInstance\\": false,\\n \\"InstanceName\\": \\"yunQi-instance\\",\\n \\"MaxQueue\\": 1000,\\n \\"OrderType\\": \\"PRE_PAID\\",\\n \\"TracingStorageTime\\": 15,\\n \\"SupportTracing\\": true,\\n \\"MaxConnections\\": 1500,\\n \\"ResourceGroupId\\": \\"rg-acfm2vn6jkayvfy\\",\\n \\"EncryptedInstance\\": true,\\n \\"KmsKeyId\\": \\"key-hzz6566e86byam3lg5rw4\\",\\n \\"ProvisionedCapacity\\": 2000,\\n \\"Edition\\": \\"shared\\"\\n }\\n}","type":"json"}]', + ], + 'UpdateInstance' => [ + 'summary' => 'Upgrades or downgrades the configurations of an ApsaraMQ for RabbitMQ instance.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '213154', + 'abilityTreeNodes' => [ + 'FEATUREonsQ3252I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => 'The client token.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c2c5d1274axxxxxxxx', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '变配的实例 id，必填', + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'amqp-cn-jtexxxxx', + 'enum' => [], + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'title' => '变配类型:'."\n" + .'- UPGRADE：升配'."\n" + .'- DOWNGRADE：降配', + 'description' => 'The type of the configuration change. Valid values:'."\n" + ."\n" + .'* UPGRADE'."\n" + .'* DOWNGRADE'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'UPGRADE', + 'enum' => [ + 'UPGRADE', + 'DOWNGRADE', + ], + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'title' => '实例规格类型', + 'description' => 'The instance edition. Valid values for subscription instances:'."\n" + ."\n" + .'* professional: Professional Edition'."\n" + .'* enterprise: Enterprise Edition'."\n" + .'* vip: Enterprise Platinum Edition.'."\n" + ."\n" + .'If your instance is a pay-as-you-go instance, you do not need to configure this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'professional', + 'enum' => [ + 'professional', + 'enterprise', + 'vip', + ], + ], + ], + [ + 'name' => 'ServerlessChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the serverless instance. Valid values:'."\n" + ."\n" + .'* onDemand: You are charged based on your actual usage.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'onDemand', + 'enum' => [ + 'onDemand', + ], + ], + ], + [ + 'name' => 'MaxPrivateTps', + 'in' => 'query', + 'schema' => [ + 'title' => '私网TPS流量，单位：次/秒', + 'description' => 'The peak transactions per second (TPS) for accessing the instance in a virtual private cloud (VPC).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'SupportEip', + 'in' => 'query', + 'schema' => [ + 'title' => '是否支持公网', + 'description' => 'Specifies whether elastic IP addresses (EIPs) are supported.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'MaxEipTps', + 'in' => 'query', + 'schema' => [ + 'title' => '公网网TPS流量峰值，单位：TPS', + 'description' => 'The peak TPS for accessing the instance over the Internet.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '128', + 'default' => '128', + ], + ], + [ + 'name' => 'QueueCapacity', + 'in' => 'query', + 'schema' => [ + 'title' => '配置Queue的数量上限', + 'description' => 'The maximum number of queues that can be created on the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'MaxConnections', + 'in' => 'query', + 'schema' => [ + 'title' => '最大连接数', + 'description' => 'The maximum number of connections that can be created on the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'StorageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '配置消息存储空间', + 'description' => 'The size of the storage space that can be used to store messages.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'SupportTracing', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开通消息轨迹功能', + 'description' => 'Specifies whether to enable the message trace feature.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'TracingStorageTime', + 'in' => 'query', + 'schema' => [ + 'title' => '配置消息轨迹的保存时长', + 'description' => 'The retention period of message traces.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 3'."\n" + .'* 7'."\n" + .'* 15'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + 'enum' => [ + '3', + '7', + '15', + ], + ], + ], + [ + 'name' => 'EncryptedInstance', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开通磁盘存储加密', + 'description' => '实例是否开通数据存储加密功能', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'KmsKeyId', + 'in' => 'query', + 'schema' => [ + 'title' => 'kms Key Id', + 'description' => '使用同地域下KMS密钥ID', + 'type' => 'string', + 'required' => false, + 'example' => 'key-bjj66c2a893vmhawtq5fd', + ], + ], + [ + 'name' => 'ProvisionedCapacity', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'Edition', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'enum' => [ + 'shared', + 'dedicated', + ], + ], + ], + ], + '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' => '628705FD-03EE-4ABE-BB21-E1672960***', + ], + 'Code' => [ + 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'InstanceNotExist', + ], + 'Data' => [ + 'description' => 'The returned data, which includes orderId and instanceId. Sample returned data:'."\n" + ."\n" + .'```json'."\n" + .'"Data": {'."\n" + .' "instanceId": "amqp-cn-xxxxx",'."\n" + .' "orderId": 22222'."\n" + .' }'."\n" + .'```'."\n", + 'type' => 'any', + 'example' => '{“instanceId”: “amqp-cn-jtexxxxx”, “orderId”: 2222222}', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'StatusCode' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'INSUFFICIENT_AVAILABLE_QUOTA', + 'errorMessage' => 'Your account available limit is less than 0, please recharge before trying to purchase.', + ], + [ + 'errorCode' => 'UpDowngradeConfigNoChange', + 'errorMessage' => 'The upgrade or downgrade configuration is not changed.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UnauthorizedOperation', + 'errorMessage' => 'The request has failed due to unauthorized operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"628705FD-03EE-4ABE-BB21-E1672960***\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"InstanceNotExist\\",\\n \\"Data\\": \\"{\'instanceId\': \'rabbitmq-serverless-cn-lf63qsjlf06\', \'orderId\': 234170302080010}\\",\\n \\"Success\\": \\"true\\",\\n \\"StatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'UpdateInstance', + ], + 'UpdateInstanceName' => [ + 'summary' => 'Updates the name of an ApsaraMQ for RabbitMQ instance. After an ApsaraMQ for RabbitMQ instance is created, the ID of the instance is used as its name by default. You can specify a custom name for an instance to facilitate instance identification.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsSGDS5X', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance for which you want to update the name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amqp-cn-zvp2ajsj****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new name of the instance. No limits are imposed on the value. We recommend that you set this parameter to a maximum of 64 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amqp-cn-ZVp2ajsj****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The returned HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message that is returned when an error occurs during the update of the instance name.'."\n", + 'type' => 'string', + 'example' => 'InstanceNotExist', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6DC68EC9-0E76-5435-B8C0-FF9492B4****', + ], + 'Success' => [ + 'description' => 'The returned message that indicates the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"InstanceNotExist\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"6DC68EC9-0E76-5435-B8C0-FF9492B4****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 6DC68EC9-0E76-5435-B8C0-FF9492B4****\\n true\\n 200\\n true\\n","errorExample":""}]', + 'title' => 'UpdateInstanceName', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetMetadataAmount' => [ + 'summary' => 'Queries the maximum number of vhosts, exchanges, and queues that you can create and the number of created vhosts, exchanges, and queues on an ApsaraMQ for RabbitMQ instance.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'amqp-cn-v0h1kb9n***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B75ACF23-2BEB-44AC-A0B6-AE14EDCA***', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxVirtualHosts' => [ + 'description' => 'The maximum number of vhosts that can be created on the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CurrentVirtualHosts' => [ + 'description' => 'The number of created vhosts on the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaxQueues' => [ + 'description' => 'The maximum number of queues that can be created on the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'CurrentExchanges' => [ + 'description' => 'The number of created exchanges on the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'MaxExchanges' => [ + 'description' => 'The maximum number of exchanges that can be created on the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'CurrentQueues' => [ + 'description' => 'The number of created queues on the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B75ACF23-2BEB-44AC-A0B6-AE14EDCA***\\",\\n \\"Data\\": {\\n \\"MaxVirtualHosts\\": 10,\\n \\"CurrentVirtualHosts\\": 1,\\n \\"MaxQueues\\": 20,\\n \\"CurrentExchanges\\": 7,\\n \\"MaxExchanges\\": 20,\\n \\"CurrentQueues\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B75ACF23-2BEB-44AC-A0B6-AE14EDCA***\\n \\n 20\\n 10\\n 7\\n 20\\n 1\\n 1\\n \\n","errorExample":""}]', + 'title' => 'GetMetadataAmount', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListInstances' => [ + 'summary' => 'Queries all AparaMQ for RabbitMQ instances in a region. The returned data includes the basic information, endpoint, and specification limits of each instance.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '58735', + 'abilityTreeNodes' => [ + 'FEATUREonsQ3252I', + ], + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that marks the end position of the previous returned page. To obtain the next batch of data, call the operation again by using the value of NextToken returned by the previous request. If you call this operation for the first time or want to query all results, set NextToken to an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Valid values: 1 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the instances belong.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzu74zjgdu4mq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CCBB1225-C392-480E-8C7F-D09AB2CD2***', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token that marks the end of the current returned page. If this parameter is empty, all data is retrieved.'."\n", + 'type' => 'string', + 'example' => 'caebacccb2be03f84eb48b699f0a****', + ], + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Instances' => [ + 'description' => 'The instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The instance status. Valid values:'."\n" + ."\n" + .'* DEPLOYING: The instance is being deployed.'."\n" + .'* EXPIRED: The instance is expired.'."\n" + .'* SERVING: The instance is running.'."\n" + .'* RELEASED: The instance is released.'."\n", + 'type' => 'string', + 'example' => 'SERVING', + ], + 'SupportEIP' => [ + 'description' => 'Indicates whether the instance supports elastic IP addresses (EIPs).'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExpireTime' => [ + 'description' => 'The timestamp that indicates when the instance expires. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1651507200000', + ], + 'OrderCreateTime' => [ + 'description' => 'The timestamp that indicates when the order was created. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1572441939000', + ], + 'PrivateEndpoint' => [ + 'description' => 'The virtual private cloud (VPC) endpoint of the instance.'."\n", + 'type' => 'string', + 'example' => 'amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com', + ], + 'StorageSize' => [ + 'description' => 'The disk size. Unit: GB.'."\n" + ."\n" + .'> For Professional Edition instances and Enterprise Edition instances, this parameter is unavailable and \\*\\*-1\\*\\* is returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'MaxEipTps' => [ + 'description' => 'The maximum number of Internet-based transactions per second (TPS) for the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24832', + ], + 'InstanceId' => [ + 'description' => 'The instance ID'."\n", + 'type' => 'string', + 'example' => 'amqp-cn-st21x7kv****', + ], + 'InstanceType' => [ + 'description' => 'The instance type.'."\n" + ."\n" + .'* PROFESSIONAL: Professional Edition'."\n" + .'* ENTERPRISE: Enterprise Edition'."\n" + .'* VIP: Enterprise Platinum Edition'."\n", + 'type' => 'string', + 'example' => 'professional', + ], + 'PublicEndpoint' => [ + 'description' => 'The public endpoint of the instance.'."\n", + 'type' => 'string', + 'example' => 'amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com', + ], + 'ClassicEndpoint' => [ + 'description' => 'The endpoint that is used to access the instance over the classic network. This parameter is no longer available.'."\n", + 'type' => 'string', + 'example' => 'amqp-cn-st21x7kv****.not-support', + ], + 'MaxVhost' => [ + 'description' => 'The maximum number of vhosts on the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'MaxTps' => [ + 'description' => 'The maximum number of VPC-based TPS for the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5000', + ], + 'AutoRenewInstance' => [ + 'description' => 'Indicates whether the instance is automatically renewed.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'InstanceName' => [ + 'description' => 'The instance name.'."\n", + 'type' => 'string', + 'example' => 'amqp-cn-st21x7kv****', + ], + 'MaxQueue' => [ + 'description' => 'The maximum number of queues on the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'OrderType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* PrePaid: the subscription billing method.'."\n" + .'* POST_PAID: the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'example' => 'PRE_PAID', + ], + 'Tags' => [ + 'description' => 'The tags that are added to the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag that is added to the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'region', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'hangzhou', + ], + ], + ], + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the instance belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-aek3axfj2w4czrq', + ], + 'EncryptedInstance' => [ + 'description' => 'Indicates whether the encryption at rest feature is enabled for the instance.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'KmsKeyId' => [ + 'description' => 'The ID of the Key Management Service (KMS) key used for the data disk.'."\n", + 'type' => 'string', + 'example' => 'key-bjj66c2a893vmhawtq5fd', + ], + 'ProvisionedCapacity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Edition' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CCBB1225-C392-480E-8C7F-D09AB2CD2***\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"caebacccb2be03f84eb48b699f0a****\\",\\n \\"MaxResults\\": 1,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"SERVING\\",\\n \\"SupportEIP\\": true,\\n \\"ExpireTime\\": 1651507200000,\\n \\"OrderCreateTime\\": 1572441939000,\\n \\"PrivateEndpoint\\": \\"amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com\\",\\n \\"StorageSize\\": 200,\\n \\"MaxEipTps\\": 24832,\\n \\"InstanceId\\": \\"amqp-cn-st21x7kv****\\",\\n \\"InstanceType\\": \\"professional\\",\\n \\"PublicEndpoint\\": \\"amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com\\",\\n \\"ClassicEndpoint\\": \\"amqp-cn-st21x7kv****.not-support\\",\\n \\"MaxVhost\\": 50,\\n \\"MaxTps\\": 5000,\\n \\"AutoRenewInstance\\": false,\\n \\"InstanceName\\": \\"amqp-cn-st21x7kv****\\",\\n \\"MaxQueue\\": 50,\\n \\"OrderType\\": \\"PRE_PAID\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"region\\",\\n \\"Value\\": \\"hangzhou\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-aek3axfj2w4czrq\\",\\n \\"EncryptedInstance\\": false,\\n \\"KmsKeyId\\": \\"key-bjj66c2a893vmhawtq5fd\\",\\n \\"ProvisionedCapacity\\": 2000,\\n \\"Edition\\": \\"shared\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CCBB1225-C392-480E-8C7F-D09AB2CD2***\\r\\n \\r\\n \\r\\n SERVING\\r\\n 5000\\r\\n 24832\\r\\n amqp-cn-st21x7kv****.not-support\\r\\n amqp-cn-st21x7kv****\\r\\n 50\\r\\n true\\r\\n 200\\r\\n amqp-cn-st21x7kv****\\r\\n PRE_PAID\\r\\n 1572441939000\\r\\n 50\\r\\n amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com\\r\\n professional\\r\\n 1651507200000\\r\\n false\\r\\n amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com\\r\\n \\r\\n \\r\\n 1\\r\\n \\r\\n","errorExample":""}]', + 'title' => 'ListInstances', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateVirtualHost' => [ + 'summary' => 'Creates a vhost. A vhost is used to logically isolate resources. Each vhost manages its own exchanges, queues, and bindings. Applications can run on independent vhosts in a secure manner. This way, the business of an application is not affected by other applications. Before you connect producers and consumers to an ApsaraMQ for RabbitMQ instance, you must specify vhosts for the producers and consumers.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsSCH7G8', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amqp-cn-v0h1kb9n***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the vhost that you want to create. Valid values:'."\n" + ."\n" + .'* The name can contain letters, digits, hyphens (-), underscores (\\_), periods (.), number signs (#), forward slash (/), and at signs (@).'."\n" + .'* The name must be 1 to 255 characters in length.'."\n" + .'* After the vhost is created, you cannot change its name. If you want to change the name of a vhost, delete the vhost and create another vhost.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '628705FD-03EE-4ABE-BB21-E1672960***', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"628705FD-03EE-4ABE-BB21-E1672960***\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 628705FD-03EE-4ABE-BB21-E1672960***\\n","errorExample":""}]', + 'title' => 'CreateVirtualHost', + ], + 'DeleteVirtualHost' => [ + 'summary' => 'Deletes a virtual host (vhost).', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsSCH7G8', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance to which the vhost you want to delete belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amqp-cn-v0h1kb9nu***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the vhost that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4311050D-BD63-48F9-822B-947A75A1***', + ], + ], + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4311050D-BD63-48F9-822B-947A75A1***\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 4311050D-BD63-48F9-822B-947A75A1***\\r\\n","errorExample":""}]', + 'title' => 'DeleteVirtualHost', + 'description' => 'Before you delete a vhost, make sure that all exchanges and queues in the vhost are deleted.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListVirtualHosts' => [ + 'summary' => 'Queries all virtual hosts (vhosts) on an ApsaraMQ for RabbitMQ instance.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsSCH7G8', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1880770869023***', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that marks the end position of the previous returned page. To obtain the next batch of data, call the operation again by using the value of NextToken returned by the previous request. If you call this operation for the first time or want to query all results, set NextToken to an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Valid values: **1 to 100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EF4DB019-DA4A-4CE3-B220-223BBC93F***', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NextToken' => [ + 'description' => 'The token that marks the end of the current returned page. If this parameter is empty, all data is retrieved.'."\n", + 'type' => 'string', + 'example' => 'caebacccb2be03f84eb48b699f0a****', + ], + 'VirtualHosts' => [ + 'description' => 'The vhosts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The vhost name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + [ + 'errorCode' => 'InstanceIdNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EF4DB019-DA4A-4CE3-B220-223BBC93F***\\",\\n \\"Data\\": {\\n \\"MaxResults\\": 2,\\n \\"NextToken\\": \\"caebacccb2be03f84eb48b699f0a****\\",\\n \\"VirtualHosts\\": [\\n {\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EF4DB019-DA4A-4CE3-B220-223BBC93F***\\n \\n \\n 2\\n \\n test\\n \\n \\n","errorExample":""}]', + 'title' => 'ListVirtualHosts', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateQueue' => [ + 'summary' => 'Creates a queue. In ApsaraMQ for RabbitMQ, a queue is a message queue. All messages in ApsaraMQ for RabbitMQ are sent to a specific exchange and then routed to a bound queue by the exchange.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsUKJAUW', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance on which you want to create a queue.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amqp-cn-v0h1kb9nu***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the vhost to which the queue that you want to create belongs. The name must be 1 to 255 characters in length, and can contain only letters, digits, hyphens (-), underscores (\\_), periods (.), number signs (#), forward slashes (/), and at signs (@).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the queue that you want to create.'."\n" + ."\n" + .'* The name must be 1 to 255 characters in length, and can contain only letters, digits, hyphens (-), underscores (\\_), periods (.), number signs (#), forward slashes (/), and at signs (@).'."\n" + .'* After the queue is created, you cannot change the name of the queue. If you want to change the name of the queue, delete the queue and create another queue.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DemoQueue', + ], + ], + [ + 'name' => 'AutoDeleteState', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to automatically delete the queue. Valid values:'."\n" + ."\n" + .'* true: The queue is automatically deleted. After the last consumer unsubscribes from the queue, the queue is automatically deleted.'."\n" + .'* false: The queue is not automatically deleted.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ExclusiveState', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether the exchange is an exclusive exchange. Valid values:'."\n" + ."\n" + .'* true: The exchange is an exclusive exchange. Only the connection that declares the exclusive exchange can use the exclusive exchange. After the connection is closed, the exclusive exchange is automatically deleted.'."\n" + .'* false: The exchange is not an exclusive exchange.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'MessageTTL', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The message time to live (TTL) of the queue.'."\n" + ."\n" + .'* If the retention period of a message in the queue exceeds the message TTL of the queue, the message expires.'."\n" + .'* The message TTL must be set to a non-negative integer. The maximum message TTL is one day. Unit: milliseconds. For example, if the message TTL is 1,000 milliseconds, the message can be retained for up to 1 second in the queue.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'AutoExpireState', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The validity period after which the queue is automatically deleted. If the queue is not accessed within the specified period of time, the queue is automatically deleted.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'> You can use the feature that corresponds to this parameter only after you enable the feature. To enable the feature, [submit a ticket](https://ticket-intl.console.aliyun.com/#/ticket/createIndex).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'MaxLength', + 'in' => 'formData', + 'schema' => [ + 'description' => 'This parameter is unavailable in the current version of ApsaraMQ for RabbitMQ.'."\n" + ."\n" + .'The maximum number of messages that can be stored in the queue. If this threshold is exceeded, the earliest stored messages in the queue are deleted.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'DeadLetterExchange', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The dead-letter exchange. A dead-letter exchange is used to receive rejected messages.'."\n" + ."\n" + .'If a consumer rejects a message that cannot be redelivered, ApsaraMQ for RabbitMQ routes the message to the specified dead-letter exchange. Then, the dead-letter exchange routes the message to the queue that is bound to the dead-letter exchange for storage.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DLExchange', + ], + ], + [ + 'name' => 'DeadLetterRoutingKey', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The dead-letter routing key. The key must be 1 to 255 characters in length, and can contain only letters, digits, hyphens (-), underscores (\\_), periods (.), number signs (#), forward slashes (/), and at signs (@).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test.dl', + ], + ], + [ + 'name' => 'MaximumPriority', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Queue priorities are not supported. The value does not affect the call or return results.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '59B52E2C-0B8E-44EC-A314-D0314A50***', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"59B52E2C-0B8E-44EC-A314-D0314A50***\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 59B52E2C-0B8E-44EC-A314-D0314A50***\\n","errorExample":""}]', + 'title' => 'CreateQueue', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteQueue' => [ + 'summary' => 'Deletes a queue.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsUKJAUW', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1880770869023***', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The queue name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DemoQueue', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The vhost name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '92385FD2-624A-48C9-8FB5-753F2AFA***', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"92385FD2-624A-48C9-8FB5-753F2AFA***\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 92385FD2-624A-48C9-8FB5-753F2AFA***\\n","errorExample":""}]', + 'title' => 'DeleteQueue', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListQueueConsumers' => [ + 'summary' => 'Queries the online consumers of a queue.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '76240', + 'abilityTreeNodes' => [ + 'FEATUREonsUKJAUW', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '188077086902***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual host (vhost) name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Queue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the queue for which you want to query online consumers.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'queue-rabbit-springboot-advance5', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that marks the end position of the previous returned page. To obtain the next batch of data, call the operation again by using the value of NextToken returned by the previous request. If you call this operation for the first time or want to query all results, set NextToken to an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + 'default' => '', + ], + ], + [ + 'name' => 'QueryCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of data entries to return. If you do not configure this parameter, the default value 1 is used.'."\n" + ."\n" + .'Valid values: 1 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4409B7D5-E4EC-4EB5-804A-385DCDFCD***', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => 'The token that marks the end of the current returned page. If this parameter is empty, all data is retrieved.'."\n", + 'type' => 'string', + 'example' => 'caebacccb2be03f84eb48b699f0a****', + ], + 'Consumers' => [ + 'description' => 'The consumers.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConsumerTag' => [ + 'description' => 'The consumer tag.'."\n", + 'type' => 'string', + 'example' => 'sgen-1', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InstanceIdNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4409B7D5-E4EC-4EB5-804A-385DCDFCD***\\",\\n \\"Data\\": {\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"caebacccb2be03f84eb48b699f0a****\\",\\n \\"Consumers\\": [\\n {\\n \\"ConsumerTag\\": \\"sgen-1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4409B7D5-E4EC-4EB5-804A-385DCDFCD***\\n \\n AAAATzkBMTg4MDc3MDg2OTAyMzQyMAF0ZXN0AXF1ZXVlLXJhYmJpdC1zcHJpbmdib290LWFkdmFuY2U1ATc3NjMxNjIwATE1OTEzNTA5MDkzMDkBrWuX5aAiG4ytL5ffWi0HBUjdleo=\\n 1\\n \\n sgen-1\\n \\n \\n","errorExample":""}]', + 'title' => 'ListQueueConsumers', + 'description' => 'ApsaraMQ for RabbitMQ allows you to query only online consumers.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListQueues' => [ + 'summary' => 'Queries all queues in a vhost of an ApsaraMQ for RabbitMQ instance.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsUKJAUW', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1880770869023***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual host (vhost) name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that marks the end position of the previous returned page. To obtain the next batch of data, call the operation again by using the value of NextToken returned by the previous request. If you call this operation for the first time or want to query all results, set NextToken to an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + 'minLength' => 1, + 'default' => '', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CE811989-9F02-42CE-97A6-2239CB5C2***', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => 'The token that marks the end of the current returned page. If this parameter is empty, all data is retrieved.'."\n", + 'type' => 'string', + 'example' => 'caebacccb2be03f84eb48b699f0a****', + ], + 'Queues' => [ + 'description' => 'The queues.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExclusiveState' => [ + 'description' => 'Indicates whether the queue is an exclusive queue.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'AutoDeleteState' => [ + 'description' => 'Indicates whether the queue was automatically deleted.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'CreateTime' => [ + 'description' => 'The time when the queue was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1580887085240', + ], + 'Attributes' => [ + 'description' => 'The attributes.'."\n", + 'type' => 'object', + 'example' => 'test', + ], + 'VHostName' => [ + 'description' => 'The vhost name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Name' => [ + 'description' => 'The queue name.'."\n", + 'type' => 'string', + 'example' => 'QueueTest', + ], + 'OwnerId' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance to which the queue belongs.'."\n", + 'type' => 'string', + 'example' => '1880770869023***', + ], + 'LastConsumeTime' => [ + 'description' => 'The time when messages in the queue were last consumed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680887085240', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InstanceIdNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CE811989-9F02-42CE-97A6-2239CB5C2***\\",\\n \\"Data\\": {\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"caebacccb2be03f84eb48b699f0a****\\",\\n \\"Queues\\": [\\n {\\n \\"ExclusiveState\\": false,\\n \\"AutoDeleteState\\": false,\\n \\"CreateTime\\": 1580887085240,\\n \\"Attributes\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"VHostName\\": \\"test\\",\\n \\"Name\\": \\"QueueTest\\",\\n \\"OwnerId\\": \\"amqp-cn-5yd3aw******\\",\\n \\"LastConsumeTime\\": 1680887085240\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n CE811989-9F02-42CE-97A6-2239CB5C2***\\n \\n ,\\n 1\\n \\n test\\n 1880770869023***\\n 1580887085240\\n false\\n test\\n 1680887085240\\n false\\n QueueTest\\n \\n \\n","errorExample":""}]', + 'title' => 'ListQueues', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListQueueUpStreamBindings' => [ + 'summary' => 'Queries the exchanges that are bound to a queue.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREons5ZTT5D', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1880770869023***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual host (vhost) name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The queue name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'QueueTest', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that marks the end position of the previous returned page. To obtain the next batch of data, call the operation again by using the value of NextToken returned by the previous request. If you call this operation for the first time or want to query all results, set NextToken to an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8BFB1C9D-08A2-4859-A47C-403C9EFA2***', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => 'The token that marks the end of the current returned page. If this parameter is empty, all data is retrieved.'."\n", + 'type' => 'string', + 'example' => 'caebacccb2be03f84eb48b699f0a****', + ], + 'Bindings' => [ + 'description' => 'The bindings.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceExchange' => [ + 'description' => 'The name of the source exchange.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Argument' => [ + 'description' => 'The x-match attribute. Valid values:'."\n" + ."\n" + .'* **all:** A headers exchange routes a message to a queue only if all binding attributes of the queue except for x-match match the headers attributes of the message. This value is the default value.'."\n" + .'* **any:** A headers exchange routes a message to a queue if one or more binding attributes of the queue except for x-match match the headers attributes of the message.'."\n" + ."\n" + .'This parameter is available for only headers exchanges.'."\n", + 'type' => 'string', + 'example' => 'all', + ], + 'BindingKey' => [ + 'description' => 'The binding key.'."\n" + ."\n" + .'* If the source exchange is not a topic exchange, the binding key must meet the following conventions:'."\n" + ."\n" + .' * The binding key can contain only letters, digits, hyphens (-), underscores (\\_), periods (.), forward slashes (/), and at signs (@).'."\n" + .' * The binding key must be 1 to 255 characters in length.'."\n" + ."\n" + .'* If the source exchange is a topic exchange, the binding key must meet the following conventions:'."\n" + ."\n" + .' * The binding key can contain letters, digits, hyphens (-), underscores (\\_), periods (.), number signs (#), forward slashes (/), and at signs (@).'."\n" + .' * The binding key cannot start or end with a period (.). If a binding key starts with a number sign (#) or an asterisk (\\*), the number sign (#) or asterisk (\\*) must be followed by a period (.). If the binding key ends with a number sign (#) or an asterisk (\\*), the number sign (#) or asterisk (\\*) must be preceded by a period (.). If a number sign (#) or an asterisk (\\*) is used in the middle of a binding key, the number sign (#) or asterisk (\\*) must be preceded and followed by a period (.).'."\n" + .' * The binding key must be 1 to 255 characters in length.'."\n", + 'type' => 'string', + 'example' => 'amq.test', + ], + 'BindingType' => [ + 'description' => 'The type of the object to which the source exchange is bound. Valid values:'."\n" + ."\n" + .'* **QUEUE**'."\n" + .'* **EXCHANGE**'."\n", + 'type' => 'string', + 'example' => 'QUEUE', + ], + 'DestinationName' => [ + 'description' => 'The name of the object to which the source exchange is bound.'."\n", + 'type' => 'string', + 'example' => 'QueueTest', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InstanceIdNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8BFB1C9D-08A2-4859-A47C-403C9EFA2***\\",\\n \\"Data\\": {\\n \\"MaxResults\\": \\"1\\",\\n \\"NextToken\\": \\"caebacccb2be03f84eb48b699f0a****\\",\\n \\"Bindings\\": [\\n {\\n \\"SourceExchange\\": \\"test\\",\\n \\"Argument\\": \\"all\\",\\n \\"BindingKey\\": \\"amq.test\\",\\n \\"BindingType\\": \\"QUEUE\\",\\n \\"DestinationName\\": \\"QueueTest\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 8BFB1C9D-08A2-4859-A47C-403C9EFA2***\\n \\n ,\\n 1\\n \\n test\\n all\\n QUEUE\\n amq.test\\n QueueTest\\n \\n \\n","errorExample":""}]', + 'title' => 'ListQueueUpStreamBindings', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateExchange' => [ + 'summary' => 'Creates an exchange. In ApsaraMQ for RabbitMQ, an exchange is used to route a message that is received from a producer to one or more queues or to discard the message. An exchange routes a message to queues by using the routing key and binding keys.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ for which you want to create an exchange.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amqp-cn-v0h1kb9nu***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the vhost to which the exchange that you want to create belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'ExchangeName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the exchange that you want to create. The exchange name must meet the following conventions:'."\n" + ."\n" + .'* The name must be 1 to 255 characters in length, and can contain only letters, digits, hyphens (-), underscores (\\_), periods (.), number signs (#), forward slashes (/), and at signs (@).'."\n" + .'* After the exchange is created, you cannot change its name. If you want to change its name, delete the exchange and create another exchange.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DemoExchange', + ], + ], + [ + 'name' => 'ExchangeType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The exchange type. Valid values:'."\n" + ."\n" + .'* **DIRECT**: An exchange of this type routes a message to the queue whose binding key is exactly the same as the routing key of the message.'."\n" + .'* **TOPIC**: This type of exchange is similar to direct exchanges. An exchange of this type routes a message to one or more queues based on the results of the fuzzy match or multi-condition match between the routing key of the message and the binding keys of the current exchange.'."\n" + .'* **FANOUT**: An exchange of this type routes all received messages to all queues bound to this exchange. You can use a fanout exchange to broadcast messages.'."\n" + .'* **HEADERS**: This type of exchange is similar to direct exchanges. The only difference is that a headers exchange routes messages based on the headers attributes instead of routing keys. When you bind a headers exchange to a queue, you must configure binding attributes in the key-value format for the binding. When you send a message to a headers exchange, you must configure the headers attributes in the key-value format for the message. After a headers exchange receives a message, the exchange routes the message based on the matching results between the headers attributes of the message and the binding attributes of the bound queues.'."\n" + .'* **X-CONSISTENT-HASH**: An exchange of this type allows you to perform hash calculations on routing keys or header values and use consistent hashing to route a message to different queues.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DIRECT', + 'enum' => [ + 'DIRECT', + 'TOPIC', + 'FANOUT', + 'HEADERS', + ], + ], + ], + [ + 'name' => 'XDelayedType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'enum' => [ + 'DIRECT', + 'TOPIC', + 'FANOUT', + 'HEADERS', + 'X_JMS_TOPIC', + ], + ], + ], + [ + 'name' => 'AutoDeleteState', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to automatically delete the exchange. Valid values:'."\n" + ."\n" + .'* **true**: If the last queue that is bound to the exchange is unbound, the exchange is automatically deleted.'."\n" + .'* **false**: If the last queue that is bound to the exchange is unbound, the exchange is not automatically deleted.'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'Internal', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether the exchange is an internal exchange. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'AlternateExchange', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The alternate exchange. An alternate exchange is used to receive messages that fail to be routed to queues from the current exchange.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DemoAE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '021788F6-E50C-4BD6-9F80-66B0A19A6***', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"021788F6-E50C-4BD6-9F80-66B0A19A****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 021788F6-E50C-4BD6-9F80-66B0A19A6***\\r\\n","errorExample":""}]', + 'title' => 'CreateExchange', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteExchange' => [ + 'summary' => 'Deletes an exchange.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance whose exchange you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amqp-cn-v0h1kb9nu***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The vhost to which the exchange that you want to delete belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'ExchangeName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the exchange that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DemoExchange', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6961FFB8-6358-4EDC-9E3C-4A0C56CE6***', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6961FFB8-6358-4EDC-9E3C-4A0C56CE6***\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 6961FFB8-6358-4EDC-9E3C-4A0C56CE6***\\r\\n","errorExample":""}]', + 'title' => 'DeleteExchange', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'* You cannot delete exchanges of the **headers** and **x-jms-topic** types.'."\n" + .'* You cannot delete built-in exchanges in a vhost. These exchanges are amq.direct, amq.topic, and amq.fanout.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListDownStreamBindings' => [ + 'summary' => 'Queries all exchanges or queues to which an exchange is bound.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsHNP38C', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance to which the exchange belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1880770869023***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the vhost to which the exchange belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'ExchangeName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The exchange name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that marks the end position of the previous returned page. To obtain the next batch of data, call the operation again by using the value of NextToken returned by the previous request. If you call this operation for the first time or want to query all results, set NextToken to an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code. The status code 200 indicates that the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'operation success', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9C1E0502-0790-4FDB-8C96-6D5C8D9B7***', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => 'The token that marks the end of the current returned page. If this parameter is empty, all data is retrieved.'."\n", + 'type' => 'string', + 'example' => 'caebacccb2be03f84eb48b699f0a****', + ], + 'Bindings' => [ + 'description' => 'The bindings.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceExchange' => [ + 'description' => 'The name of the source exchange.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Argument' => [ + 'description' => 'The x-match attribute. Valid values:'."\n" + ."\n" + .'* **all:** A headers exchange routes a message to a queue only if all binding attributes of the queue except for x-match match the headers attributes of the message. This value is the default value.'."\n" + .'* **any:** A headers exchange routes a message to a queue if one or more binding attributes of the queue except for x-match match the headers attributes of the message.'."\n" + ."\n" + .'This parameter is available only for headers exchanges.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'BindingKey' => [ + 'description' => 'The binding key.'."\n" + ."\n" + .'* If the source exchange is not a topic exchange, the binding key must meet the following conventions:'."\n" + ."\n" + .' * The binding key can contain only letters, digits, hyphens (-), underscores (\\_), periods (.), forward slashes (/), and at signs (@).'."\n" + .' * The binding key must be 1 to 255 characters in length.'."\n" + ."\n" + .'* If the source exchange is a topic exchange, the binding key must meet the following conventions:'."\n" + ."\n" + .' * The binding key can contain letters, digits, hyphens (-), underscores (\\_), periods (.), number signs (#), forward slashes (/), and at signs (@).'."\n" + .' * The binding key cannot start or end with a period (.). If a binding key starts with a number sign (#) or an asterisk (\\*), the number sign (#) or asterisk (\\*) must be followed by a period (.). If the binding key ends with a number sign (#) or an asterisk (\\*), the number sign (#) or asterisk (\\*) must be preceded by a period (.). If a number sign (#) or an asterisk (\\*) is used in the middle of a binding key, the number sign (#) or asterisk (\\*) must be preceded and followed by a period (.).'."\n" + .' * The binding key must be 1 to 255 characters in length.'."\n", + 'type' => 'string', + 'example' => 'amq.test', + ], + 'BindingType' => [ + 'description' => 'The type of the object to which the source exchange is bound. Valid values:'."\n" + ."\n" + .'* **QUEUE**'."\n" + .'* **EXCHANGE**'."\n", + 'type' => 'string', + 'example' => 'QUEUE', + ], + 'DestinationName' => [ + 'description' => 'The name of the object to which the source exchange is bound.'."\n", + 'type' => 'string', + 'example' => 'QueueTest', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InstanceIdNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success\\",\\n \\"RequestId\\": \\"9C1E0502-0790-4FDB-8C96-6D5C8D9B7***\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"caebacccb2be03f84eb48b699f0a****\\",\\n \\"Bindings\\": [\\n {\\n \\"SourceExchange\\": \\"test\\",\\n \\"Argument\\": \\"test\\",\\n \\"BindingKey\\": \\"amq.test\\",\\n \\"BindingType\\": \\"QUEUE\\",\\n \\"DestinationName\\": \\"QueueTest\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"operation success\\n9C1E0502-0790-4FDB-8C96-6D5C8D9B7***\\n\\n ,\\n 1\\n \\n test\\n test\\n amq.test\\n QUEUE\\n QueueTest\\n \\n\\n200\\ntrue","errorExample":""}]', + 'title' => 'ListDownStreamBindings', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListExchanges' => [ + 'summary' => 'Queries all exchanges that are created in a virtual host (vhost).', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '58733', + 'abilityTreeNodes' => [ + 'FEATUREonsHNP38C', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amqp-cn-7pp2mwbc****', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vhost name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If you call this operation for the first time or a next query is not required, leave this parameter empty.'."\n" + .'* If a next query is to be sent, set the value to the value of `NextToken` that is returned from the previous request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AAAANDQBYW1xcC1jbi03cHAybXdiY3AwMGEBdmhvc3QBAXNkZndhYWJhATE2NDkzMTM4OTU5NDIB4o3z1pPwWzk4aYuiRffi8R6-****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Valid values: **1 to 100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FEBA5E0C-50D0-4FA6-A794-4901E5465***', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => 'The token that marks the end of the current returned page.``'."\n" + ."\n" + .'* If the value of this parameter is empty, the next query is not required and the token used to start the next query is unavailable.``'."\n" + .'* If the value of this parameter is not empty, the next query is required, and the value is the token used to start the next query.``'."\n", + 'type' => 'string', + 'example' => 'AAAANDQBYW1xcC1jbi03cHAybXdiY3AwMGEBdmhvc3QBAXNkZndhYWJhATE2NDkzMTM4OTU5NDIB4o3z1pPwWzk4aYuiRffi8R6-****', + ], + 'Exchanges' => [ + 'description' => 'The exchanges.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AutoDeleteState' => [ + 'description' => 'Indicates whether the exchange was automatically deleted.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'CreateTime' => [ + 'description' => 'The timestamp that indicates when the exchange was created. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1580886216000', + ], + 'Attributes' => [ + 'description' => 'The attributes. This parameter is unavailable in the current version.'."\n", + 'type' => 'object', + 'example' => 'test', + ], + 'VHostName' => [ + 'description' => 'The vhost name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Name' => [ + 'description' => 'The exchange name.'."\n", + 'type' => 'string', + 'example' => 'amq.direct', + ], + 'ExchangeType' => [ + 'description' => 'The exchange type.'."\n", + 'type' => 'string', + 'example' => 'DIRECT', + ], + 'Internal' => [ + 'title' => '是否为内部Exchange', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InstanceIdNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEBA5E0C-50D0-4FA6-A794-4901E5465***\\",\\n \\"Data\\": {\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"AAAANDQBYW1xcC1jbi03cHAybXdiY3AwMGEBdmhvc3QBAXNkZndhYWJhATE2NDkzMTM4OTU5NDIB4o3z1pPwWzk4aYuiRffi8R6-****\\",\\n \\"Exchanges\\": [\\n {\\n \\"AutoDeleteState\\": false,\\n \\"CreateTime\\": 1580886216000,\\n \\"Attributes\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"VHostName\\": \\"test\\",\\n \\"Name\\": \\"amq.direct\\",\\n \\"ExchangeType\\": \\"DIRECT\\",\\n \\"Internal\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FEBA5E0C-50D0-4FA6-A794-4901E5465***\\n \\n \\n 1\\n \\n test\\n 1580886216000\\n false\\n DIRECT\\n amq.direct\\n \\n \\n","errorExample":""}]', + 'title' => 'ListExchanges', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListExchangeUpStreamBindings' => [ + 'summary' => 'Queries all queues or exchanges that are bound to an exchange.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREonsHNP38C', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1880770869023***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual host (vhost) name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'ExchangeName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The exchange name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that marks the end position of the previous returned page. To obtain the next batch of data, call the operation again by using the value of NextToken returned by the previous request. If you call this operation for the first time or want to query all results, set NextToken to an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code. The status code 200 indicates that the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'operation success', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2DCCCE88-BC82-4A4F-AF5E-9A759672B***', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => 'The token that marks the end of the current returned page. If this parameter is empty, all data is retrieved.'."\n", + 'type' => 'string', + 'example' => 'caebacccb2be03f84eb48b699f0a****', + ], + 'Bindings' => [ + 'description' => 'The bindings.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceExchange' => [ + 'description' => 'The name of the source exchange.'."\n", + 'type' => 'string', + 'example' => 'dle', + ], + 'Argument' => [ + 'description' => 'The x-match attribute. Valid values:'."\n" + ."\n" + .'* **all:** A headers exchange routes a message to a queue only if all binding attributes of the queue except for x-match match the headers attributes of the message. This value is the default value.'."\n" + .'* **any:** A headers exchange routes a message to a queue if one or more binding attributes of the queue except for x-match match the headers attributes of the message.'."\n" + ."\n" + .'This parameter is available only for headers exchanges.'."\n", + 'type' => 'string', + 'example' => 'all', + ], + 'BindingKey' => [ + 'description' => 'The binding key.'."\n" + ."\n" + .'* If the source exchange is not a topic exchange, the binding key must meet the following conventions:'."\n" + ."\n" + .' * The binding key can contain only letters, digits, hyphens (-), underscores (\\_), periods (.), forward slashes (/), and at signs (@).'."\n" + .' * The binding key must be 1 to 255 characters in length.'."\n" + ."\n" + .'* If the source exchange is a topic exchange, the binding key must meet the following conventions:'."\n" + ."\n" + .' * The binding key can contain letters, digits, hyphens (-), underscores (\\_), periods (.), number signs (#), forward slashes (/), and at signs (@).'."\n" + .' * The binding key cannot start or end with a period (.). If a binding key starts with a number sign (#) or an asterisk (\\*), the number sign (#) or asterisk (\\*) must be followed by a period (.). If the binding key ends with a number sign (#) or an asterisk (\\*), the number sign (#) or asterisk (\\*) must be preceded by a period (.). If a number sign (#) or an asterisk (\\*) is used in the middle of a binding key, the number sign (#) or asterisk (\\*) must be preceded and followed by a period (.).'."\n" + .' * The binding key must be 1 to 255 characters in length.'."\n", + 'type' => 'string', + 'example' => 'amq.dle.test', + ], + 'BindingType' => [ + 'description' => 'The type of the object to which the source exchange is bound. Valid values:'."\n" + ."\n" + .'* **QUEUE**'."\n" + .'* **EXCHANGE**'."\n", + 'type' => 'string', + 'example' => 'EXCHANGE', + ], + 'DestinationName' => [ + 'description' => 'The name of the object to which the source exchange is bound.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InstanceIdNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success\\",\\n \\"RequestId\\": \\"2DCCCE88-BC82-4A4F-AF5E-9A759672B***\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"caebacccb2be03f84eb48b699f0a****\\",\\n \\"Bindings\\": [\\n {\\n \\"SourceExchange\\": \\"dle\\",\\n \\"Argument\\": \\"all\\",\\n \\"BindingKey\\": \\"amq.dle.test\\",\\n \\"BindingType\\": \\"EXCHANGE\\",\\n \\"DestinationName\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 2DCCCE88-BC82-4A4F-AF5E-9A759672B***\\n operation success\\n \\n ,\\n 1\\n \\n dle\\n all\\n EXCHANGE\\n amq.dle.test\\n test\\n \\n \\n 200\\n true\\n","errorExample":""}]', + 'title' => 'ListExchangeUpStreamBindings', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateBinding' => [ + 'summary' => 'Creates a binding. In ApsaraMQ for RabbitMQ, after a producer sends a message to an exchange, the exchange routes the message to a queue or another exchange based on the binding relationship and the routing rule.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '58722', + 'abilityTreeNodes' => [ + 'FEATUREons5ZTT5D', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amqp-cn-v0h1kb9nu***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The virtual host (vhost) name. You must create the vhost in the ApsaraMQ for RabbitMQ console in advance. The object specified by **DestinationName** and the source exchange specified by **SourceExchange** must belong to the vhost.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'SourceExchange', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the source exchange. You must create the source exchange in the ApsaraMQ for RabbitMQ console in advance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NormalEX', + ], + ], + [ + 'name' => 'DestinationName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the object that you want to bind to the source exchange. You must create the object in the ApsaraMQ for RabbitMQ console in advance. The vhost of the object is the same as the vhost to which the source exchange specified by **SourceExchange** belongs. The vhost of the source exchange is the one specified by **VirtualHost**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DemoQueue', + ], + ], + [ + 'name' => 'BindingKey', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The binding key.'."\n" + ."\n" + .'* If the source exchange is not a topic exchange, the binding key must meet the following conventions:'."\n" + ."\n" + .' * The binding key can contain only letters, digits, hyphens (-), underscores (\\_), periods (.), forward slashes (/), and at signs (@).'."\n" + .' * The binding key must be 1 to 255 characters in length.'."\n" + ."\n" + .'* If the source exchange is a topic exchange, the binding key must meet the following conventions:'."\n" + ."\n" + .' * The binding key can contain letters, digits, hyphens (-), underscores (\\_), asterisks (\\*), periods (.), number signs (#), forward slashes (/), and at signs (@).'."\n" + .' * The binding key cannot start or end with a period (.). If a binding key starts with a number sign (#) or an asterisk (\\*), the number sign (#) or asterisk (\\*) must be followed by a period (.). If the binding key ends with a number sign (#) or an asterisk (\\*), the number sign (#) or asterisk (\\*) must be preceded by a period (.). If a number sign (#) or an asterisk (\\*) is used in the middle of a binding key, the number sign (#) or asterisk (\\*) must be preceded and followed by a period (.).'."\n" + .' * The binding key must be 1 to 255 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '.test', + ], + ], + [ + 'name' => 'BindingType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the object that you want to bind to the source exchange. Valid values:'."\n" + ."\n" + .'* \\*\\*0: \\*\\*Queue'."\n" + .'* \\*\\*1: \\*\\*Exchange'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Argument', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The key-value pairs that are configured for the headers attributes of a message. One or more key-value pairs can be concatenated to configure the headers attributes of a message. You must specify the x-match attribute as one of the valid values. You can specify custom values for other attributes. Valid values of the x-match attribute:'."\n" + ."\n" + .'* \\*\\*all: \\*\\*A headers exchange routes a message to a queue only if all binding attributes of the queue except for x-match match the headers attributes of the message. This value is the default value.'."\n" + .'* \\*\\*any: \\*\\*A headers exchange routes a message to a queue if one or more binding attributes of the queue except for x-match match the headers attributes of the message.'."\n" + ."\n" + .'Separate the attributes with semicolons (;). Separate the key and value of an attribute with a colon (:). Example: x-match:all;type:report;format:pdf. This parameter is available for only headers exchanges. You can set this parameter to an arbitrary value for other types of exchanges.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'x-match:all;type:report;format:pdf ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '09768C14-E51C-4F4A-8077-30810032C***', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"09768C14-E51C-4F4A-8077-30810032C***\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 09768C14-E51C-4F4A-8077-30810032C***\\n","errorExample":""}]', + 'title' => 'CreateBinding', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteBinding' => [ + 'summary' => 'Deletes a binding to unbind a queue or an exchange from a source exchange.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '58726', + 'abilityTreeNodes' => [ + 'FEATUREons5ZTT5D', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amqp-cn-v0h1kb9nu***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The vhost name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'SourceExchange', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the source exchange.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NormalEX', + ], + ], + [ + 'name' => 'DestinationName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the object that you want to unbind from the source exchange.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DemoQueue', + ], + ], + [ + 'name' => 'BindingType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the object that you want to unbind from the source exchange. Valid values:'."\n" + ."\n" + .'* **QUEUE**'."\n" + .'* **EXCHANGE**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'QUEUE', + ], + ], + [ + 'name' => 'BindingKey', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The binding key.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '.test.', + 'default' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '021788F6-E50C-4BD6-9F80-66B0A19A6***', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"021788F6-E50C-4BD6-9F80-66B0A19A6***\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 021788F6-E50C-4BD6-9F80-66B0A19A6***\\n","errorExample":""}]', + 'title' => 'DeleteBinding', + ], + 'ListBindings' => [ + 'summary' => 'Queries all bindings of a virtual host (vhost) on an ApsaraMQ for RabbitMQ instance.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREons5ZTT5D', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1880770869023***', + ], + ], + [ + 'name' => 'VirtualHost', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vhost name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that marks the end position of the previous returned page. To obtain the next batch of data, call the operation again by using the value of NextToken returned by the previous request. If you call this operation for the first time or want to query all results, set NextToken to an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + 'minLength' => 1, + 'default' => '', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Valid values:'."\n" + ."\n" + .'**1 to 100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E0A71208-3E87-4732-81CC-B18E0B4B1***', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => 'The token that marks the end of the current returned page. If this parameter is empty, all data is retrieved.'."\n", + 'type' => 'string', + 'example' => 'caebacccb2be03f84eb48b699f0a****', + ], + 'Bindings' => [ + 'description' => 'The bindings.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceExchange' => [ + 'description' => 'The name of the source exchange.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Argument' => [ + 'description' => 'The x-match attribute. Valid values:'."\n" + ."\n" + .'* **all:** A headers exchange routes a message to a queue only if all binding attributes of the queue except for x-match match the headers attributes of the message. This value is the default value.'."\n" + .'* **any:** A headers exchange routes a message to a queue if one or more binding attributes of the queue except for x-match match the headers attributes of the message.'."\n" + ."\n" + .'This parameter is available only for headers exchanges.'."\n", + 'type' => 'string', + 'example' => 'all', + ], + 'BindingKey' => [ + 'description' => 'The binding key.'."\n" + ."\n" + .'* If the source exchange is not a topic exchange, the binding key must meet the following conventions:'."\n" + ."\n" + .' * The binding key can contain only letters, digits, hyphens (-), underscores (\\_), periods (.), forward slashes (/), and at signs (@).'."\n" + .' * The binding key must be 1 to 255 characters in length.'."\n" + ."\n" + .'* If the source exchange is a topic exchange, the binding key must meet the following conventions:'."\n" + ."\n" + .' * The binding key can contain letters, digits, hyphens (-), underscores (\\_), asterisks (\\*), periods (.), number signs (#), forward slashes (/), and at signs (@).'."\n" + .' * The binding key cannot start or end with a period (.). If a binding key starts with a number sign (#) or an asterisk (\\*), the number sign (#) or asterisk (\\*) must be followed by a period (.). If the binding key ends with a number sign (#) or an asterisk (\\*), the number sign (#) or asterisk (\\*) must be preceded by a period (.). If a number sign (#) or an asterisk (\\*) is used in the middle of a binding key, the number sign (#) or asterisk (\\*) must be preceded and followed by a period (.).'."\n" + .' * The binding key must be 1 to 255 characters in length.'."\n", + 'type' => 'string', + 'example' => 'amq.test', + ], + 'BindingType' => [ + 'description' => 'The type of the object to which the source exchange is bound. Valid values:'."\n" + ."\n" + .'* **QUEUE**'."\n" + .'* **EXCHANGE**'."\n", + 'type' => 'string', + 'example' => 'QUEUE', + ], + 'DestinationName' => [ + 'description' => 'The name of the object to which the source exchange is bound.'."\n", + 'type' => 'string', + 'example' => 'QueueTest', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InstanceIdNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E0A71208-3E87-4732-81CC-B18E0B4B1***\\",\\n \\"Data\\": {\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"caebacccb2be03f84eb48b699f0a****\\",\\n \\"Bindings\\": [\\n {\\n \\"SourceExchange\\": \\"test\\",\\n \\"Argument\\": \\"all\\",\\n \\"BindingKey\\": \\"amq.test\\",\\n \\"BindingType\\": \\"QUEUE\\",\\n \\"DestinationName\\": \\"QueueTest\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n E0A71208-3E87-4732-81CC-B18E0B4B1***\\n \\n ,\\n 1\\n \\n test\\n all\\n QUEUE\\n amq.test\\n QueueTest\\n \\n \\n","errorExample":""}]', + 'title' => 'ListBindings', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAccount' => [ + 'summary' => 'Creates a pair of static username and password. If you access an ApsaraMQ for RabbitMQ broker from an open source RabbitMQ client, you must use a pair of username and password for authentication. You can access the ApsaraMQ for RabbitMQ broker only after the authentication is passed. ApsaraMQ for RabbitMQ allows you to generate usernames and passwords by using AccessKey pairs provided by Alibaba Cloud Resource Access Management (RAM).', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '164698', + 'abilityTreeNodes' => [ + 'FEATUREonsSLSXRS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance for which you want to create a pair of static username and password.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'amqp-cn-*********', + ], + ], + [ + 'name' => 'accountAccessKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The AccessKey ID of your Alibaba Cloud account or RAM user. For information about how to obtain an AccessKey pair, see [Create an AccessKey pair](~~116401~~).'."\n" + ."\n" + .'> If you use the pair of static username and password that is created by using the Accesskey pair of a RAM user to access ApsaraMQ for RabbitMQ to send and receive messages, make sure that the RAM user is granted the required permissions. For more information, see [RAM policies](~~146559~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'yourAccessKeyID', + ], + ], + [ + 'name' => 'userName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The static username that you want to create.'."\n" + ."\n" + .'The value of this parameter is a Base64-encoded string that is generated based on the instance ID and AccessKey ID. For more information, see the "**Sample code on how to generate a username**" section of this topic.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Mjo****************', + ], + ], + [ + 'name' => 'signature', + 'in' => 'query', + 'schema' => [ + 'description' => 'The signature. The system generates a static password based on the signature in the request, the AccessKey secret signature, and the username.'."\n" + ."\n" + .'The system uses the HMAC-SHA1 algorithm to generate the signature based on the timestamp that indicates when the username is created and the AccessKey ID. For more information, see the **"Sample code on how to generate a signature"** section of this topic.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '22c2d7d1769cb53c5a6d9213248e2de524******', + ], + ], + [ + 'name' => 'createTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp that indicates when the password is created. Unit: milliseconds.'."\n" + ."\n" + .'> This timestamp is specified by you and is used to generate a static password. The timestamp is not the timestamp that indicates when the system generates the password.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1671175303522', + ], + ], + [ + 'name' => 'secretSign', + 'in' => 'query', + 'schema' => [ + 'description' => 'The AccessKey secret signature. The system generates a static password based on the signature in the request, the AccessKey secret signature, and the username.'."\n" + ."\n" + .'The system uses the HMAC-SHA1 algorithm to generate the AccessKey secret signature based on the timestamp that indicates when the username is created and the AccessKey ID. For more information, see the **"Sample code on how to generate a signature"** section of this topic.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '4c1a6367ce4c4255e9617326f9133ac635******', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '静态用户备注', + 'type' => 'string', + 'example' => '***环境', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned results.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '92385FD2-624A-48C9-8FB5-753F2AFA***', + ], + 'Code' => [ + 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'operation success', + ], + 'Success' => [ + 'description' => 'Indicates whether the call is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessKey' => [ + 'description' => 'The AccessKey ID that is used to create the password.'."\n", + 'type' => 'string', + 'example' => 'LTAI****************', + ], + 'Password' => [ + 'description' => 'The created static password.'."\n", + 'type' => 'string', + 'example' => 'NEMxQTYzNjdDRTVDNDI1NUU5NjE3**************1MzNGODoxNjcxMTc1MzEzNTIy', + ], + 'CreateTimeStamp' => [ + 'description' => 'The timestamp that indicates when the password was created. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671175303522', + ], + 'InstanceId' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'type' => 'string', + 'example' => 'amqp-cn-*********', + ], + 'MasterUId' => [ + 'description' => 'The Alibaba Cloud account ID or RAM user to which the AccessKey pair that is used to create the static username and password belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15657*********01', + ], + 'UserName' => [ + 'description' => 'The created static username.'."\n", + 'type' => 'string', + 'example' => 'MjphbXFwLWNuLXVxbTJ6cjc2djAwMzpMVEFJNX*******ZNMWVSWnRFSjZ2Zm8=', + ], + 'Remark' => [ + 'title' => '备注', + 'type' => 'string', + 'example' => '***环境', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEBA5E0C-50D0-4FA6-A794-4901E5465***\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AccessKey\\": \\"LTAI****************\\",\\n \\"Password\\": \\"OUYwQzM2QjZBRkUxNDRFM***************MzZCNzdDQzoxNjcxNDMwMzkyODI1\\",\\n \\"CreateTimeStamp\\": 1671175303522,\\n \\"InstanceId\\": \\"amqp-cn-*********\\",\\n \\"MasterUId\\": 0,\\n \\"UserName\\": \\"MjphbXFwLWNuLXVxbTJ6cjc2djAwMzpMVEFJNX*******ZNMWVSWnRFSjZ2Zm8=\\",\\n \\"Remark\\": \\"***环境\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FEBA5E0C-50D0-4FA6-A794-4901E5465***\\n 200\\n operation success\\n true\\n \\n LTAI5***********eRZtEJ6vfo\\n OUYwQzM2QjZBRkUxNDRFM***************MzZCNzdDQzoxNjcxNDMwMzkyODI1\\n 1671175303522\\n amqp-cn-*********\\n MjphbXFwLWNuLXVxbTJ6cjc2djAwMzpMVEFJNX*******ZNMWVSWnRFSjZ2Zm8=\\n \\n","errorExample":""}]', + 'title' => 'CreateAccount', + 'description' => '### [](#)Background information'."\n" + ."\n" + .'If you access an ApsaraMQ for RabbitMQ broker from an open source RabbitMQ client, you must use a pair of username and password for authentication. You can access the ApsaraMQ for RabbitMQ broker only after the authentication is passed. ApsaraMQ for RabbitMQ allows you to generate usernames and passwords by using AccessKey pairs provided by Alibaba Cloud RAM.'."\n" + ."\n" + .'### [](#)Precautions'."\n" + ."\n" + .'* The ApsaraMQ for RabbitMQ instance for which you want to create a pair of static username and password must be in the Running state.'."\n" + .'* You can use an AccessKey pair to create only one pair of static username and password for an ApsaraMQ for RabbitMQ instance.'."\n" + .'* If you want to update an existing pair of static username and password, you must delete the existing pair and create another pair.'."\n" + ."\n" + .'### [](#)Sample code on how to generate a username'."\n" + ."\n" + .'The value of the userName parameter in the request is a Base64-encoded string that is generated by using the instance ID and AccessKey ID. The following sample code provides an example on how to generate a username:'."\n" + ."\n" + .'~~~'."\n" + .'import java.nio.charset.Charset;'."\n" + .'import java.nio.charset.StandardCharsets;'."\n" + .'import java.util.Base64;'."\n" + ."\n" + .'public class Base64Utils {'."\n" + .' public static final Charset UTF8 = StandardCharsets.UTF_8;'."\n" + ."\n" + .' /**'."\n" + .' * Decode the Base64 string.'."\n" + .' *'."\n" + .' * @param str'."\n" + .' * @return'."\n" + .' */'."\n" + .' public static String decode(String str) {'."\n" + .' return new String(Base64.getDecoder().decode(str.getBytes(UTF8)), UTF8);'."\n" + .' }'."\n" + ."\n" + .' public static String encode(String bytes) {'."\n" + .' return new String(Base64.getEncoder().encode(bytes.getBytes(UTF8)), UTF8);'."\n" + .' }'."\n" + ."\n" + .' public static void main(String[] args) {'."\n" + .' String str = "2:${instanceId}:${ak}";'."\n" + ."\n" + .' String userName = encode(str);'."\n" + .' System.out.println("userName=" + userName);'."\n" + ."\n" + .' String decodeStr = decode(userName);'."\n" + .' System.out.println("originStr=" + decodeStr);'."\n" + .' }'."\n" + .'}'."\n" + .'~~~'."\n" + ."\n" + .'### [](#)Sample code on how to generate a signature'."\n" + ."\n" + .'The system uses the encryption algorithm to generate the values of the signature and secretSign parameters in the request based on the timestamp that indicates when the specified static username is created and the AccessKey ID. The following sample code provides an example on how to generate the values of the signature and secretSign parameters:'."\n" + ."\n" + .'~~~'."\n" + .'import javax.crypto.Mac;'."\n" + .'import javax.crypto.spec.SecretKeySpec;'."\n" + .'import java.security.InvalidKeyException;'."\n" + .'import java.security.NoSuchAlgorithmException;'."\n" + ."\n" + .'public class SignatureUtils {'."\n" + ."\n" + .' public static String hamcsha1(byte[] data, byte[] key) throws NoSuchAlgorithmException, InvalidKeyException {'."\n" + .' SecretKeySpec signingKey = new SecretKeySpec(key, "HmacSHA1");'."\n" + .' Mac mac = Mac.getInstance("HmacSHA1");'."\n" + .' mac.init(signingKey);'."\n" + .' return byte2hex(mac.doFinal(data));'."\n" + .' }'."\n" + ."\n" + .' public static String byte2hex(byte[] b) {'."\n" + .' StringBuilder hs = new StringBuilder();'."\n" + .' String stmp;'."\n" + .' for (int n = 0; b != null && n < b.length; n++) {'."\n" + .' stmp = Integer.toHexString(b[n] & 0XFF);'."\n" + .' if (stmp.length() == 1) {'."\n" + .' hs.append(\'0\');'."\n" + .' }'."\n" + .' hs.append(stmp);'."\n" + .' }'."\n" + .' return hs.toString().toUpperCase();'."\n" + .' }'."\n" + ."\n" + .' public static void main(String[] args) throws InvalidKeyException, NoSuchAlgorithmException {'."\n" + .' String createTimestamp = String.valueOf(System.currentTimeMillis());'."\n" + .' System.out.println("timestamp:" + createTimestamp);'."\n" + ."\n" + .' String sk = "${sk}";'."\n" + ."\n" + .' String SecretSign = hamcsha1(sk.getBytes(), createTimestamp.getBytes());'."\n" + .' System.out.println("SecretSign:" + SecretSign);'."\n" + ."\n" + .' String signature = hamcsha1(createTimestamp.getBytes(), sk.getBytes());'."\n" + .' System.out.println("signature:" + signature);'."\n" + .' }'."\n" + .'}'."\n" + .'~~~', + ], + 'DeleteAccount' => [ + 'summary' => 'Deletes a pair of username and password.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '160959', + 'abilityTreeNodes' => [ + 'FEATUREonsSLSXRS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pair of username and password that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MjphbXFwLWNuLXVxbTJ5cjc3djAwMzpMVEFJNXQ4YmVNbVZNMWVSWnRFSjZ2Zm1=', + ], + ], + [ + 'name' => 'CreateTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp that indicates when the pair of static username and password that you want to delete was created. Unit: milliseconds.'."\n" + ."\n" + .'You can call the [ListAccounts](~~472730~~) operation to view the timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '1671175303522'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '021788F6-E50C-4BD6-9F80-66B0A19A6***', + ], + 'Code' => [ + 'description' => 'The HTTP status code. The status code 200 indicates that the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'operation success', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"021788F6-E50C-4BD6-9F80-66B0A1******\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 021788F6-E50C-4BD6-9F80-66B0A1******\\n 200\\n operation success\\n true\\n true\\n","errorExample":""}]', + 'title' => 'DeleteAccount', + ], + 'ListAccounts' => [ + 'summary' => 'Queries the static username and password of an ApsaraMQ for RabbitMQ.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '160958', + 'abilityTreeNodes' => [ + 'FEATUREonsSLSXRS', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance for which you want to query the static username and password.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'amqp-cn-20p****04', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned information.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '549A5A97-FE61-5A23-8126-3A11929C1EC4', + ], + 'Success' => [ + 'description' => 'Indicates whether the call is successful.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'masterUid' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => 'The Alibaba Cloud account ID or Resource Access Management (RAM) user to which the AccessKey pair that is used to create the static username and password belongs.'."\n", + 'example' => '1565************1', + ], + 'cInstanceId' => [ + 'type' => 'string', + 'description' => 'The ID of the ApsaraMQ for RabbitMQ instance.'."\n", + 'example' => 'amqp-cn-uqm******03', + ], + 'accessKey' => [ + 'type' => 'string', + 'description' => 'The AccessKey ID that is used to create the static username and password.'."\n", + 'example' => 'LTAI****************', + ], + 'userName' => [ + 'type' => 'string', + 'example' => 'MjphbXFwLWNuLXVxbTJ6cjc2djAwMzpMVEFJNX*******ZNMWVSWnRFSjZ2Zm8=', + 'description' => 'The static username.'."\n", + ], + 'password' => [ + 'type' => 'string', + 'example' => 'OUYwQzM2QjZBRkUxNDRFM***************MzZCNzdDQzoxNjcxNDMwMzkyODI1', + 'description' => 'The static password.'."\n", + ], + 'deleted' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => 'The timestamp that indicates when the static username and password were deleted. Unit: milliseconds.'."\n", + 'example' => '1671175303522', + ], + 'createTimestamp' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => 'The timestamp that indicates when the static username and password were created. Unit: milliseconds.'."\n", + 'example' => '1671175303522', + ], + 'Remark' => [ + 'title' => '备注', + 'type' => 'string', + 'example' => '***环境', + ], + ], + 'description' => 'object', + ], + 'description' => 'The returned information about the username and password.'."\n", + ], + ], + 'Code' => [ + 'description' => 'The HTTP status code. The status code 200 indicates that the call is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'operation success', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InstanceIdNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance resource does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"549A5A97-FE61-5A23-8126-3A1192*****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"key\\": [\\n {\\n \\"masterUid\\": 0,\\n \\"cInstanceId\\": \\"amqp-cn-uqm******03\\",\\n \\"accessKey\\": \\"LTAI****************\\",\\n \\"userName\\": \\"MjphbXFwLWNuLXVxbTJ6cjc2djAwMzpMVEFJNX*******ZNMWVSWnRFSjZ2Zm8=\\",\\n \\"password\\": \\"OUYwQzM2QjZBRkUxNDRFM***************MzZCNzdDQzoxNjcxNDMwMzkyODI1\\",\\n \\"deleted\\": 0,\\n \\"createTimestamp\\": 1671175303522,\\n \\"Remark\\": \\"***环境\\"\\n }\\n ]\\n },\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 549A5A97-FE61-5A23-8126-3A1192*****\\n true\\n \\n amqp-cn-uqm******03\\n LTAI5***********eRZtEJ6vfo\\n MjphbXFwLWNuLXVxbTJ6cjc2djAwMzpMVEFJNX*******ZNMWVSWnRFSjZ2Zm8=\\n OUYwQzM2QjZBRkUxNDRFM***************MzZCNzdDQzoxNjcxNDMwMzkyODI1\\n 0\\n 1671175303522\\n \\n 200\\n operation success\\n","errorExample":""}]', + 'title' => 'ListAccounts', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'amqp-open.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'amqp-open.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'amqp-open.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'amqp-open.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'amqp-open.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'amqp-open.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'amqp-open.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'amqp-open.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'amqp-open.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'amqp-open.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'amqp-open.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'amqp-open.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'amqp-open.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'amqp-open.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'amqp-open.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'amqp-open.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'amqp-open.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'amqp-open.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'amqp-open.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'amqp-open.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'amqp-open.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'amqp-open.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'amqp-open.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'amqp-open.me-central-1.aliyuncs.com', + ], + ], +]; -- cgit v1.2.3