租户端 存储 云硬盘(CBS) 快照相关接口 查询跨账号复制自动快照策略详情

查询跨账号复制自动快照策略详情

最近更新时间: 2026-11-07 00:09:04

1. 接口描述

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

查询跨账号复制自动快照策略详情

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

接口更新时间:2024-09-30 06:57:37。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:DescribeCopyAutoSnapshotPolicy
Version 是 否 String 公共参数,本接口取值:2017-03-12
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
OrderField 否 否 String 定期快照列表排序的依据字段. CREATETIME:依据定期快照的创建时间排序,默认按创建时间排序
示例值: ASC
CopyAction 是 否 String 自动快照策略复制动作,REMOTE: 备份至其他账户; LOCAL: 备份至我的账户
示例值: REMOTE
AutoSnapshotPolicyIds 否 否 Array of String 要查询的定期快照策略ID列表.参数不支持同时指定AutoSnapshotPolicyIds和Filters。
示例值: ["asp-xxxxxxxx"]
Limit 否 否 Uint64 返回数量, 默认为20, 最大值为100
示例值: 20
Filters 否 否 Array of Filter 过滤条件,参数不支持同时指定AutoSnapshotPolicyIds和Filters。  auto-snapshot-policy-id - Array of String - 是否必填:否 -(过滤条件)按定期快照策略ID进行过滤。定期快照策略ID形如:asp-11112222。 auto-snapshot-policy-state - Array of String - 是否必填:否 -(过滤条件)按定期快照策略的状态进行过滤。定期快照策略ID形如:asp-11112222。(NORMAL:正常 
Offset 否 否 Uint64 偏移量, 默认为0.
示例值: 0
Order 否 否 String 输出定期快照列表的排列顺序.ASC:升序排列 DESC:降序排列。
示例值: CREATE_TIME

3. 输出参数

参数名称 类型 描述
TotalCount Uint64 有效的定期快照策略数量
示例值: 10
CopyAutoSnapshotPolicySet Array of AutoSnapshotPolicy 跨账号复制的定期快照策略列表
示例值:查看
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
MissingParameter 参数缺失。请求没有带必选参数。
InvalidFilter 指定的Filter不被支持。
ResourceBusy 资源繁忙,请稍后重试。
InvalidParameter 参数错误

5. 示例

示例1 查询跨账号复制的自动快照策略

查询跨账号复制的自动快照策略

输入示例

https://cbs.api3.fincloud.tencent.cn/?Action=DescribeCopyAutoSnapshotPolicy
&CopyAction=REMOTE
&<Common Parameters>

输出示例

{
  "Response": {
    "TotalCount": 1,
    "CopyAutoSnapshotPolicySet": [
      {
        "DiskIdSet": [
          "abc"
        ],
        "IsActivated": true,
        "AutoSnapshotPolicyState": "abc",
        "IsCopyToRemote": 1,
        "IsPermanent": true,
        "NextTriggerTime": "2020-09-22 00:00:00",
        "AutoSnapshotPolicyName": "abc",
        "AutoSnapshotPolicyId": "abc",
        "Policy": [
          {
            "DayOfWeek": [
              1
            ],
            "DayOfMonth": [
              1
            ],
            "IntervalDays": 1,
            "Hour": [
              1
            ],
            "Minute": [
              1
            ]
          }
        ],
        "CreateTime": "2020-09-22 00:00:00",
        "RetentionDays": 1,
        "CopyToAccountUin": "abc",
        "InstanceIdSet": [
          "abc"
        ],
        "RetentionMonths": 1,
        "RetentionAmount": 1,
        "AdvancedRetentionPolicy": {
          "Days": 1,
          "Weeks": 1,
          "Months": 1,
          "Years": 1
        },
        "IsCrossRegion": true,
        "DestinationRegions": [
          "abc"
        ],
        "CrossRegionIsPermanent": true,
        "CrossRegionRetentionDays": 0,
        "CopyFromAccountUin": "abc",
        "Tags": [
          {
            "Key": "abc",
            "Value": "abc"
          }
        ]
      }
    ],
    "RequestId": "abc"
  }
}