1. 接口描述
接口请求域名： ms.tencentcloudapi.com 。
获取云COS文件存储临时密钥，密钥仅限于临时上传文件，有访问限制和时效性，请保管好临时密钥。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateCosSecKeyInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-08。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| CosRegion | 否 | String | 地域信息，例如广州：ap-guangzhou，上海：ap-shanghai，默认为广州。 示例值：ap-guangzhou |
| Duration | 否 | Integer | 密钥有效时间，默认为1小时。 示例值：1200 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CosAppid | Integer | COS密钥对应的AppId 示例值：1258300000 |
| CosBucket | String | COS密钥对应的存储桶名 示例值：ms-shield |
| CosRegion | String | 存储桶对应的地域 示例值：ap-guangzhou |
| ExpireTime | Integer | 密钥过期时间 示例值：3600 |
| CosId | String | 密钥ID信息 示例值：XXXXzgG3O5Cm9ii31sTgph1XhFISnvKPw0Zi |
| CosKey | String | 密钥KEY信息 示例值：55VuqLWV4HKvuYom4tYkn6FdXpVoM7hz |
| CosPrefix | String | 密钥可访问的文件前缀人。例如：CosPrefix=test/123/666，则该密钥只能操作test/123/666为前缀的文件，例如test/123/666/1.txt 示例值：pctool/123456789/1542613158 |
| CosToken | String | 密钥TOCKEN信息 示例值：13606435fd46b2765dd01aa4eaf356dfca88817030001 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取COS临时密钥
获取COS临时密钥
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCosSecKeyInstance
<公共请求参数>
{
"CosRegion": "ap-guangzhou"
}输出示例
{
"Response": {
"CosAppid": 1,
"CosBucket": "ms-shield",
"CosRegion": "ap-guangzhou",
"ExpireTime": 1,
"CosId": "XXXXzgG3O5Cm9ii31sTgph1XhFISnvKPw0Zi",
"CosKey": "XXXXV4HKvuYom4tYkn6FdXpVoM7hz",
"CosPrefix": "pctool/123456789/1542613158",
"CosToken": "13606435fd46b2765dd01aa4eaf356dfxxxxxx",
"RequestId": "RequestId-xxxxxxx"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.InvalidAuthorization | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| InternalError.ServerError | 服务端无法响应。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation.AuthFailed | 鉴权失败。 |
