云开发 CloudBase 为环境池里的环境申请角色临时凭证

1. 接口描述

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

白名单接口，申请Tcb角色临时凭证

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：AssumeRoleForAllocatedEnv。
Version	是	String	公共参数，本接口取值：2018-06-08。
Region	否	String	公共参数，本接口不需要传递此参数。
EnvId	是	String	环境ID 示例值：mpdemo-d6ga2156e93c0228c

3. 输出参数

参数名称	类型	描述
SecretId	String	SecretId 示例值：AKI*
SecretKey	String	SecretKey 示例值：V4m*
Token	String	Token值注意：此字段可能返回 null，表示取不到有效值。示例值：A6ABa1wqZnAFi95JuQ7BIgWqU8Im5YPa283df148910f67e4cb0789f5783133b4zHqyBHG
ExpiredTime	Integer	过期时间戳注意：此字段可能返回 null，表示取不到有效值。示例值：1778249652
IsCache	Boolean	是否从缓存中加载。标明该值是否实时从sts服务获取，还是从缓存中获取。调用方可不关心示例值：false
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取环境对应的临时密钥

输入示例

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

{
    "EnvId": "mpdemo-d6ga2156e93c0228c"
}

输出示例

{
    "Response": {
        "ExpiredTime": 1778249652,
        "IsCache": false,
        "SecretId": "AKI*****************************************************************",
        "SecretKey": "V4m*****************************************",
        "Token": "A6ABa1wqZnAFi95JuQ7BIgWqU8Im5YPa283df148910f67e4cb0789f5783133b4zHqyBHG_9fFGP1hqbOgzW4_f9P8vAUhxq6HpuxsWfSkJH5_qOUWwQiILad6W1zBDo-hFSyVoGPnwglEbflbwbpc6QQE5sjwq3ZAbfWmhVMZQB2RPqmJz3Gm0F-qKCsZjFAWn6xtmset1Md4CySETuQ2A-IsDC1tfQGEPMYOWW_X7IFchndIoLmqccAi27dJihlB_g7Bp009y7QCFICWFJdJ9uKzFdRu_A6FeXfvQGFGbPiMhYmo0LujgYHPOhYNZLMNbx7MdYoAh5lXCGodqKbu3S8z3GTYNftRHAUKxWC562IQ1QnyMyBEmUxNLabFsvefyYf_i27ZK1re4-xRfjF******************************************",
        "RequestId": "b07ee256-5624-4ce1-92ac-cc12d2a792ab"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。

为环境池里的环境申请角色临时凭证

本页目录：