当前位置:主页 > 查看内容

容器镜像服务 创建实例访问凭证 - API 文档

发布时间:2021-09-18 00:00| 位朋友查看

简介:1. 接口描述 接口请求域名: tcr.tencentcloudapi.com 。 创建实例的临时或长期访问凭证 默认接口请求频率限制:20次/秒。 注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时……

1. 接口描述

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

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tcr.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateInstanceToken。
Version String 公共参数,本接口取值:2019-09-24。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, eu-frankfurt, eu-moscow, na-ashburn, na-siliconvalley
RegistryId String 实例Id
TokenType String 访问凭证类型,longterm 为长期访问凭证,temp 为临时访问凭证,默认是临时访问凭证,有效期1小时
Desc String 长期访问凭证描述信息

3. 输出参数

参数名称 类型 描述
Username String 用户名
注意:此字段可能返回 null,表示取不到有效值。
Token String 访问凭证
ExpTime Integer 访问凭证过期时间戳
TokenId String 长期凭证的TokenId,短期凭证没有TokenId
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

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

输入示例

https://tcr.tencentcloudapi.com/?Action=CreateInstanceToken
&RegistryId=tcr-ak9876
&TokenType=temp
&<公共请求参数>

输出示例

{
  "Response": {
    "Username": 12345678,
    "Token": "XXXX",
    "ExpTime": "33987631",
    "RequestId": "xx",
    "TokenId": "xx"
  }
}

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

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

输入示例

https://tcr.tencentcloudapi.com/?Action=CreateInstanceToken
&RegistryId=tcr-ak9876
&TokenType=longterm
&Desc=for-tke-cluster
&<公共请求参数>

输出示例

{
  "Response": {
    "Username": 12345678,
    "Token": "XXXX",
    "ExpTime": "33987631",
    "RequestId": "xx",
    "TokenId": "1456976"
  }
}

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
  • Tencent Cloud SDK 3.0 for Java
  • Tencent Cloud SDK 3.0 for PHP
  • Tencent Cloud SDK 3.0 for Go
  • Tencent Cloud SDK 3.0 for NodeJS
  • Tencent Cloud SDK 3.0 for .NET
  • Tencent Cloud SDK 3.0 for C++
  • Tencent Cloud SDK 3.0 for Ruby

命令行工具

  • Tencent Cloud CLI 3.0

6. 错误码

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

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

本站部分内容转载于网络,版权归原作者所有,转载之目的在于传播更多优秀技术内容,如有侵权请联系QQ/微信:153890879删除,谢谢!
上一篇:StopNodes - 弹性高性能计算E-HPC 下一篇:没有了

推荐图文

  • 周排行
  • 月排行
  • 总排行

随机推荐