ModifyRole

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

ModifyRole

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

1. API Description

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

This API is used to modify a role.

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: ModifyRole.
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.
Role	Yes	String	Role name. It can be obtained from RoleItem returned by the API DescribeRoleList or from the console.
PermRead	Yes	Boolean	Whether to enable consumption.
PermWrite	Yes	Boolean	Whether to enable production
PermType	No	String	Specifies the types of permissions. the default is to authorize by Cluster (Cluster: at the Cluster level; TopicAndGroup: topic and consumer group dimension).
Remark	No	String	Remarks
DetailedPerms.N	No	Array of DetailedRolePerm	Permission configuration in the topic/group dimension. It is required when the permission type parameter is set to TopicAndGroup.

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 a Role

This example shows you how to modify a role successfully.

Input Example

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

{
    "InstanceId": "rmq-72mo3a9o",
    "Role": "test_role_name",
"Remark": "Test modification"
    "PermRead": false,
    "PermWrite": false
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "RequestId": "0608515b-cde2-41d6-933c-169d0d1849c5"
    }
}

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.
ResourceNotFound.Instance	The instance does not exist.
ResourceNotFound.Role	Role does not exist. Please check and try again.

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

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

是

否

文档反馈

tencent cloud