tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

GetRole

最后更新时间：2023-03-15 10:25:03

1. API Description

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

This API (GetRole) is used to get the details of a specified 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: GetRole.
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.
RoleId No String Role ID, used to specify role. Input either RoleId or RoleName
RoleName No String Role name, used to specify role. Input either RoleId or RoleName

3. Output Parameters

Parameter Name Type Description
RoleInfo RoleInfo Role details
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting role details

Input Example

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

{
    "RoleId": "4611686018427844696"
}

Output Example

{
    "Response": {
        "RoleInfo": {
            "RoleId": "4611686018427844696",
            "RoleName": "test_1234544",
            "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"name/sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"service\":[\"cloudaudit.cloud.tencent.com\",\"cls.cloud.tencent.com\"]}}]}",
            "Description": "abc",
            "AddTime": "2019-07-10 11:22:27",
            "UpdateTime": "2019-07-10 11:22:27",
            "ConsoleLogin": 0,
            "RoleType": "system",
            "SessionDuration": 43200,
            "DeletionTaskId": "114",
            "Tags": [
                {
                    "Value": "xx",
                    "Key": "xx"
                }
            ]
        },
        "RequestId": "87fb9770-0fca-4c5a-b985-1c36b05a95cb"
    }
}

Example2 Getting details of a service-linked role

Input Example

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

{
    "RoleId": "4611686018427411642"
}

Output Example

{
    "Response": {
        "RoleInfo": {
            "RoleId": "4611686018427411642",
            "RoleName": "byron3214_QcsRole",
            "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"service\":[\"ccslinked.qcloud.com\"]}}]}",
            "Description": "role222",
            "AddTime": "2020-03-25 11:03:00",
            "UpdateTime": "2020-03-25 11:03:00",
            "ConsoleLogin": 0,
            "RoleType": "service_linked",
            "SessionDuration": 43200,
            "DeletionTaskId": "114",
            "Tags": [
                {
                    "Value": "xx",
                    "Key": "xx"
                }
            ]
        },
        "RequestId": "1fb826eb-6d21-42f3-8f6e-9f51360f585d"
    }
}

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
InternalError.SystemError Internal error.
InvalidParameter.ParamError Invalid input parameter.
InvalidParameter.RoleNotExist Role does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款