文档

DescribePoliciesV2 - 查询一个或多个策略

更新时间:

查询一个或多个策略。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

获取下一页策略所需的 Token。

caeba0bbb2be03f84eb48b699f0a
MaxResultsinteger

每次查询结果的个数。

取值范围:10~100。默认值:10。

10
PolicyIdstring

策略 ID。

po-000************2l6

返回参数

名称类型描述示例值
object

DescribePoliciesResponse

Policiesobject []

策略列表。

CreatedTimelong

创建时间。UNIX 时间,单位秒。

1650248136
UpdatedTimelong

更新时间。UNIX 时间,单位为秒。

1662080404
PolicyIdstring

策略 ID。

po-000************bkz
PolicyNamestring

策略名称。

每天备份 + 异地备份
PolicyDescriptionstring

策略描述。

每天早上十点备份,异地复制到上海。
Rulesobject []

策略规则列表。

RuleIdstring

规则 ID。

rule-000************f1e
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
VaultIdstring

仅当 RuleType 取值为 BACKUP 时,需要配置该参数。备份库 ID。

v-000**************kgm
ReplicationRegionIdstring

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

cn-shanghai
Retentionlong

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

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

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

AdvancedRetentionTypestring

特殊保留规则类型:

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

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

1
Retentionlong

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

730
ArchiveDayslong

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

30
KeepLatestSnapshotslong

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

  • 0:不保留。
  • 1:保留。
1
PolicyBindingCountlong

策略已绑定的数据源数量。

5
NextTokenstring

获取下一页策略所需的 Token。

caeba0bbb2be03f84eb48b699f0a
MaxResultsinteger

每次查询结果的个数。

取值范围:10~100。默认值:10。

10
TotalCountlong

总记录数。

12
Successboolean

请求是否成功。

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

返回码。200 表示成功。

200
Messagestring

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

successful
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "Policies": [
    {
      "CreatedTime": 1650248136,
      "UpdatedTime": 1662080404,
      "PolicyId": "po-000************bkz",
      "PolicyName": "每天备份 + 异地备份",
      "PolicyDescription": "每天早上十点备份,异地复制到上海。",
      "Rules": [
        {
          "RuleId": "rule-000************f1e",
          "RuleType": "BACKUP",
          "Schedule": "I|1648647166|P1D",
          "BackupType": "COMPLETE",
          "VaultId": "v-000**************kgm",
          "ReplicationRegionId": "cn-shanghai",
          "Retention": 7,
          "RetentionRules": [
            {
              "AdvancedRetentionType": "YEARLY",
              "WhichSnapshot": 1,
              "Retention": 730
            }
          ],
          "ArchiveDays": 30,
          "KeepLatestSnapshots": 1
        }
      ],
      "PolicyBindingCount": 5
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 12,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史