Release Notes
Announcements
Domain name for API request: trocket.intl.tencentcloudapi.com.
This API is used to create a RocketMQ 5.x cluster.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateInstance. |
| Version | Yes | String | Common Params. The value used for this API: 2023-03-08. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceType | Yes | String | Instance type. valid values are as follows:. -EXPERIMENT: specifies the trial version. - BASIC: BASIC edition. -PRO edition. -PLATINUM: platinum version. |
| Name | Yes | String | Cluster name. values cannot be empty. 3-64 characters, only comprised of digits, letters, "-", and "_". |
| SkuCode | Yes | String | Product specification. It can be obtained from the output parameters of ProductSKU of the API DescribeProductSKUs. |
| VpcList.N | Yes | Array of VpcInfo | Specifies the VPC information bound to the cluster. |
| Remark | No | String | Remarks |
| TagList.N | No | Array of Tag | Tag list |
| EnablePublic | No | Boolean | Whether public network access is enabled. the default value of false means not enabled. |
| BillingFlow | No | Boolean | Whether the public network is billed by traffic. the default value is false, which indicates that the public network is not billed by traffic. |
| Bandwidth | No | Integer | Public network bandwidth (unit: mbps). the default value is 0. if public network access is enabled, this field must be a positive integer above 0. |
| IpRules.N | No | Array of IpRule | Public network access allowlist. if left blank, it means deny all IP access. |
| MessageRetention | No | Integer | Message retention time (unit: hr). value range refers to the ProductSKU response parameters structure in the DescribeProductSKUs api (https://www.tencentcloud.com/document/api/1493/107676?from_cn_redirect=1). -Default value: DefaultRetention parameter. -Minimum value: specifies the RetentionLowerLimit parameter. -Specifies the maximum value of the RetentionUpperLimit parameter. |
| PayMode | No | Integer | Payment mode (0: postpaid; 1: prepaid). the default value is 0. |
| RenewFlag | No | Integer | Whether the prepaid cluster is automatically renewed (0: no auto-renewal; 1: auto-renewal). default value: 0. |
| TimeSpan | No | Integer | Specifies the purchase duration (unit: month) for a prepaid cluster. value range: 1–60. default value: 1. |
| MaxTopicNum | No | Integer | Specifies the maximum number of topics that can be created. obtained from the ProductSKU response parameters structure in the DescribeProductSKUs api (https://www.tencentcloud.com/document/api/1493/107676?from_cn_redirect=1) (https://www.tencentcloud.com/document/api/1493/96031?from_cn_redirect=1#ProductSKU). -Default value and minimum value: specifies the TopicNumLimit parameter. -Maximum value of TopicNumUpperLimit parameter. |
| ZoneIds.N | No | Array of Integer | Deployment AZ list. obtain from the ZoneInfo data structure returned by the api DescribeZones. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceId | String | Cluster ID |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to successfully create a RocketMQ 5.x cluster with TPS 2000.
POST / HTTP/1.1
Host: trocket.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstance
<Common request parameters>
{
"InstanceType": "BASIC",
"Name": "test_instance",
"SkuCode": "basic_2k",
"VpcList": [
{
"VpcId": "vpc-xxxx",
"SubnetId": "subnet-xxxx"
}
]
}{
"Error": null,
"RequestId": null,
"Response": {
"InstanceId": "rmq-72mo3a9or",
"RequestId": "32759095-0372-4ec0-ae3a-e5a2759fd0ff"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
フィードバック