ModifyRocketMQInstanceSpec

Download PDF

Last updated: 2025-11-25 10:52:46

ModifyRocketMQInstanceSpec

Last updated: 2025-11-25 10:52:46

Download PDF

1. API Description

Domain name for API request: tdmq.intl.tencentcloudapi.com.

This API is used to modify the configurations of a TDMQ for RocketMQ exclusive instance, including the upgrade of the instance specification, node count, and storage, and the downgrade of the instance specification. After you call this API to place the order and make payments, the configuration modification will be in progress. You can query whether the modification has been completed through the DescribeRocketMQVipInstances API`.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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

3. Output Parameters

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.

4. Example

Example1 Modifying the RocketMQ Dedicated Instance Specification

This example shows you how to perform scaling on an instance.

Input Example

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
}

Output Example

{
    "Response": {
        "OrderId": "TDMQ20121212312322",
        "RequestId": "23ca1a58-0388-4d2d-8465-653a53addda7"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.

Yes

Feedback

tencent cloud