Creates a subscription ApsaraMQ for Kafka instance. You can use subscription instances only after you pay for them. Subscription instances are suitable for long-term and stable business scenarios.
Operation description
- Before you call this operation, make sure that you understand the billing methods and pricing of subscription ApsaraMQ for Kafka instances. For more information, see Billing .
- If you create an ApsaraMQ for Kafka instance by calling this operation, the subscription duration is one month and the auto-renewal feature is enabled by default. The auto-renewal cycle is also one month. If you want to change the auto-renewal cycle or disable the auto-renewal feature, you can go to the Renewal page in the Alibaba Cloud Management Console.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
alikafka:CreatePrePayOrder | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the instance. | cn-hangzhou |
DiskType | string | Yes | The disk type. Valid values:
| 0 |
DiskSize | integer | Yes | The disk size. Unit: GB. For more information about the valid values, see Billing . | 500 |
PartitionNum | integer | No | The number of partitions. We recommend that you configure this parameter.
| 50 |
TopicQuota | integer | No | The number of topics. We recommend that you do not configure this parameter.
| 50 |
DeployType | integer | Yes | The deployment mode of the instance. Valid values:
| 5 |
EipMax | integer | No | The Internet traffic for the instance.
| 0 |
SpecType | string | No | The edition of the instance. Valid values:
For more information, see Billing . | normal |
IoMaxSpec | string | No | The traffic specification of the instance. We recommend that you configure this parameter.
| alikafka.hw.2xlarge |
IoMax | integer | No | The maximum traffic for the instance. We recommend that you do not configure this parameter.
| 20 |
ResourceGroupId | string | No | The ID of the resource group. If this parameter is left empty, the default resource group is used. You can view the resource group ID on the Resource Group page in the Resource Management console. | rg-ac***********7q |
Tag | object [] | No | The tags. | |
Key | string | Yes | The key of tag N.
| FinanceDept |
Value | string | No | The value of tag N.
| FinanceJoshua |
Response parameters
Examples
Sample success responses
JSON
format
{
"Code": 200,
"Message": "operation success.",
"RequestId": "06084011-E093-46F3-A51F-4B19A8AD****",
"Success": true,
"OrderId": "20497346575****"
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | BIZ.LIMIT.PUBNETWORK | EipMax is invalid. |
400 | BIZ.LIMIT.QUOTA.DOWN | Invalid.%s |
400 | BIZ.LIMIT.QUOTA.DOWN.1 | Invalid.%s |
400 | BIZ.LIMIT.QUOTA.DOWN.2 | Invalid.%s |
400 | Invalid.Partition.%s | Invalid.%s |
400 | BIZ_FIELD_CHECK_INVALID | %s. Please check and try again later. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2024-03-01 | The Error code has changed | see changesets | ||||||||
| ||||||||||
2024-02-27 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||
| ||||||||||
2022-10-28 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||
| ||||||||||
2022-08-31 | The Error code has changed | see changesets | ||||||||
|