tencent cloud



Last updated: 2023-08-09 14:43:18

1. API Description

Domain name for API request: tdmq.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 No String Common Params. This parameter is not required for this API.
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
Note: u200dThis field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the specification of a TDMQ for RocketMQ exclusive instance

This example shows you how to modify the specification of a TDMQ for RocketMQ exclusive instance.

Input Example

Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRocketMQInstanceSpec
<Common request parameters>

    "InstanceId": "abc",
    "Specification": "abc",
    "NodeCount": 1,
    "StorageSize": 1

Output Example

    "Response": {
        "OrderId": "abc",
        "RequestId": "abc"

5. Developer Resources


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

Command Line Interface

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.
ResourceNotFound.Instance The instance doesn’t exist.
UnsupportedOperation.InstanceDowngrade The instance does not support configuration downgrade.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support