Domain name for API request: tdmq.intl.tencentcloudapi.com.
This API is used to modify the RocketMQ dedicated cluster configuration, supporting upgrades of instance specification, number of nodes and storage, as well as downgrades of instance specification. After initiating order and completing payment, it will enter the instance configuration change process. You can check whether the change is completed via DescribeRocketMQVipInstances.
This API is applicable to clusters: 4.x dedicated cluster and 4.x generic cluster. For 5.x clusters, refer to the API documentation ModifyInstance.
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: ModifyRocketMQInstanceSpec. |
| Version | Yes | String | Common Params. The value used for this API: 2020-02-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | ID of the exclusive instance |
| Specification | No | String | Instance specification. Valid values: rocket-vip-basic-1 (Basic),rocket-vip-basic-2 (Standard),rocket-vip-basic-3 (Advanced I),rocket-vip-basic-4 (Advanced II). |
| NodeCount | No | Integer | Node count |
| StorageSize | No | Integer | Storage space in GB |
| Parameter Name | Type | Description |
|---|---|---|
| OrderId | String | Order 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. |
Scale an instance
POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRocketMQInstanceSpec
<Common request parameters>
{
"InstanceId": "rocketmq-4k4orqgq",
"Specification": "rocket-vip-basic-1",
"NodeCount": 2,
"StorageSize": 1000
}
{
"Response": {
"OrderId": "20230720073017608094121",
"RequestId": "23ca1a58-0388-4d2d-8465-653a53addda7"
}
}
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.CallTrade | An exception occurred while calling the transaction service. |
| FailedOperation.InstanceNotReady | This instance is not ready. Please try again later. |
| InvalidParameterValue.AtLeastOne | At least one parameter needs to be provided. |
| ResourceNotFound.Instance | The instance doesn’t exist. |
| UnsupportedOperation.InstanceDowngrade | The instance does not support configuration downgrade. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback