查看云硬盘备份点列表

最近更新时间:2024-06-04 01:54:26

我的收藏

1. 接口描述

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

本接口(DescribeDiskBackups)用于查询云硬盘备份点的详细信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDiskBackups。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
DiskBackupIds.N Array of String 查询的云硬盘备份点ID列表。最大支持 100 个。参数不支持同时指定 DiskBackupIds 和 Filters。
示例值:["lhbak-nuen5foj"]
Filters.N Array of Filter 过滤器列表。
  • disk-backup-id
  • 按照【云硬盘备份点 ID】进行过滤。
    类型:String
    必选:否
  • disk-id
  • 按照【云硬盘 ID】进行过滤。
    类型:String
    必选:否
  • disk-backup-state
  • 按照【云硬盘备份点状态】进行过滤。
    类型:String
    必选:否
    取值:参考数据结构
    DescribeSnapshots 下的DiskBackupState取值。
  • disk-usage
  • 按照【云硬盘类型】进行过滤。
    类型:String
    必选:否
    取值:SYSTEM_DISK或DATA_DISK
    每次请求的 Filters 的上限为 10,Filter.Values 的上限为5。参数不支持同时指定DiskBackupIds 和 Filters。
    Offset Integer 偏移量,默认为 0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    示例值:0
    Limit Integer 返回数量,默认为 20,最大值为 100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    示例值:1

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 云硬盘备份点的数量。
    示例值:1
    DiskBackupSet Array of DiskBackup 云硬盘备份点信息列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查看云硬盘备份点列表

    查看云硬盘备份点列表

    输入示例

    POST / HTTP/1.1
    Host: lighthouse.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeDiskBackups
    <公共请求参数>
    
    {
        "DiskBackupIds": [
            "lhbak-nuen5foj"
        ]
    }

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "DiskBackupSet": [
                {
                    "DiskBackupId": "lhbak-nuen5foj",
                    "DiskUsage": "DATA_DISK",
                    "DiskId": "lhdisk-nbebddz8",
                    "DiskSize": 200,
                    "DiskBackupName": "lhdisk-nbebddz8-data-disk-062317",
                    "DiskBackupState": "ROLLBACKING",
                    "Percent": 100,
                    "LatestOperation": "ApplyDiskBackup",
                    "LatestOperationState": "OPERATING",
                    "LatestOperationRequestId": "41c963ec-5e49-4454-8f98-b3f008958eb9",
                    "CreatedTime": "2022-06-23T09:19:05Z"
                }
            ],
            "RequestId": "67a6539c-c9b3-453d-9ba4-9024e0e05f31"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InvalidParameter.InvalidFilter 参数非法,Filter 参数非法。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.DiskBackupIdMalformed 参数值非法,云硬盘备份点 ID 格式非法。
    InvalidParameterValue.InvalidDiskIdMalformed 参数值非法,磁盘 ID 格式非法。
    UnauthorizedOperation.NoPermission 无权限。