'1.0', 'info' => ['style' => 'RPC', 'product' => 'amqp-open', 'version' => '2019-12-12'], 'directories' => [ [ 'children' => ['CreateInstance', 'GetInstance', 'UpdateInstance', 'UpdateInstanceName', 'GetMetadataAmount', 'ListInstances', 'AddInstanceWhiteList', 'ListInstanceWhiteList', 'RemoveInstanceWhiteList'], 'type' => 'directory', 'title' => 'Instances', ], [ 'children' => ['CreateVirtualHost', 'DeleteVirtualHost', 'ListVirtualHosts'], 'type' => 'directory', 'title' => 'Vhost', ], [ 'children' => ['CreateQueue', 'DeleteQueue', 'ListQueueConsumers', 'ListQueues', 'ListQueueUpStreamBindings'], 'type' => 'directory', 'title' => 'Queue', ], [ 'children' => ['CreateExchange', 'DeleteExchange', 'ListDownStreamBindings', 'ListExchanges', 'ListExchangeUpStreamBindings'], 'type' => 'directory', 'title' => 'Exchange', ], [ 'children' => ['CreateBinding', 'DeleteBinding', 'ListBindings'], 'type' => 'directory', 'title' => 'Binding', ], [ 'children' => ['CreateAccount', 'DeleteAccount', 'ListAccounts'], 'type' => 'directory', 'title' => 'Static username and password', ], [ 'children' => ['CreateOpenSourceAccount', 'CreateOpenSourcePermission', 'DeleteOpenSourceAccount', 'DeleteOpenSourcePermission', 'ListOpenSourceAccounts', 'ListOpenSourcePermissions', 'UpdateInstanceServerlessSwitch', 'UpdateOpenSourceAccount', 'UpdateOpenSourcePermission'], 'title' => 'Others', 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AddInstanceWhiteList' => [ 'summary' => 'Adds an entry to the whitelist of an instance.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREonsSGDS5X'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance receiving the whitelist entry.', 'type' => 'string', 'required' => true, 'example' => 'rabbitmq-cn-xxx', 'title' => ''], ], [ 'name' => 'WhiteListItem', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The value of the whitelist entry. For an IP address whitelist, specify a CIDR block and set the `WhiteListType` parameter to `2`. For a VPC whitelist, specify a VPC ID and set the `WhiteListType` parameter to `1`.', 'type' => 'string', 'required' => true, 'example' => '172.0.0.20/30', 'title' => ''], 'required' => true, 'title' => '', 'description' => 'The IP addresses or VPC IDs to add to the whitelist. Specify IP addresses as CIDR blocks.', 'example' => '172.0.0.20/30', ], ], [ 'name' => 'WhiteListType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the whitelist. Set this parameter to `2` if `WhiteListItem` contains IP addresses, or to `1` if it contains VPC IDs.'."\n" ."\n" .'You can add a VPC whitelist only to instances that have an `anytunnel` VPC endpoint. Newer instances use the `privateLink` endpoint type, which does not support this feature.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'enum' => ['1', '2'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8BFB1C9D-08A2-4859-A47C-403C9EFA2***'], 'Code' => ['description' => 'The status code. A value of `200` indicates a successful request.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message returned with the response. This is typically an error message if the request fails.', 'type' => 'string', 'example' => 'The specified parameter \'[\\"vpc-xxx\\"]\' is not valid', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => ['description' => 'Data returned by the operation.', 'type' => 'any', 'example' => 'true', 'title' => ''], 'StatusCode' => ['description' => 'The HTTP status code for the response. A value of `200` indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], ], 'title' => '', 'description' => 'The result of the API request.', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InstanceNotExist', 'errorMessage' => 'The instance resource does not exist.', 'description' => 'The instance resource does not exist.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AddInstanceWhiteList', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8BFB1C9D-08A2-4859-A47C-403C9EFA2***\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified parameter \'[\\\\\\\\\\\\\\"vpc-xxx\\\\\\\\\\\\\\"]\' is not valid\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"true\\",\\n \\"StatusCode\\": \\"200\\"\\n}","type":"json"}]', ], 'CreateAccount' => [ 'summary' => 'When an open-source client accesses an ApsaraMQ for RabbitMQ server, it must provide a username and password for authentication. ApsaraMQ for RabbitMQ lets you generate a username and password from an AccessKey ID and AccessKey secret provided by 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 ApsaraMQ for RabbitMQ instance. This specifies the instance for which you want to create a static username and password.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amqp-cn-*********', 'title' => ''], ], [ 'name' => 'accountAccessKey', 'in' => 'query', 'schema' => ['description' => 'The AccessKey ID of your Alibaba Cloud account or RAM user. For more information about how to obtain an AccessKey ID, see [Create an AccessKey](~~116401~~).'."\n" ."\n" .'> If you use the AccessKey of a RAM user to create a static username and password to access ApsaraMQ for RabbitMQ and to send and receive messages, make sure that the RAM user is granted the required permissions. For more information, see [RAM access policies](~~146559~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourAccessKeyID', 'title' => ''], ], [ '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 constructed from the instance ID and the AccessKey ID. For more information about how to calculate the value, see the **Username calculation sample code** section in this topic.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Mjo****************', 'title' => ''], ], [ 'name' => 'signature', 'in' => 'query', 'schema' => ['description' => 'The signature. The system calculates the static password based on the signature, the AccessKey secret signature, and the username.'."\n" ."\n" .'The signature is calculated using the HmacSHA1 algorithm on the creation timestamp of the specified username and the AccessKey ID. For more information about how to calculate the signature, see the **Signature algorithm sample code** section in this topic.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '22c2d7d1769cb53c5a6d9213248e2de524******', 'title' => ''], ], [ 'name' => 'createTimestamp', 'in' => 'query', 'schema' => ['description' => 'The timestamp that indicates when the username and password are created. Unit: milliseconds.'."\n" ."\n" .'> This timestamp is used to calculate the static password. You can customize this value. This is not the timestamp that the system generates when the username and password are created.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1671175303522', 'title' => ''], ], [ 'name' => 'secretSign', 'in' => 'query', 'schema' => ['description' => 'The signature of the AccessKey secret. The system calculates the static password based on the signature, the AccessKey secret signature, and the username.'."\n" ."\n" .'The AccessKey secret signature is calculated using the HmacSHA1 algorithm on the creation timestamp of the specified username and the AccessKey ID. For more information about how to calculate the signature, see the **Signature algorithm sample code** section in this topic.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4c1a6367ce4c4255e9617326f9133ac635******', 'title' => ''], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The remarks on the static user.', 'type' => 'string', 'example' => '*** environment', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'FEBA5E0C-50D0-4FA6-A794-4901E5465***', ], 'Code' => ['description' => 'The return code. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'AccessKey' => ['description' => 'The AccessKey ID that is used to create the username and password.', 'type' => 'string', 'example' => 'LTAI****************', 'title' => ''], 'Password' => ['description' => 'The created static password.', 'type' => 'string', 'example' => 'OUYwQzM2QjZBRkUxNDRFM***************MzZCNzdDQzoxNjcxNDMwMzkyODI1', 'title' => ''], 'CreateTimeStamp' => ['description' => 'The timestamp when the username and password were created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1671175303522', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the ApsaraMQ for RabbitMQ instance.', 'type' => 'string', 'example' => 'amqp-cn-*********', 'title' => ''], 'MasterUId' => ['description' => 'The ID of the Alibaba Cloud account or RAM user that owns the AccessKey. The AccessKey is used to create the static username and password.', 'type' => 'integer', 'format' => 'int64', 'example' => '1565***********01', 'title' => ''], 'UserName' => ['description' => 'The created static username.', 'type' => 'string', 'example' => 'MjphbXFwLWNuLXVxbTJ6cjc2djAwMzpMVEFJNX*******ZNMWVSWnRFSjZ2Zm8=', 'title' => ''], 'Remark' => ['description' => 'The remarks.', 'type' => 'string', 'example' => '*** environment', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","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\\": \\"*** environment\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateAccount', 'description' => '### Background information'."\n" ."\n" .'When an open-source client accesses an ApsaraMQ for RabbitMQ server, it must provide a username and password for authentication. The client can access the server after the authentication is successful. ApsaraMQ for RabbitMQ lets you generate a username and password from an AccessKey ID and AccessKey secret provided by RAM.'."\n" ."\n" .'### Notes'."\n" ."\n" .'- The instance for which you create a static username and password must be in the In Service state.'."\n" ."\n" .'- An AccessKey and a static username and password have a one-to-one mapping within an instance. This means you can create only one static username and password for each AccessKey in an instance.'."\n" ."\n" .'- To update a static username and password, delete the existing one and create a new one.'."\n" ."\n" .'### Username calculation sample code'."\n" ."\n" .'The value of the userName request parameter is a Base64-encoded string. This string is constructed from the instance ID and the AccessKey ID. The following sample code shows how to calculate the value:'."\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 a 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" .' // Construct a string from your instance ID and the AccessKey ID of the account that was used to purchase the instance.'."\n" .' String str = "2:${instanceId}:${ak}";'."\n" ."\n" .' // Generate the userName for the API call.'."\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" .'### Signature algorithm sample code'."\n" ."\n" .'The values of the signature and secretSign request parameters are calculated using an encryption algorithm. The algorithm uses the creation timestamp of the static username and the AccessKey secret. The following sample code shows the algorithm:'."\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" .' // createTimestamp is the createTimestamp parameter of the API.'."\n" .' String createTimestamp = String.valueOf(System.currentTimeMillis());'."\n" .' System.out.println("timestamp:" + createTimestamp);'."\n" ."\n" .' // The AccessKey secret of your account.'."\n" .' String sk = "${sk}";'."\n" ."\n" .' // Generate the SecretSign for the API call.'."\n" .' String SecretSign = hamcsha1(sk.getBytes(), createTimestamp.getBytes());'."\n" .' System.out.println("SecretSign:" + SecretSign);'."\n" ."\n" .' // Generate the signature for the API call.'."\n" .' String signature = hamcsha1(createTimestamp.getBytes(), sk.getBytes());'."\n" .' System.out.println("signature:" + signature);'."\n" .' }'."\n" .'}'."\n" .'```', 'extraInfo' => '### 控制台操作'."\n" .'除了调用**CreateAccount**接口，您还可以通过云消息队列 RabbitMQ 版控制台创建静态用户名密码。具体操作，请参见[静态用户名密码管理](~~184399~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccount'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'amqp:FetchStaticAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Amqp', 'resourceType' => 'Instance', 'arn' => 'acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}'], ], ], 'additionalActions' => [ ['action' => 'amqp:GetInstance'], ], ], ], 'translator' => 'manual', ], 'CreateBinding' => [ 'summary' => 'A producer sends a message to an exchange, which then routes the message to a specified queue or another exchange based on the binding and routing rules.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '58722', 'abilityTreeNodes' => ['FEATUREons5ZTT5D'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the ApsaraMQ for RabbitMQ instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amqp-cn-v0h1kb9nu***', 'title' => ''], ], [ 'name' => 'VirtualHost', 'in' => 'formData', 'schema' => ['description' => 'The name of the vhost. The vhost must be created in the console. Both `DestinationName` and `SourceExchange` must belong to this vhost.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'SourceExchange', 'in' => 'formData', 'schema' => ['description' => 'The name of the source exchange. This exchange must be created in the console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NormalEX', 'title' => ''], ], [ 'name' => 'DestinationName', 'in' => 'formData', 'schema' => ['description' => 'The name of the binding destination. The destination must be created in the console. It must belong to the same vhost as `SourceExchange`. The `VirtualHost` parameter specifies the vhost.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DemoQueue', 'title' => ''], ], [ 'name' => 'BindingKey', 'in' => 'formData', 'schema' => ['description' => 'The binding key.'."\n" ."\n" .'- If the source exchange is not a topic exchange:'."\n" ."\n" .' - It can contain letters, digits, hyphens (-), underscores (\\_), periods (.), forward slashes (/), and at signs (@).'."\n" ."\n" .' - The length must be 1 to 255 characters.'."\n" ."\n" .'- If the source exchange is a topic exchange:'."\n" ."\n" .' - It can contain letters, digits, hyphens (-), underscores (\\_), asterisks (\\*), periods (.), number signs (#), forward slashes (/), and at signs (@).'."\n" ."\n" .' - The key cannot start or end with a period (.). If the key starts with a number sign (#) or an asterisk (\\*), a period (.) must immediately follow. If the key ends with a number sign (#) or an asterisk (\\*), a period (.) must immediately precede it. If a number sign (#) or an asterisk (\\*) is in the middle of the key, it must have a period (.) on both sides.'."\n" ."\n" .' - The length must be 1 to 255 characters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '.test', 'title' => ''], ], [ 'name' => 'BindingType', 'in' => 'formData', 'schema' => ['description' => 'The type of the destination object. Valid values:'."\n" ."\n" .'- 0: Queue'."\n" ."\n" .'- 1: Exchange', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''], ], [ 'name' => 'Argument', 'in' => 'formData', 'schema' => ['description' => 'The key-value pairs for the message header attributes. The message header attributes consist of one or more key-value pairs. The x-match attribute is required. Other attributes are custom. The x-match attribute supports the following values:'."\n" ."\n" .'- all: This is the default value. All key-value pairs in the message header must match.'."\n" ."\n" .'- any: At least one key-value pair in the message header must match.'."\n" ."\n" .'Separate attributes with semicolons (;) and separate keys from values with colons (:). Example: x-match:all;type:report;format:pdf'."\n" .'This parameter is valid only for headers exchanges. For other types of exchanges, this parameter is ignored.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'x-match:all;type:report;format:pdf ', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '09768C14-E51C-4F4A-8077-30810032C***', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'CreateBinding', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBinding'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'amqp:GetExchange', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Amqp', 'resourceType' => 'Queue', 'arn' => 'acs:amqp:{#regionId}:{#accountId}:/instances/{#InstanceId}/vhosts/{#vhostName}/queues/*'], ], ], 'additionalActions' => [ ['action' => 'amqp:CreateExchange', 'validationType' => 'conditional'], ['action' => 'amqp:CreateQueue'], ['action' => 'amqp:GetVhost'], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09768C14-E51C-4F4A-8077-30810032C***\\"\\n}","type":"json"}]', ], 'CreateExchange' => [ 'summary' => 'A producer sends a message to an exchange. The exchange then routes the message to one or more queues based on the routing key and the binding key, or discards the message.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREonsUA0VH5'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'amqp-cn-v0h1kb9nu***', 'title' => ''], ], [ 'name' => 'VirtualHost', 'in' => 'formData', 'schema' => ['description' => 'The name of the vhost to which the exchange belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'ExchangeName', 'in' => 'formData', 'schema' => ['description' => 'The name of the exchange. Note:'."\n" ."\n" .'- The name can contain only letters, digits, hyphens (-), underscores (\\_), periods (.), number signs (#), forward slashes (/), and at signs (@). The name must be 1 to 255 characters in length.'."\n" ."\n" .'- The name of an exchange cannot be changed after the exchange is created. To change the name, delete the exchange and create a new one.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DemoExchange', 'title' => ''], ], [ 'name' => 'ExchangeType', 'in' => 'formData', 'schema' => [ 'description' => 'The type of the exchange. Valid values:'."\n" ."\n" .'- **DIRECT**: This routing rule type routes messages to a queue whose binding key exactly matches the routing key of the message.'."\n" ."\n" .'- **TOPIC**: This type is similar to the DIRECT type. It routes messages to bound queues using routing key pattern matching and string comparison.'."\n" ."\n" .'- **FANOUT**: This routing rule type is simple. It routes all messages sent to the exchange to all queues that are bound to the exchange. This works like a broadcast feature.'."\n" ."\n" .'- **HEADERS**: This type is similar to the DIRECT type. It uses header properties instead of a routing key for routing. When a queue is bound to a headers exchange, key-value pairs are defined for the binding. When a message is sent to the exchange, key-value pairs are defined in the message header. The exchange routes the message by comparing the key-value pairs in the header with the key-value pairs of the binding.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enum' => ['DIRECT', 'TOPIC', 'FANOUT', 'HEADERS', 'X_JMS_TOPIC', 'X_DELAYED_MESSAGE', 'X_CONSISTENT_HASH'], 'example' => 'DIRECT', 'title' => '', ], ], [ 'name' => 'XDelayedType', 'in' => 'formData', 'schema' => [ 'description' => 'An x-delayed-message exchange lets you use the x-delay header property to specify a delivery delay for a message in milliseconds. The routing rule for the delayed message is determined by the exchange type that you specify for the XDelayedType parameter. This parameter sets the actual exchange type to which the message is delivered after the delay. Valid values:'."\n" ."\n" .'- **DIRECT**: Delivers the delayed message to the specified queue that is bound to a DIRECT exchange.'."\n" ."\n" .'- **TOPIC**: Delivers the delayed message to queues that are bound to a TOPIC exchange.'."\n" ."\n" .'- **FANOUT**: Delivers the delayed message to queues that are bound to a FANOUT exchange.'."\n" ."\n" .'- **HEADERS**: Delivers the delayed message to queues that are bound to a HEADERS exchange.'."\n" ."\n" .'- **X-JMS-TOPIC**: Delivers the delayed message to queues that are bound to an X-JMS-TOPIC exchange.', 'type' => 'string', 'enum' => ['DIRECT', 'TOPIC', 'FANOUT', 'HEADERS', 'X_JMS_TOPIC'], 'required' => false, 'example' => 'DIRECT', 'title' => '', ], ], [ 'name' => 'AutoDeleteState', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether to automatically delete the exchange. Valid values:'."\n" ."\n" .'- **true**: Yes. The exchange is automatically deleted after the last queue is unbound from it.'."\n" ."\n" .'- **false**: No. The exchange is not automatically deleted after the last queue is unbound from it.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''], ], [ 'name' => 'Internal', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether the exchange is an internal exchange. Valid values:'."\n" ."\n" .'- **false**: No'."\n" ."\n" .'- **true**: Yes', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AlternateExchange', 'in' => 'formData', 'schema' => ['description' => 'The alternate exchange. Configure an alternate exchange to receive messages that fail to be routed.', 'type' => 'string', 'required' => false, 'example' => 'DemoAE', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '021788F6-E50C-4BD6-9F80-66B0A19A****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'CreateExchange', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExchange'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'amqp:CreateExchange', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Amqp', 'resourceType' => 'Exchange', 'arn' => 'acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/{#vhostName}/exchanges/*'], ], ], 'additionalActions' => [ ['action' => 'amqp:GetVhost'], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"021788F6-E50C-4BD6-9F80-66B0A19A****\\"\\n}","type":"json"}]', ], 'CreateInstance' => [ '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' => '', 'description' => 'The client token.', 'type' => 'string', 'example' => 'c2c5d1274axxxxxxxx', 'required' => false], ], [ 'name' => 'PaymentType', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The payment type. Valid values:'."\n" .'- Subscription: subscription'."\n" .'- PayAsYouGo: Serverless.', 'enumValueTitles' => ['PayAsYouGo' => 'PayAsYouGo', 'Subscription' => 'Subscription'], 'type' => 'string', 'required' => true, 'example' => 'Subscription', 'enum' => ['Subscription', 'PayAsYouGo'], ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The subscription period. Unit: periodCycle.'."\n" ."\n" .'> This parameter takes effect only when PaymentType is set to Subscription. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false], ], [ 'name' => 'PeriodCycle', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The unit of the subscription period. Valid values:'."\n" .'- Month: month'."\n" .'- Year: year'."\n" ."\n" .'This parameter takes effect only when PaymentType is set to Subscription. Default value: Month.', 'enumValueTitles' => ['Month' => 'Month', 'Year' => 'Year'], 'type' => 'string', 'example' => 'Month', 'default' => 'Month', 'enum' => ['Month', 'Year', 'M', 'Y'], 'required' => false, ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The renewal method. Valid values:'."\n" .'- true: Auto-renewal is enabled.'."\n" .'- false: Manual renewal is required.', 'type' => 'boolean', 'example' => 'false', 'default' => 'false', 'required' => false], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The auto-renewal epoch. Unit: the value of RenewalDurationUnit. Default unit: month.'."\n" ."\n" .'> This parameter takes effect only when AutoRenew is set to true. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false], ], [ 'name' => 'RenewStatus', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The renewal status. This parameter is equivalent to autoRenew. Specify only one of the two parameters. Valid values:'."\n" .'- AutoRenewal: auto-renewal is enabled.'."\n" ."\n" .'> Both autoRenew and renewStatus specify the renewal method. If both are specified, renewStatus takes precedence.', 'type' => 'string', 'required' => false, 'example' => 'false'], ], [ 'name' => 'RenewalDurationUnit', 'in' => 'query', 'schema' => [ 'description' => 'The unit of the auto-renewal epoch. Valid values:'."\n" .'- Month: month'."\n" .'- Year: year.', 'enumValueTitles' => ['Month' => 'Month', 'Year' => 'Year'], 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => '', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The instance type.'."\n" .'Valid values for subscription instances:'."\n" .'- professional: Professional Edition'."\n" .'- enterprise: Enterprise Edition'."\n" .'- vip: Platinum Edition'."\n" ."\n" .'You do not need to specify this parameter for Serverless instances.', 'enumValueTitles' => ['enterprise' => 'enterprise', 'vip' => 'vip', 'professional' => 'professional'], 'type' => 'string', 'required' => false, 'example' => 'professional', 'enum' => ['professional', 'enterprise', 'vip', 'serverless', 'provisioned'], ], ], [ 'name' => 'ServerlessChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing type of the Serverless instance. Valid values:'."\n" .'- onDemand: pay-as-you-go.', 'type' => 'string', 'example' => 'onDemand', 'enum' => ['onDemand', 'provisioned'], 'required' => false, 'title' => '', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The instance name. We recommend that the name does not exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'amqp-xxxxx', 'title' => ''], ], [ 'name' => 'MaxPrivateTps', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The private network TPS traffic. Unit: transactions per second.'."\n" ."\n" .'Configure the settings based on the values provided on the [ApsaraMQ for RabbitMQ buy page](https://common-buy.aliyun.com/?commodityCode=ons_onsproxy_pre).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'], ], [ 'name' => 'SupportEip', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to support public network access. Valid values:'."\n" .'- true: Public network access is supported.'."\n" .'- false: Public network access is not supported.', 'type' => 'boolean', 'example' => 'true', 'default' => 'false', 'required' => false], ], [ 'name' => 'MaxEipTps', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The peak public network TPS traffic. Unit: TPS.'."\n" ."\n" .'Configure the settings based on the values provided on the [ApsaraMQ for RabbitMQ buy page](https://common-buy.aliyun.com/?commodityCode=ons_onsproxy_pre).', 'type' => 'integer', 'format' => 'int64', 'example' => '128', 'default' => '128', 'required' => false], ], [ 'name' => 'QueueCapacity', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of queues.'."\n" ."\n" .'Configure the settings based on the values provided on the [ApsaraMQ for RabbitMQ buy page](https://common-buy.aliyun.com/?commodityCode=ons_onsproxy_pre).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'], ], [ 'name' => 'MaxConnections', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The maximum number of connections.'."\n" ."\n" .'Configure the settings based on the values provided on the [ApsaraMQ for RabbitMQ buy page](https://common-buy.aliyun.com/?commodityCode=ons_onsproxy_pre).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50000'], ], [ 'name' => 'StorageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The message storage space. Unit: GB. Valid values:'."\n" .'- Professional Edition and Enterprise instance: fixed at 0.'."\n" ."\n" .'> A value of 0 indicates that no storage fees are charged for Professional Edition and Enterprise instances, not that no storage space is available.'."\n" ."\n" .'- Platinum Edition instances: m × 100, where m ranges from \\[7,28\\].', '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" .'- true: The message trace feature is enabled.'."\n" .'- false: The message trace feature is disabled.'."\n" ."\n" .'> - Platinum Edition instances provide the message trace feature free of charge for 15 days. The trace feature can only be enabled, and the trace retention period can only be set to 15 days.'."\n" .'- Instances of other types can enable or disable the trace feature.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true'], ], [ 'name' => 'TracingStorageTime', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The retention period of message traces. Unit: days. Valid values:'."\n" .'- 3: 3 days'."\n" .'- 7: 7 days'."\n" .'- 15: 15 days'."\n" ."\n" .'This parameter takes effect only when SupportTracing is set to true.', 'type' => 'integer', 'format' => 'int32', 'enum' => ['3', '7', '15'], 'required' => false, 'example' => '3', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmvvajg5qkxhi', 'title' => ''], ], [ 'name' => 'EncryptedInstance', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'This feature is exclusive to dedicated instances. Specifies whether to enable data storage encryption for the instance.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false'], ], [ 'name' => 'KmsKeyId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'This feature is exclusive to dedicated instances. This parameter is required when EncryptedInstance is set to true. The ID of the KMS key used for data encryption at rest. The key must meet the following requirements:'."\n" ."\n" .'- The key cannot be a service key.'."\n" ."\n" .'- The key must be in the active state.'."\n" ."\n" .'- The key must be a symmetric key, not an asymmetric key.'."\n" ."\n" .'- The key usage must be encryption and decryption.'."\n" ."\n" .'- If the KMS key expires or is deleted, data reads and writes become unavailable, and the RabbitMQ instance failures occur.', 'type' => 'string', 'required' => false, 'example' => 'key-xxx'], ], [ 'name' => 'ProvisionedCapacity', 'in' => 'query', 'schema' => ['description' => 'The provisioned TPS capacity for provisioned + elastic instances.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', 'title' => ''], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => [ 'description' => 'The deployment architecture of the Serverless instance. Valid values:'."\n" ."\n" .'- shared: shared architecture. Applicable to provisioned + elastic (shared) and pay-as-you-go editions.'."\n" ."\n" .'- dedicated: dedicated architecture. Applicable to provisioned + elastic (dedicated) edition.', 'type' => 'string', 'enum' => ['shared', 'dedicated'], 'required' => false, 'example' => 'shared', 'title' => '', ], ], [ 'name' => 'Tags', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The resource tags.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The tag object.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'testKey', 'required' => false], 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'testValue', 'required' => false], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The VPC ID used to create a PrivateLink endpoint.', 'type' => 'string', 'required' => true, 'example' => 'vpc-xxx'], ], [ 'name' => 'VswitchIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The vSwitch IDs used to create a PrivateLink endpoint when creating the instance.'."\n" ."\n" .'1. Two vSwitch IDs are required, and they must belong to different zones (except for regions with a single zone).'."\n" ."\n" .'2. The vSwitches must belong to the specified VPC.'."\n" .' '."\n" .'3. The vSwitch status must be Available.'."\n" ."\n" .'4. Each vSwitch must have at least 20 available IP addresses.'."\n" ."\n" .'5. The zone of each vSwitch must support NLB creation.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The vSwitch ID specified when creating the instance.', 'type' => 'string', 'required' => true, 'example' => 'vsw-xxx'], 'required' => true, 'maxItems' => 2, 'minItems' => 1, 'example' => '', ], ], [ 'name' => 'SecurityGroupId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The security group used to create a PrivateLink endpoint.'."\n" ."\n" .'1. Add an inbound access policy that allows the protocol type TCP on destination ports 5672 and 5671.'."\n" ."\n" .'2. Managed security groups are not supported.'."\n" ."\n" .'3. The security group must belong to the specified VPC.', 'type' => 'string', 'required' => true, 'example' => 'sg-xxx'], ], [ 'name' => 'ListenerMode', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'Specifies whether the instance enables only TLS-encrypted ports. This parameter is supported only for dedicated provisioned + elastic instances and Platinum Edition instances.', 'type' => 'string', 'example' => 'tcp_and_ssl', 'default' => 'tcp_and_ssl', 'enum' => ['tcp_and_ssl', 'ssl_only'], 'required' => false, ], ], [ 'name' => 'AuthModel', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'ram openSource', 'description' => '', 'title' => ''], ], [ 'name' => 'ServerlessSwitch', 'in' => 'query', 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'JsonResult