修改定期快照策略信息

最近更新时间: 2024-06-18 14:31:18

1. 接口描述

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

本接口(ModifyAutoSnapshotPolicyAttribute)用于修改定期快照策略属性。

  • 可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。
  • 修改保留天数时必须保证不与是否永久保留属性冲突,否则整个操作失败,以特定的错误码返回。

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

接口更新时间:2018-04-18 16:54:53。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:ModifyAutoSnapshotPolicyAttribute
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表(TODO)
AutoSnapshotPolicyId String 定期快照策略ID。
Policy Array of Policy 定期快照的执行策略。
AutoSnapshotPolicyName String 要创建的定期快照策略名。不传则默认为“未命名”。最大长度不能超60个字节。
IsActivated Bool 是否激活定期快照策略,FALSE表示未激活,TRUE表示激活,默认为TRUE。
IsPermanent Bool 通过该定期快照策略创建的快照是否永久保留。FALSE表示非永久保留,TRUE表示永久保留,默认为FALSE。
RetentionDays Uint64 通过该定期快照策略创建的快照保留天数,该参数不可与IsPermanent参数冲突,即若定期快照策略设置为永久保留,RetentionDays应置0。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameterValue
MissingParameter
InvalidSnapshot.NotSupported
InvalidAutoSnapshotPolicyId.NotFound