CreateRole

Download PDF

Last updated: 2025-12-02 10:56:28

CreateRole

Last updated: 2025-12-02 10:56:28

Download PDF

1. API Description

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

This API is used to add 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: CreateRole.
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 cannot be left blank. Only digits, uppercase and lowercase letters, and separators (_ -) are supported. The name cannot exceed 32 characters.
PermWrite	Yes	Boolean	Whether to enable production permission
PermRead	Yes	Boolean	Whether to enable consumption permission
Remark	Yes	String	Remarks
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 level).
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
Role	String	Role name.
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 Add Role

Add a role

Input Example

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

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

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "RequestId": "0bb79e96-2531-4088-8d90-e1372c15518a",
        "Role": "test_role_name"
    }
}

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.
OperationDenied	Operation denied.
ResourceInUse	The resource is occupied.
ResourceNotFound.Instance	The instance does not exist.
UnsupportedOperation.ResourceAlreadyExists	Resource already exists. Please check and try again.

Was this page helpful?

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

Yes

Feedback

tencent cloud