1. 接口描述
接口请求域名: cloudstudio.tencentcloudapi.com 。
创建工作空间临时访问凭证,重复调用会创建新的 Token,旧的 Token 将会自动失效
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateWorkspaceToken。 |
Version | 是 | String | 公共参数,本接口取值:2023-05-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SpaceKey | 是 | String | 工作空间 SpaceKey 示例值:knhwex |
TokenExpiredLimitSec | 否 | Integer | token过期时间,单位是秒,默认 3600 示例值:3600 |
Policies.N | 否 | Array of String | token 授权策略,可选值为 workspace-run-only, all。默认为 workspace-run-only 示例值:["workspace-run-only"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Token | String | 访问工作空间临时凭证 示例值:83c99d6a03aa94f5e7bbfb4eded0de0b1153f44d05126d34b5f36e8343eca973 |
ExpiredTime | String | token 过期时间 示例值:2023-02-13T12:33:48 GMT+08:00 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 为工作空间创建临时访问凭证
为工作空间创建临时访问凭证,重复调用会创建新的 Token,旧的 Token 将会自动失效
输入示例
POST / HTTP/1.1
Host: cloudstudio.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWorkspaceTemporaryToken
<公共请求参数>
{
"SpaceKey": "bpwsmb",
"TokenExpiredLimitSec": 3600,
"Policies": [
"workspace-run-only"
]
}
输出示例
{
"Response": {
"Token": "83c99d6a03aa94f5e7bbfb4eded0de0b1153f44d05126d34b5f36e8343eca973",
"ExpiredTime": "2023-02-13T12:33:48 GMT+08:00",
"RequestId": "6e1e1482-cfe6-4462-a508-4fc7053a0c78"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue | 参数取值错误。 |