文档中心 API 中心 云硬盘 快照相关接口 查询云硬盘关联定期快照策略

查询云硬盘关联定期快照策略

最近更新时间:2019-07-24 15:06:49

1. 接口描述

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

本接口(DescribeDiskAssociatedAutoSnapshotPolicy)用于查询云盘绑定的定期快照策略。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cbs.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDiskAssociatedAutoSnapshotPolicy
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的 地域列表
DiskId String 要查询的云硬盘ID。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 云盘绑定的定期快照数量。
AutoSnapshotPolicySet Array of AutoSnapshotPolicy 云盘绑定的定期快照列表。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询云盘disk-dw0bbzws绑定的定期快照策略

输入示例

https://cbs.tencentcloudapi.com/?Action=DescribeDiskAssociatedAutoSnapshotPolicy
&DiskId=disk-dw0bbzws
&<公共请求参数>

输出示例

{
  "Response": {
    "AutoSnapshotPolicySet": [
      {
        "IsActivated": 1,
        "AutoSnapshotPolicyName": "sds",
        "IsPermanent": 0,
        "NextTriggerTime": "2017-12-03 00:00:00",
        "AutoSnapshotPolicyId": "asp-mrsrn243",
        "Policy": [
          {
            "DayOfWeek": [
              0
            ],
            "Hour": [
              0
            ]
          }
        ],
        "CreateTime": "2017-11-17 15:09:12",
        "RetentionDays": 7
      }
    ],
    "TotalCount": 1,
    "RequestId": "8612f14a-fd07-85b5-39f9-5a1fa51efa14"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
MissingParameter 参数缺失。请求没有带必选参数。