查询定期快照策略

最近更新时间:2019-07-26 19:00:18

1. 接口描述

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

本接口(DescribeAutoSnapshotPolicies)用于查询定期快照策略。

  • 可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器Filter
  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的定期快照策略表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAutoSnapshotPolicies
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的 地域列表
AutoSnapshotPolicyIds.N Array of String 要查询的定期快照策略ID列表。参数不支持同时指定AutoSnapshotPolicyIdsFilters
Filters.N Array of Filter 过滤条件。参数不支持同时指定AutoSnapshotPolicyIdsFilters
  • auto-snapshot-policy-id - Array of String - 是否必填:否 -(过滤条件)按定期快照策略ID进行过滤。定期快照策略ID形如:asp-11112222
  • auto-snapshot-policy-state - Array of String - 是否必填:否 -(过滤条件)按定期快照策略的状态进行过滤。定期快照策略ID形如:asp-11112222。(NORMAL:正常 | ISOLATED:已隔离。)
  • auto-snapshot-policy-name - Array of String - 是否必填:否 -(过滤条件)按定期快照策略名称进行过滤。
  • Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考API简介中的相关小节。
    Order String 输出定期快照列表的排列顺序。取值范围:
  • ASC:升序排列
  • DESC:降序排列。
  • OrderField String 定期快照列表排序的依据字段。取值范围:
  • CREATETIME:依据定期快照的创建时间排序
    默认按创建时间排序。
  • 3. 输出参数

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

    4. 示例

    示例1 查询状态为NORMAL的定期快照策略

    输入示例

    https://cbs.tencentcloudapi.com/?Action=DescribeAutoSnapshotPolicies
    &Filters.0.Name=auto-snapshot-policy-state
    &Filters.0.Values.0=NORMAL
    &Limit=3
    &Offset=0
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "AutoSnapshotPolicySet": [
          {
            "DiskIdSet": [],
            "IsActivated": 1,
            "AutoSnapshotPolicyState": "NORMAL",
            "AutoSnapshotPolicyName": "快照策略1",
            "IsPermanent": 0,
            "NextTriggerTime": "2017-12-04 12:00:00",
            "AutoSnapshotPolicyId": "asp-lfp6fi4f",
            "Policy": [
              {
                "DayOfWeek": [
                  1,
                  4
                ],
                "Hour": [
                  12
                ]
              }
            ],
            "CreateTime": "2017-11-01 10:46:22",
            "RetentionDays": 7
          },
          {
            "DiskIdSet": [],
            "IsActivated": 1,
            "AutoSnapshotPolicyState": "NORMAL",
            "AutoSnapshotPolicyName": "快照策略2",
            "IsPermanent": 0,
            "NextTriggerTime": "2017-12-03 10:00:00",
            "AutoSnapshotPolicyId": "asp-nqu08k2l",
            "Policy": [
              {
                "DayOfWeek": [
                  0
                ],
                "Hour": [
                  10
                ]
              }
            ],
            "CreateTime": "2017-11-17 15:01:25",
            "RetentionDays": 7
          }
        ],
        "TotalCount": 2,
        "RequestId": "701c8a35-ed66-fc79-3795-5a1fa72cdbf1"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

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