DescribePoliciesV2 - 查询一个或多个策略 - 混合云备份 HBR

查询一个或多个策略。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
NextToken	string	否	获取下一页策略所需的Token。	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	否	每次查询结果的个数。取值范围：10~100。默认值：10。	10
PolicyId	string	否	策略ID。	po-000************2l6

返回参数

名称	类型	描述	示例值
	object	DescribePoliciesResponse
Policies	array	策略列表。
	object	策略详情。
CreatedTime	long	创建时间。UNIX时间，单位秒。	1650248136
UpdatedTime	long	更新时间。UNIX时间，单位为秒。	1662080404
PolicyId	string	策略ID。	po-000************bkz
PolicyName	string	策略名称。	每天备份 + 异地备份
PolicyDescription	string	策略描述。	每天早上十点备份，异地复制到上海。
Rules	array	策略规则列表。
	object	策略规则详情。
RuleId	string	规则ID。	rule-000************f1e
RuleType	string	规则类型，每一个策略需要至少有一个BACKUP类型规则，有且仅有一个TRANSITION类型规则： BACKUP：备份规则。 TRANSITION：生命周期规则。 REPLICATION：复制规则。	BACKUP
Schedule	string	仅当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
BackupType	string	仅当RuleType取值为BACKUP时，需要配置该参数。备份类型。取值为COMPLETE，表示全量备份。	COMPLETE
ReplicationRegionId	string	仅当RuleType取值为REPLICATION时，需要配置该参数。复制的目标地域ID。	cn-shanghai
Retention	long	仅当RuleType取值为TRANSITION或REPLICATION时，需要配置该参数。 RuleType取值为TRANSITION：备份保留时间，最小值为1，单位为天。 RuleType取值为REPLICATION：异地备份保留时间，最小值为1，单位为天。	7
RetentionRules	array	仅当RuleType取值为TRANSITION时，需要配置该参数。特殊保留规则列表。
	object	特殊保留规则。
AdvancedRetentionType	string	特殊保留规则类型： WEEKLY：每周的备份 MONTHLY：每月的备份 YEARLY：每年的备份	YEARLY
WhichSnapshot	long	针对第几个备份生效，当前仅支持第1个备份，值为1。	1
Retention	long	备份的特殊保留时间，最小值为1，单位为天。	730
PolicyBindingCount	long	策略已绑定的数据源数量。	5
NextToken	string	获取下一页策略所需的Token。	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	每次查询结果的个数。取值范围：10~100。默认值：10。	10
TotalCount	long	总记录数。	12
Success	boolean	请求是否成功。 true：成功 false：失败	true
Code	string	返回码。200表示成功。	200
Message	string	返回信息描述，成功一般返回successful，错误时会返回相应错误信息。	successful
RequestId	string	请求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",
          "ReplicationRegionId": "cn-shanghai",
          "Retention": 7,
          "RetentionRules": [
            {
              "AdvancedRetentionType": "YEARLY",
              "WhichSnapshot": 1,
              "Retention": 730
            }
          ]
        }
      ],
      "PolicyBindingCount": 5
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 12,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

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