Last updated: 2021-04-19 11:31:53

1. API Description

Domain name for API request:

This API (DescribeRoleList) is used to get the role list under the account.

A maximum of 10 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 parameter. The value used for this API: DescribeRoleList.
Version Yes String Common parameter. The value used for this API: 2019-01-16.
Region No String Common parameter. This parameter is not required for this API.
Page Yes Integer Page number, beginning from 1
Rp Yes Integer Number of lines per page, no greater than 200

3. Output Parameters

Parameter Name Type Description
List Array of RoleInfo Role details list
Note: This field may return null, indicating that no valid value was found.
TotalNum Integer Total number of roles
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting role list

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "List": [
        "RoleId": "4611686018427757165",
        "RoleName": "CloudAudit_QCSRole",
        "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"effect\":\"allow\",\"action\":\"name/sts:AssumeRole\",\"principal\":{\"service\":[\"\"]}}]}",
        "Description": "The permission to create tracking sets in CloudAudit (CA) contains the permission to query and create COS buckets and CMQ instances for delivering CA tracking logs to COS and sending notifications from CMQ.",
        "AddTime": "2019-05-17 11:35:02",
        "UpdateTime": "2019-05-17 11:35:02",
        "ConsoleLogin": 0
        "RoleId": "4611686018427733635",
        "RoleName": "testk8u8732u",
        "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"name/sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"qcs\":\"qcs::cam::uin/909619400:root\"}},{\"action\":\"name/sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"qcs\":\"qcs::cam::uin/2385420691:root\"}}]}",
        "Description": "1gfdg4",
        "AddTime": "2019-04-24 16:09:38",
        "UpdateTime": "2019-04-24 16:09:38",
        "ConsoleLogin": 1
        "RoleId": "4611686018427731422",
        "RoleName": "fewfewgcc44",
        "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"name/sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"qcs\":\"qcs::cam::uin/3374997817:root\"}}]}",
        "Description": "34",
        "AddTime": "2019-04-22 15:25:40",
        "UpdateTime": "2019-04-22 15:25:40",
        "ConsoleLogin": 0
        "RoleId": "4611686018427445962",
        "RoleName": "BK_QcsRole",
        "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"effect\":\"allow\",\"action\":\"name/sts:AssumeRole\",\"principal\":{\"service\":\"\"}}]}",
        "Description": "BlueKing accesses and manipulates your Tencent Cloud resources, including querying server information.",
        "AddTime": "2018-08-24 22:38:39",
        "UpdateTime": "2018-08-24 22:38:39",
        "ConsoleLogin": 0
        "RoleId": "4611686018427424559",
        "RoleName": "testroleName_1263",
        "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":[\"name/sts:AssumeRole\"],\"effect\":\"allow\",\"principal\":{\"qcs\":[\"qcs::cam::uin/2385420691:root\"]}}]}",
        "Description": "testiujjc",
        "AddTime": "2018-08-20 16:30:46",
        "UpdateTime": "2019-04-18 10:37:59",
        "ConsoleLogin": 1
    "TotalNum": 14,
    "RequestId": "a786b78c-ef8b-4331-b1e5-f287c8b41743"

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
InternalError.SystemError Internal error.
InvalidParameter.ParamError Invalid input parameter.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback