tencent cloud



Last updated: 2023-08-09 14:43:30

1. API Description

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

This API is used to create 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: 2020-02-17.
Region No String Common Params. This parameter is not required for this API.
RoleName Yes String Role name, which can contain up to 32 letters, digits, hyphens, and underscores.
Remark No String Remarks (up to 128 characters).
ClusterId No String Cluster ID (required)

3. Output Parameters

Parameter Name Type Description
RoleName String Role name
Token String Role token
Remark String Remarks
Note: this field may return null, indicating that no valid values can be obtained.
EnvironmentRoleSets Array of EnvironmentRoleSet Namespaces that are bound in batches
Note: u200dThis field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a role

This example shows you how to create a role.

Input Example

&Remark=Creating a role
&<Common request parameters>

Output Example

    "Response": {
        "RoleName": "abc",
        "Token": "abc",
        "Remark": "abc",
        "EnvironmentRoleSets": [
                "EnvironmentId": "abc",
                "Permissions": [
        "RequestId": "abc"

5. Developer Resources


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
AuthFailure.UnauthorizedOperation CAM authentication failed.
FailedOperation Operation failed.
FailedOperation.CreateRole Failed to create the role.
FailedOperation.CreateSecretKey Failed to create the key.
FailedOperation.SaveSecretKey Failed to save the key.
InternalError.SystemError System error.
InvalidParameterValue.InvalidParams The parameter value is out of the value range.
MissingParameter.NeedMoreParams A required parameter is missing.
ResourceInUse.Role The role already exists.
ResourceNotFound.BrokerCluster The service cluster does not exist.
ResourceNotFound.Cluster The cluster does not exist.
ResourceUnavailable.FundRequired You must top up before proceeding.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support