SetRocketMQPublicAccessPoint

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

SetRocketMQPublicAccessPoint

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

1. API Description

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

This API is used to enable/disable public network access, and set the security access policy.

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: SetRocketMQPublicAccessPoint.
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	Cluster ID. Currently, the system only supports dedicated clusters.
Enabled	Yes	Boolean	Enable or Disable Access
Bandwidth	No	Integer	Bandwidth size, in Mbps. It must be specified when you enable or adjust the public network access.
PayMode	No	Integer	Payment mode, which must be specified when you enabled the public network access. 0 means hourly billing, and 1 means annual and monthly subscription. Currently, only hourly billing is supported.
Rules.N	No	Array of PublicAccessRule	Public network access security rule list, which must be provided when Enabled is true.
BillingFlow	No	Boolean	Whether 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 Enabling Public Network Access Point

Input Example

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

{
    "Rules": [
        {
            "Remark": "remark info",
            "IpRule": "0.0.0.0/0",
            "Allow": "true"
        }
    ],
    "PayMode": "0",
    "Bandwidth": "2",
    "InstanceId": "rocketmq-jxj3wj5j8e7",
    "Enabled": "true"
}

Output Example

{
    "Response": {
        "RequestId": "b28ad6c3-059f-4c38-8a97-a66b3b136a3e"
    }
}

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.
ResourceInUse	The resource is in use.
ResourceNotFound	The resource does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud