有奖捉虫:云通信与企业服务文档专题,速来> HOT
文档中心 > API 中心 > 云硬盘 > 快照相关接口 > 查询云硬盘关联定期快照策略

1. 接口描述

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

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

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
TotalCount Integer 云盘绑定的定期快照数量。
示例值:0
AutoSnapshotPolicySet Array of AutoSnapshotPolicy 云盘绑定的定期快照列表。
示例值:[]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

通过云硬盘ID查询云硬盘绑定的定期快照策略

输入示例

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

输出示例

{
    "Response": {
        "AutoSnapshotPolicySet": [
            {
                "DiskIdSet": [],
                "IsActivated": true,
                "AdvancedRetentionPolicy": null,
                "IsCopyToRemote": 0,
                "IsPermanent": false,
                "AutoSnapshotPolicyState": "NORMAL",
                "NextTriggerTime": "2023-02-24 23:00:00",
                "AutoSnapshotPolicyName": "Orch-data-1h-3d",
                "AutoSnapshotPolicyId": "asp-3drodm1k",
                "CopyFromAccountUin": null,
                "InstanceIdSet": [],
                "RetentionAmount": 0,
                "RetentionDays": 3,
                "Policy": [
                    {
                        "DayOfWeek": [
                            0,
                            1,
                            2,
                            3,
                            4,
                            5,
                            6
                        ],
                        "Hour": [
                            0,
                            1,
                            2,
                            3,
                            4,
                            5,
                            6,
                            7,
                            8,
                            9,
                            10,
                            11,
                            12,
                            13,
                            14,
                            15,
                            16,
                            17,
                            18,
                            19,
                            20,
                            21,
                            22,
                            23
                        ]
                    }
                ],
                "RetentionMonths": 0,
                "CreateTime": "2023-02-15 16:56:04",
                "CopyToAccountUin": null
            }
        ],
        "TotalCount": 1,
        "RequestId": "a9f6fd41-242f-4053-89c2-73ac5465ed9c"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
UnsupportedOperation 操作不支持。