ModifyInstance

最后更新时间：2026-01-13 21:52:17

ModifyInstance

最后更新时间： 2026-01-13 21:52:17

1. API Description

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

This API is used to modify attributes of a TDMQ RocketMQ 5.x cluster. Only running clusters support this operation.

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: ModifyInstance.
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.
InstanceId	Yes	String	TDMQ RocketMQ instance ID. It can be obtained from the API DescribeFusionInstanceList or the console.
Name	No	String	Instance name. It cannot be left blank. It can contain 3 to 64 characters consisting of only digits, letters, hyphens (-), and underscores (_).
Remark	No	String	Remarks. Up to 128 characters are allowed.
SendReceiveRatio	No	Float	Message sending and receiving ratio
SkuCode	No	String	Product specification. It can be obtained from the output parameters of ProductSKU of the API DescribeProductSKUs.
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.
ScaledTpsEnabled	No	Boolean	Whether to enable elastic TPS.
AclEnabled	No	Boolean	Whether ACL is enabled.
MaxTopicNum	No	Integer	The maximum number of topics that can be created. value ranges from...to... refer to the ProductSKU output parameter 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). -Minimum value and default value: TopicNumLimit parameter. -Maximum value of TopicNumUpperLimit parameter.
ExtraTopicNum	No	String	Number of topics not included in the free quota. For the free quota, see the TopicNumLimit parameter in the output parameters of ProductSKU of the API DescribeProductSKUs.
EnableDeletionProtection	No	Boolean	Whether to enable deletion protection

3. Output Parameters

Parameter Name	Type	Description
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 Modify Instance Configuration

This example shows you how to modify instance configuration.

Input Example

POST / HTTP/1.1
Host: trocket.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstance
<Common request parameters>

{
    "InstanceId": "rmq-72mo3a9o",
"Remark": "Test modify message retention duration"
    "MessageRetention": 25
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "RequestId": "becc23c2-b5e1-4df4-9df1-22ba8e5b20c3"
    }
}

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	Operation failed.
FailedOperation.InstanceNotReady	Instance not ready. Please try again later.
ResourceUnavailable	Resources are unavailable.
UnsupportedOperation.InstanceTopicNumDowngrade	The number of instance topics cannot be adjusted below the used quota.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud