查询备份仓库

最近更新时间:2024-03-12 01:56:57

我的收藏

1. 接口描述

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

查询备份仓库信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBackupStorageLocations。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,此参数为可选参数。
Names.N Array of String 多个备份仓库名称,如果不填写,默认返回当前地域所有存储仓库名称
示例值:["test-1"]

3. 输出参数

参数名称 类型 描述
BackupStorageLocationSet Array of BackupStorageLocation 详细备份仓库信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询备份仓库

查询备份仓库信息

输入示例

POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupStorageLocations
<公共请求参数>

{
    "Names": [
        "abc"
    ]
}

输出示例

{
    "Response": {
        "BackupStorageLocationSet": [
            {
                "Name": "abc",
                "StorageRegion": "ap-guangzhou",
                "Provider": "tencentcloud",
                "Bucket": "tke-backup-xx",
                "Path": "",
                "State": "Available",
                "Message": "",
                "LastValidationTime": "2023-04-07T03:18:10Z"
            }
        ],
        "RequestId": "05670c78-3fa8-42c8-87ac-e6b06d0f1f96"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数错误。
ResourceUnavailable 资源不可用。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。