安全凭证服务
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 安全凭证服务 > API文档 > STS相关接口 > 申请扮演角色临时访问凭证

申请扮演角色临时访问凭证

最近更新时间：2024-03-12 01:48:31

我的收藏

本页目录：

1. 接口描述

接口请求域名： sts.tencentcloudapi.com 。

申请扮演角色临时访问凭证。

1、角色策略组成

（1）角色信任策略：指定谁可以扮演该角色；

（2）角色权限策略：指定扮演角色后可以执行哪些操作。

2、角色可扮演条件

（1）给用户绑定允许调用AssumeRole的策略 ；

（2）将用户添加为角色信任策略中的主体。

默认接口请求频率限制：600次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：AssumeRole。
Version 是 String 公共参数，本接口取值：2018-08-13。
Region 是 String 公共参数，详见产品支持的 地域列表。
RoleArn 是 String 角色的资源描述，可在访问管理，点击角色名获取。
普通角色：
qcs::cam::uin/12345678:role/4611686018427397919、qcs::cam::uin/12345678:roleName/testRoleName
服务角色：
qcs::cam::uin/12345678:role/tencentcloudServiceRole/4611686018427397920、qcs::cam::uin/12345678:role/tencentcloudServiceRoleName/testServiceRoleName
示例值：qcs%3A%3Acam%3A%3Auin%2F2385420691%3Arole%2F4611686018427397919
RoleSessionName 是 String 临时会话名称，由用户自定义名称。
长度在2到128之间，可包含大小写字符，数字以及特殊字符：=,.@-。 正则为：[\w+=,.@-]*
示例值：cts
DurationSeconds 否 Integer 指定临时访问凭证的有效期，单位：秒，默认 7200 秒，最长可设定有效期为 43200 秒
示例值：1800
Policy 否 String 策略描述
注意：
1、该参数需要做urlencode，服务端会对该字段做urldecode， 并按处理后Policy授予临时访问凭证权限，请按规范传入参数。（如果通过 GET 方法请求云 API，发送请求前，所有参数都需要按照云 API 规范再 urlencode 一次）。
2、策略语法参照 CAM 策略语法。
3、策略中不能包含 principal 元素。
ExternalId 否 String 角色外部ID，可在访问管理，点击角色名获取。
长度在2到128之间，可包含大小写字符，数字以及特殊字符：=,.@:/-。 正则为：[\w+=,.@:/-]*
示例值：role-1232
Tags.N 否 Array of Tag 会话标签列表。最多可以传递 50 个会话标签，不支持包含相同标签键。
SourceIdentity 否 String 调用者身份uin
示例值：1000001

3. 输出参数

参数名称 类型 描述
Credentials Credentials 临时访问凭证
ExpiredTime Integer 临时访问凭证的过期时间，返回 Unix 时间戳，精确到秒
示例值：1543914376
Expiration String 临时访问凭证的过期时间，以 iso8601 格式的 UTC 时间表示
示例值：2018-12-04T09:06:16Z
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 申请扮演角色临时访问凭证

申请扮演角色临时访问凭证

输入示例

POST / HTTP/1.1
Host: sts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssumeRole
<公共请求参数>

{
    "RoleArn": "qcs%3A%3Acam%3A%3Auin%2F2385420691%3Arole%2F4611686018427397919",
    "RoleSessionName": "cts"
}

输出示例

{
    "Response": {
        "Credentials": {
            "Token": "da1e9d2ee9d***2dfe340001",
            "TmpSecretId": "AKID65zyIP0mpXtaI******WIQVMn1umNH58",
            "TmpSecretKey": "q95K84wrzuEGoc*******52boxvp71yoh"
        },
        "ExpiredTime": 1543914376,
        "Expiration": "2018-12-04T09:06:16Z",
        "RequestId": "4daec797-9cd2-4f09-9e7a-7d4c43b2a74c"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
InternalError.DbError DB错误。
InternalError.EncryptError 加密失败。
InternalError.GetAppIdError 获取appid错误。
InternalError.GetRoleError 获取角色失败。
InternalError.GetSeedTokenError 获取token失败。
InternalError.IllegalRole 角色非法。
InternalError.PbSerializeError pb打包失败。
InternalError.SystemError 系统内部错误，如网络错误。
InternalError.UnknownError 未知错误。
InvalidParameter.AccountNotAvaliable 账号不存在或不可用。
InvalidParameter.ExtendStrategyOverSize 扩展策略过大。
InvalidParameter.GrantOtherResource 越权访问资源。
InvalidParameter.OverLimit 超过频率限制。
InvalidParameter.OverTimeError 过期时间超过阈值。
InvalidParameter.ParamError 参数错误。
InvalidParameter.PolicyTooLong 策略过长。
InvalidParameter.ResouceError 策略资源六段式错误。
InvalidParameter.StrategyFormatError 策略语法错误。
InvalidParameter.StrategyInvalid 非法策略。
InvalidParameter.TempCodeNotAvaliable 临时Code无效。
ResourceNotFound.RoleNotFound 账号对应的角色不存在。
UnauthorizedOperation 未授权操作。
UnsupportedOperation 操作不支持。
中国站