Tencent Cloud

search by keyword

Recent Pages

Documentation

DescribeRoleList

Last updated: 2020-07-03 12:07:43

1. API Description

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

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 the role List

Input Example

https://cam.tencentcloudapi.com/?Action=DescribeRoleList
&Page=1
&Rp=5
&<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\":[\"cloudaudit.cloud.tencent.com\"]}}]}",
                “Description”: “CloudAudit (CA)‘s tracking set creation authorization includes permissions to query and create Cloud Object Storage (COS) buckets as well as CMQ message queues. This enables CloudAudit to deliver tracking logs to COS and send CMQ notifications.”,
                "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\":\"blueking.cloud.tencent.com\"}}]}",
                “Description”: “This permission enables BlueKing autonomous OPS platform to access your Tencent Cloud resources and query 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

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.