1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
创建备份仓库,指定了存储仓库类型(如COS)、COS桶地区、名称等信息,当前最多允许创建100个仓库, 注意此接口当前是全局接口,多个地域的TKE集群如果要备份到相同的备份仓库中,不需要重复创建备份仓库
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateBackupStorageLocation。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
StorageRegion | 是 | String | 存储仓库所属地域,比如COS广州(ap-guangzhou) 示例值:ap-guangzhou |
Bucket | 是 | String | 对象存储桶名称,如果是COS必须是tke-backup前缀开头 示例值:tke-backup-test |
Name | 是 | String | 备份仓库名称 示例值:tke-storage-backup |
Provider | 否 | String | 存储服务提供方,默认腾讯云 示例值:tencentcloud |
Path | 否 | String | 对象存储桶路径 示例值:tke |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建TKE存储仓库
创建TKE存储仓库
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBackupStorageLocation
<公共请求参数>
{
"StorageRegion": "ap-guangzhou",
"Bucket": "tke-backup-test",
"Name": "tke-storage-backup",
"Provider": "tencentcloud",
"Path": "tke"
}
输出示例
{
"Response": {
"RequestId": "6b4cf747-ecfb-42ae-a1fb-a0132353c80b"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
LimitExceeded | 超过配额限制。 |
ResourceUnavailable | 资源不可用。 |
UnknownParameter | 未知参数错误。 |