文档

UpdatePolicyV2 - 修改策略

更新时间:

修改一个策略。

接口说明

策略的修改,将对所有绑定的数据源生效,请谨慎操作。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hbr:UpdatePolicyV2
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PolicyIdstring

策略 ID。

po-000************viy
PolicyNamestring

策略名称。

每天备份 + 异地备份
PolicyDescriptionstring

策略描述。

每天早上10点备份一次,异地备份到上海。
Rulesarray<object>

策略规则列表。

object

策略规则。

RuleIdstring

规则 ID。

rule-000************rof
RuleTypestring

规则类型,每一个策略需要至少有一个 BACKUP 类型规则,有且仅有一个 TRANSITION 类型规则:

  • BACKUP:备份规则。
  • TRANSITION:生命周期规则。
  • REPLICATION:复制规则。
BACKUP
Schedulestring

仅当 RuleType 取值为 BACKUP 时,需要配置该参数。备份定时设置。可选格式:I|{startTime}|{interval}。表示从{startTime}开始每隔{interval}的时间执行一次备份任务。不会补偿已过去时间的备份任务。如果上一次备份任务没有完成,不会触发下一次备份任务。例如I|1631685600|P1D表示从 2021-09-15 14:00:00 开始每隔一天备份一次。

  • startTime:备份起始时间,UNIX 时间,单位为秒。
  • interval: ISO8601 时间间隔。例如:PT1H 表示间隔一小时。P1D 表示间隔一天。
I|1648647166|P1D
BackupTypestring

仅当 RuleType 取值为 BACKUP 时,需要配置该参数。备份类型。取值为 COMPLETE,表示全量备份。

COMPLETE
Retentionlong

仅当 RuleType 取值为 TRANSITIONREPLICATION 时,需要配置该参数。

  • RuleType 取值为 TRANSITION:备份保留时间,最小值为 1,单位为天。
  • RuleType 取值为 REPLICATION:异地备份保留时间,最小值为 1,单位为天。
7
ReplicationRegionIdstring

仅当 RuleType 取值为 REPLICATION 时,需要配置该参数。复制的目标地域 ID。

cn-shanghai
ArchiveDayslong

仅当 RuleType 取值为 TRANSITION 时,需要配置该参数。备份转为归档的时间,单位为天。

90
ColdArchiveDayslong

仅当 RuleType 取值为 TRANSITION 时,需要配置该参数。备份转为冷归档的时间,单位为天。

365
RetentionRulesarray<object>

仅当 RuleType 取值为 TRANSITION 时,需要配置该参数。特殊保留规则。

object

特殊保留规则。

AdvancedRetentionTypestring

特殊保留规则类型:

  • WEEKLY:每周的备份
  • MONTHLY:每月的备份
  • YEARLY:每年的备份
YEARLY
WhichSnapshotlong

针对第几个备份生效,当前仅支持第 1 个备份,值为 1。

1
Retentionlong

备份的特殊保留时间,最小值为 1,单位为天。

365
KeepLatestSnapshotslong

是否开启保留至少一个备份版本。

  • 0 - 不保留
  • 1 - 保留
1

返回参数

名称类型描述示例值
object

UpdatePolicyResponse

Successboolean

请求是否成功。

  • true:成功。
  • false:失败。
true
Codestring

返回码,200 表示成功。

200
Messagestring

返回信息描述,成功一般返回 successful,错误时会返回相应错误信息。

successful
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-18API 内部配置变更,不影响调用查看变更详情
2024-02-21API 内部配置变更,不影响调用查看变更详情
2023-03-29API 内部配置变更,不影响调用查看变更详情