查询云硬盘关联快照信息

最近更新时间: 2026-11-06 00:09:12

1. 接口描述

接口请求域名: cbs.api3.fincloud.tencent.cn。

本接口(DescribeDiskAssociatedSnapshots)用于查询云盘关联的快照。

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

接口更新时间:2026-01-21 15:11:39。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:DescribeDiskAssociatedSnapshots
Version 是 否 String 公共参数,本接口取值:2017-03-12
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
DiskId 是 否 String 要查询的云硬盘ID。
示例值: "disk-abcd1234"
Offset 否 否 Uint64 偏移量,默认为0。
示例值: 0
Limit 否 否 Uint64 返回数量,默认为20,最大值为100。
示例值: 20

3. 输出参数

参数名称 类型 描述
SnapshotSet Array of Snapshot 云盘关联的快照列表
示例值:查看
TotalSnapSize Uint64 云盘关联的快照总大小
示例值: 100
TotalCount Uint64 云盘关联的快照总数量
示例值: 1
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。

5. 示例

示例1 查询云盘disk-dw0bbzws关联的快照

输入示例

https://cbs.api3.fincloud.tencent.cn/?Action=DescribeDiskAssociatedSnapshots
&DiskId=disk-dw0bbzws
&<Common Parameters>

输出示例

{
    "Response": {
        "TotalSnapSize": 6562,
        "TotalCount": 1,
        "RequestId": "55db49cf-b9d7-da27-825b-5a02ba0006",
        "SnapshotSet": [
            {
                "Placement": {
                    "ProjectId": 0,
                    "Zone": "ap-region1-3"
                },
                "CopyFromRemote": false,
                "IsPermanent": true,
                "DiskUsage": "SYSTEM_DISK",
                "DeadlineTime": "",
                "Percent": 100,
                "SnapshotId": "snap-ff5o8ivn",
                "ShareReference": 0,
                "SnapshotType": "PRIVATE_SNAPSHOT",
                "DiskSize": 50,
                "DiskId": "disk-dw0bbzws",
                "SnapshotName": "name1",
                "Images": [],
                "CopyingToRegions": [],
                "Encrypt": false,
                "CreateTime": "2019-08-01 10:54:52",
                "ImageCount": 0,
                "SnapshotState": "NORMAL"
            }
        ]
    }
}