tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeRoleList

Last updated: 2023-03-15 10:25:04

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 Params. The value used for this API: DescribeRoleList.
Version Yes String Common Params. The value used for this API: 2019-01-16.
Region No String Common Params. 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
Tags.N No Array of RoleTags A parameter used to filter the list of roles under a tag.

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

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

{
    "Rp": "5",
    "Page": "1"
}

Output Example

{
    "Response": {
        "List": [
            {
                "AddTime": "2020-11-28 10:05:52",
                "ConsoleLogin": 0,
                "DeletionTaskId": null,
                "Description": "The current role is the TencentCloud Automation Tools (TAT) service-linked role, and it will access your other Tencent Cloud resources within the permissions granted by the associated policies.",
                "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"service\":[\"command.tat.cloud.tencent.com\"]}}]}",
                "RoleId": "4611686018433460000",
                "RoleName": "TAT_QCSLinkedRoleInCommand",
                "RoleType": "service_linked",
                "SessionDuration": 43200,
                "Tags": [],
                "UpdateTime": "2020-11-28 10:05:52"
            },
            {
                "AddTime": "2020-06-28 12:07:06",
                "ConsoleLogin": 0,
                "DeletionTaskId": null,
                "Description": "The current role is the CVM service-linked role, and it will access your other Tencent Cloud resources within the permissions granted by the associated policies.",
                "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"service\":[\"cvmsmartdiagnostic.cvm.cloud.tencent.com\"]}}]}",
                "RoleId": "4611686018432380000",
                "RoleName": "CVM_QCSLinkedRoleInCVMSmartDiagnostic",
                "RoleType": "service_linked",
                "SessionDuration": 43200,
                "Tags": [
                    {
                        "Key": "K1",
                        "Value": "V7"
                    }
                ],
                "UpdateTime": "2020-06-28 12:07:06"
            }
        ],
        "RequestId": "36d78422-f6ce-4edb-a5a0-a217b366aa70",
        "TotalNum": 2
    }
}

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

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.
InternalError.SystemError Internal error.
InvalidParameter.ParamError Invalid input parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy