tencent cloud

ModifyRocketMQNamespace
Last updated: 2025-11-25 10:52:23
ModifyRocketMQNamespace
Last updated: 2025-11-25 10:52:23

1. API Description

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

This API is used to update a RocketMQ namespace.

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: ModifyRocketMQNamespace.
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.
ClusterId Yes String Cluster ID
NamespaceId Yes String Namespace name, which can contain 3–64 letters, digits, hyphens, and underscores
Ttl No Integer This parameter is disused.
RetentionTime No Integer This parameter is disused.
Remark No String Remarks (up to 128 characters)
PublicAccessEnabled No Boolean Whether to enable the public network access

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 Namespace Information

This example shows you how to modify namespace information.

Input Example

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

{
    "ClusterId": "rocketmq-xj8kr5apevj7",
    "NamespaceId": "test_namespace",
    "Ttl": 259200000,
    "RetentionTime": 259200000,
    "Remark": "Test modification",
    "PublicAccessEnabled": true
}

Output Example

{
    "Response": {
        "RequestId": "7c995fd0-9a78-4985-8874-244a20a1d47b"
    }
}

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

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.SetTTL Failed to configure the message TTL.
InternalError Internal error.
InvalidParameter Incorrect parameter.
LimitExceeded The quota limit is exceeded.
ResourceInUse The resource is in use.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
ResourceNotFound.Cluster The cluster does not exist.
ResourceUnavailable.FundRequired You must top up before proceeding.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback