创建实例访问凭证

最近更新时间:2025-03-26 02:06:00

我的收藏

1. 接口描述

接口请求域名: tcr.tencentcloudapi.com 。

创建实例的临时或长期访问凭证

默认接口请求频率限制:100次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateInstanceToken。
Version String 公共参数,本接口取值:2019-09-24。
Region String 公共参数,详见产品支持的 地域列表
RegistryId String 实例Id
示例值:tcr-dg284imq
TokenType String 访问凭证类型,longterm 为长期访问凭证,temp 为临时访问凭证,默认是临时访问凭证,有效期1小时
示例值:longterm
Desc String 长期访问凭证描述信息
示例值:desc

3. 输出参数

参数名称 类型 描述
Username String 用户名
示例值:100036950234
Token String 访问凭证
示例值:eyJhbGciOiJIUzI1NiJ9.eyJvd25lclVpbiI6IjMzMjEzMzc5OTQifQ.v11fLhlg4p4Fdd0j5clQtARuT2ZPE7ErNX0VLvQ4IPo
ExpTime Integer 访问凭证过期时间戳,是一个时间戳数字,无单位
示例值:2051237057817
TokenId String 长期凭证的TokenId,短期凭证没有TokenId
示例值:ctrm3g86h7cp1kb7el2g
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取临时实例访问凭证

获取实例的临时访问凭证,有效期仅 1 小时,可用于临时登录。

输入示例

复制
复制成功
POST / HTTP/1.1
Host: tcr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstanceToken
<公共请求参数>

{
    "RegistryId": "tcr-dg284imq",
    "TokenType": "temp",
    "Desc": "desc"
}

输出示例

复制
复制成功
{
    "Response": {
        "ExpTime": 1735880997750,
        "RequestId": "bfa74e4d-3cc2-45a0-980c-08f7ec527737",
        "Token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlhETVk6VFVWTDo2SlRVOkxPSEE6M1VGVTozWFhJOlM3RkI6TlA3MjozTVYyOlRBQlQ6REdCQzpEQzNIIn0.eyJvd25lclVpbiI6IjMzMjEzMzc5OTQiLCJvcGVyYXRvclVpbiI6IjEwMDAzNjk1MDIzNCIsImV4cCI6MTczNTg4MDk5NywibmJmIjoxNzM1ODc3Mzk3LCJpYXQiOjE3MzU4NzczOTd9.vfgpeIog2z_cSTQnfWEh3jykmKNJ57b2hU-MciSuS3c9tiuju4Q-i_yPBjpDzHr-zymPsxmvFmyPV5Bxtv2UIvAfrk27ZnWUWf8xxF70D7BnY2PO6lSgUqGK0H2lw8HvYMq7JZjGk_q_eHcGQTLiY_-15HLNWjjL2Kvn5sybzaPx7-ZB4efa1WLOdB9rHQRwqmGuBaJaFTkpVZpJ0gRBF6hj7xq-ozjJVurXO1FFjC8DINJt0FvKt3U7VdhVAR2xTUHp54Dz4Q0Nynl5OoaBzYbVuobN5e_VerrYL-UAIu3PU3z7oZFNCCn3JeySbNThofubRW5M1DObxiPsjVSLdA",
        "TokenId": "",
        "Username": "100036950234"
    }
}

示例2 获取长期实例访问凭证

获取实例的长期有效的访问凭证,可用于第三方应用授权。

输入示例

复制
复制成功
POST / HTTP/1.1
Host: tcr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstanceToken
<公共请求参数>

{
    "RegistryId": "tcr-dg284imq",
    "TokenType": "longterm",
    "Desc": "desc"
}

输出示例

复制
复制成功
{
    "Response": {
        "ExpTime": 2051237057817,
        "RequestId": "116b7c24-58af-452a-9d91-bdfc988a56ec",
        "Token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlhETVk6VFVWTDo2SlRVOkxPSEE6M1VGVTozWFhJOlM3RkI6TlA3MjozTVYyOlRBQlQ6REdCQzpEQzNIIn0.eyJvd25lclVpbiI6IjMzMjEzMzc5OTQiLCJvcGVyYXRvclVpbiI6IjEwMDAzNjk1MDIzNCIsInRva2VuSWQiOiJjdHJtM2c4Nmg3Y3Axa2I3ZWwyZyIsImV4cCI6MjA1MTIzNzA1NywibmJmIjoxNzM1ODc3MDU3LCJpYXQiOjE3MzU4NzcwNTd9.PSZiX0ZAEvAo6lbhrUypAyII12hey2SE08pL4J5_7kBNJQdpSK-Ersw5YWuO1j90xXb6rWBuLPmCqUEA-Gg4Xla2yCWlT4eF2ls2HFKUlA8gxVoGmaFN3ww6yyImC4i1o9guPSUl2ggI3k_ohSkpaooDnKPpUzBDfqptgd-ZHrNAsqlNloQISggFzIhfZiR9c4rrnxp-a7_Q0phR24uY5X0C3lYQYYFDph-SlQ9BgFRGLBUw1IUcTVZ57uXLcFis9XsazFVyFvXtOUwGfHQ5DIb5B8mReJg7XKMgG1RfpsngSF-y0QR12OKIyNvHl8Ty-HXU-J0hDm1HWKDhM-mXcQ",
        "TokenId": "ctrm3g86h7cp1kb7el2g",
        "Username": "100036950234"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.DbError 数据库错误。
InternalError.Unknown 未知错误。
InvalidParameter 参数错误。
ResourceNotFound.TcrResourceNotFound Tcr实例中的资源未找到。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。

如果遇到产品相关问题,您可咨询 在线客服 寻求帮助。

返回顶部
可通过正文划词反馈文档内容问题,我们会快速处理并更新文档内容。