查詢一個或多個策略。
調試
您可以在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"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。