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

查询一个或多个策略。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
hbr:DescribePoliciesV2	list	全部资源 ``	无	无

请求参数

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

返回参数

名称	类型	描述	示例值
	object	DescribePoliciesResponse
Policies	array<object>	策略列表。
Policy	object	策略详情。
CreatedTime	long	创建时间。UNIX 时间，单位秒。	1650248136
UpdatedTime	long	更新时间。UNIX 时间，单位为秒。	1662080404
PolicyId	string	策略 ID。	po-000************bkz
PolicyName	string	策略名称。	每天备份 + 异地备份
PolicyDescription	string	策略描述。	每天早上十点备份，异地复制到上海。
Rules	array<object>	策略规则列表。
Rule	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
VaultId	string	仅当 RuleType 取值为 BACKUP 时，需要配置该参数。备份库 ID。	v-000**************kgm
ReplicationRegionId	string	仅当 RuleType 取值为 REPLICATION 时，需要配置该参数。复制的目标地域 ID。	cn-shanghai
Retention	long	仅当 RuleType 取值为 TRANSITION 或 REPLICATION 时，需要配置该参数。 RuleType 取值为 TRANSITION：备份保留时间，最小值为 1，单位为天。 RuleType 取值为 REPLICATION：异地备份保留时间，最小值为 1，单位为天。	7
RetentionRules	array<object>	仅当 RuleType 取值为 TRANSITION 时，需要配置该参数。特殊保留规则列表。
RetentionRule	object	特殊保留规则。
AdvancedRetentionType	string	特殊保留规则类型： WEEKLY：每周的备份 MONTHLY：每月的备份 YEARLY：每年的备份	YEARLY
WhichSnapshot	long	针对第几个备份生效，当前仅支持第 1 个备份，值为 1。	1
Retention	long	备份的特殊保留时间，最小值为 1，单位为天。	730
ArchiveDays	long	仅当 RuleType 取值为 TRANSITION 时，需要配置该参数。备份转为归档的时间，单位为天。	30
KeepLatestSnapshots	long	是否开启保留至少一个备份版本。 0：不保留。 1：保留。	1
DataSourceFilters	array<object>	仅当 RuleType 取值为 TAG 时，需要配置该参数。数据源过滤规则。
DataSourceFilter	object
SourceType	string	数据源类型。取值范围： UDM_ECS：表示 ECS 整机备份。 OSS：表示 OSS 备份。 NAS：表示阿里云 NAS 备份。 ECS_FILE：表示 ECS 文件备份。 OTS：表示 Tablestore 备份。	UDM_ECS
DataSourceIds	array	已废弃。
DataSourceId	string	已废弃。	已废弃。
TagFilters	array<object>	仅当 RuleType 取值为 TAG 时，需要配置该参数。资源标签过滤规则。
TagFilter	object
Key	string	标签键。	env
Value	string	标签值，为空时表示任意值。	prod
Operator	string	标签匹配规则，支持 EQUAL：匹配标签键和标签值。 NOT：匹配标签键，不匹配标签值。	EQUAL
Immutable	boolean	仅当 PolicyType 为UDM_ECS_ONLY时，该字段有效。表示是否开启备份锁定。	true
PolicyBindingCount	long	策略已绑定的数据源数量。	5
PolicyType	string	策略类型，支持： STANDARD：通用备份策略，支持备份除 ECS 整机备份以外的数据源。 UDM_ECS_ONLY：整机备份策略，仅支持备份 ECS 整机。	STANDARD
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",
          "VaultId": "v-000**************kgm",
          "ReplicationRegionId": "cn-shanghai",
          "Retention": 7,
          "RetentionRules": [
            {
              "AdvancedRetentionType": "YEARLY",
              "WhichSnapshot": 1,
              "Retention": 730
            }
          ],
          "ArchiveDays": 30,
          "KeepLatestSnapshots": 1,
          "DataSourceFilters": [
            {
              "SourceType": "UDM_ECS",
              "DataSourceIds": [
                "已废弃。"
              ]
            }
          ],
          "TagFilters": [
            {
              "Key": "env",
              "Value": "prod",
              "Operator": "EQUAL"
            }
          ],
          "Immutable": true
        }
      ],
      "PolicyBindingCount": 5,
      "PolicyType": "STANDARD"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 12,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-11-13	OpenAPI 返回结构发生变更	查看变更详情
2024-09-25	OpenAPI 返回结构发生变更	查看变更详情
2024-07-23	OpenAPI 返回结构发生变更	查看变更详情