ModifyInstanceEndpoint

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

ModifyInstanceEndpoint

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

1. API Description

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

This API is used to modify access points of a TDMQ RocketMQ 5.x cluster. Make sure that the access points exist before the 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: ModifyInstanceEndpoint.
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.
Type	Yes	String	Access point type. PUBLIC network.
Bandwidth	No	Integer	Public network bandwidth, in Mbps
IpRules.N	No	Array of IpRule	Public network security group information
BillingFlow	No	Boolean	Whether the public network is billed by traffic.

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 Modifying Public Network Configuration of an Instance

This example shows you how to modify the public network configuration of an instance.

Input Example

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

{
    "InstanceId": "rmq-cdrgxq94om",
    "Type": "PUBLIC",
    "Bandwidth": 2,
    "IpRules": [
        {
            "Ip": "1.2.3.4",
            "Allow": true,
            "Remark": "test remark"
        }
    ]
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "RequestId": "999bc587-90d9-4ec2-97e3-3ef170e1da96"
    }
}

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
OperationDenied	Operation denied.
ResourceNotFound.Endpoint	Access point does not exist.
UnsupportedOperation	The operation is not supported.

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

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

是

否

文档反馈

tencent cloud