查询一个或多个策略。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
hbr:DescribePoliciesV2 |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| NextToken |
string |
否 |
获取下一页策略所需的 Token。 |
caeba0bbb2be03f84eb48b699f0a |
| MaxResults |
integer |
否 |
每次查询结果的个数。 取值范围：10~100。默认值：10。 |
10 |
| PolicyId |
string |
否 |
策略 ID。 |
po-000************2l6 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
DescribePoliciesResponse |
||
| Policies |
array<object> |
策略列表。 |
|
|
object |
策略详情。 |
||
| CreatedTime |
integer |
创建时间。UNIX 时间，单位秒。 |
1650248136 |
| UpdatedTime |
integer |
更新时间。UNIX 时间，单位为秒。 |
1662080404 |
| PolicyId |
string |
策略 ID。 |
po-000************bkz |
| PolicyName |
string |
策略名称。 |
每天备份 + 异地备份 |
| PolicyDescription |
string |
策略描述。 |
每天早上十点备份，异地复制到上海。 |
| Rules |
array<object> |
策略规则列表。 |
|
|
object |
策略规则详情。 |
||
| RuleId |
string |
规则 ID。 |
rule-000************f1e |
| RuleType |
string |
规则类型，每一个策略需要至少有一个 BACKUP 类型规则，有且仅有一个 TRANSITION 类型规则：
|
BACKUP |
| Schedule |
string |
仅当 RuleType 取值为 BACKUP 时，需要配置该参数。备份定时设置。可选格式：
|
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 |
integer |
仅当 RuleType 取值为 TRANSITION 或 REPLICATION 时，需要配置该参数。
|
7 |
| RetentionRules |
array<object> |
仅当 RuleType 取值为 TRANSITION 时，需要配置该参数。特殊保留规则列表。 |
|
|
object |
特殊保留规则。 |
||
| AdvancedRetentionType |
string |
特殊保留规则类型：
|
YEARLY |
| WhichSnapshot |
integer |
针对第几个备份生效，当前仅支持第 1 个备份，值为 1。 |
1 |
| Retention |
integer |
备份的特殊保留时间，最小值为 1，单位为天。 |
730 |
| ArchiveDays |
integer |
仅当 RuleType 取值为 TRANSITION 时，需要配置该参数。备份转为归档的时间，单位为天。 |
30 |
| KeepLatestSnapshots |
integer |
是否开启保留至少一个备份版本。
|
1 |
| DataSourceFilters |
array<object> |
仅当 RuleType 取值为 TAG 时，需要配置该参数。数据源过滤规则。 |
|
|
object |
|||
| SourceType |
string |
数据源类型。取值范围：
|
UDM_ECS |
| DataSourceIds |
array |
已废弃。 |
|
|
string |
已废弃。 |
已废弃。 |
|
| TagFilters |
array<object> |
仅当 RuleType 取值为 TAG 时，需要配置该参数。资源标签过滤规则。 |
|
|
object |
|||
| Key |
string |
标签键。 |
env |
| Value |
string |
标签值，为空时表示任意值。 |
prod |
| Operator |
string |
标签匹配规则，支持
|
EQUAL |
| Immutable |
boolean |
仅当 PolicyType 为UDM_ECS_ONLY时，该字段有效。表示是否开启备份锁定。 |
true |
| PolicyBindingCount |
integer |
策略已绑定的数据源数量。 |
5 |
| PolicyType |
string |
策略类型，支持：
|
STANDARD |
| BusinessStatus |
string |
用户业务状态 |
ACTIVE |
| NextToken |
string |
获取下一页策略所需的 Token。 |
caeba0bbb2be03f84eb48b699f0a |
| MaxResults |
integer |
每次查询结果的个数。 取值范围：10~100。默认值：10。 |
10 |
| TotalCount |
integer |
总记录数。 |
12 |
| Success |
boolean |
请求是否成功。
|
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",
"BusinessStatus": "ACTIVE"
}
],
"NextToken": "caeba0bbb2be03f84eb48b699f0a",
"MaxResults": 10,
"TotalCount": 12,
"Success": true,
"Code": "200",
"Message": "successful",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。