取得一個或多個符合條件的備份儲存庫資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
hbr:DescribeVaults |
get |
*全部資源。
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| VaultId |
string |
否 |
備份儲存庫 ID。 |
v-********************* |
| VaultRegionId |
string |
否 |
備份儲存庫所屬的地域 ID。 |
cn-shanghai |
| Status |
string |
否 |
備份儲存庫狀態。
|
CREATED |
| PageNumber |
integer |
否 |
分頁頁碼，從 1 開始，預設值為 1。 |
1 |
| PageSize |
integer |
否 |
分頁大小，最小值為 1，最大值為 99，預設值為 10。 |
10 |
| VaultType |
string |
否 |
備份儲存庫類型。取值：
|
STANDARD |
| Tag |
array<object> |
否 |
標籤資訊。最大支援 20 個標籤。 |
6a745bceffb042959b3b5206d6f12ad1 |
|
object |
否 |
標籤資訊。 |
||
| Key |
string |
否 |
標籤的 Key 值。 |
key1 |
| Value |
string |
否 |
標籤的 Value 值。 |
value1 |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-********************* |
| VaultName |
string |
否 |
備份儲存庫名稱。長度為 1~64 個字元。 |
vaultname |
| VaultOwnerId |
integer |
否 |
備份儲存庫所屬帳號 ID。 |
144******732 |
| Replication |
boolean |
否 |
是否查詢複製目標備份儲存庫。 |
true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| Code |
string |
返回碼。200 表示成功。 |
200 |
| Message |
string |
傳回資訊描述，成功時通常傳回 successful，錯誤時會傳回相應錯誤資訊。 |
successful |
| PageNumber |
integer |
分頁頁碼，從 1 開始，預設值為 1。 |
1 |
| PageSize |
integer |
分頁大小，最小值為 1，最大值為 99，預設值為 10。 |
10 |
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Success |
boolean |
請求是否成功。
|
true |
| TotalCount |
integer |
返回備份倉庫總數量。 |
8 |
| Vaults |
object |
{'Vault': []} |
|
| Vault |
array<object> |
備份倉庫列表。 |
{'Vault': []} |
|
array<object> |
備份倉庫列表。 |
||
| ArchiveBytesDone |
integer |
歸檔層備份資料量。單位：位元組。 |
1024000 |
| ArchiveStorageSize |
integer |
歸檔層計費容量，單位：位元組。 |
1024000 |
| BackupPlanStatistics |
object |
備份倉庫備份計畫統計。 |
|
| Archive |
integer |
歸檔計畫數量。 |
1 |
| CommonFileSystem |
integer |
CPFS 備份計畫數量。 |
1 |
| CommonNas |
integer |
通用 NAS 類型備份計畫數量。 |
1 |
| Cpfs |
integer |
CPFS 備份。 |
3 |
| Csg |
integer |
雲端儲存閘道類型備份計畫數量。 |
1 |
| EcsFile |
integer |
ECS 檔案備份標準版類型備份計畫數量。 |
1 |
| EcsHana |
integer |
SAP HANA 類型備份計畫數量。 |
1 |
| Isilon |
integer |
Isilon 類型備份計畫數量。 |
1 |
| LocalFile |
integer |
本地伺服器類型備份計畫數量。 |
1 |
| LocalVm |
integer |
本地虛擬機器備份計畫數量。 |
1 |
| MySql |
integer |
MySQL 類型備份計畫數量。 |
1 |
| Nas |
integer |
NAS 類型備份計畫數量。 |
1 |
| Oracle |
integer |
Oracle 類型備份計畫數量。 |
1 |
| Oss |
integer |
OSS 類型備份計畫數量。 |
1 |
| Ots |
integer |
表格儲存類型備份計畫數量。 |
1 |
| SqlServer |
integer |
SQL Server 類型備份計畫數量。 |
1 |
| BucketName |
string |
備份倉庫試用的 oss bucket 名稱。 |
hbr-0005i51******t58 |
| BytesDone |
integer |
備份資料量。單位為 Byte。 |
20 |
| ChargeType |
string |
備份倉庫計費類型。 |
FREE |
| ChargedStorageSize |
integer |
歸檔庫計費容量，單位：位元組。 |
1024000 |
| CompressionAlgorithm |
string |
對備份庫進行壓縮的加密演算法，取值包括：
|
ZSTD |
| CreatedTime |
integer |
備份倉庫建立時間。UNIX 時間戳記，單位秒。 |
1554347313 |
| Dedup |
boolean |
是否開啟重刪功能。 |
true |
| Description |
string |
倉庫描述。 |
vault description |
| EncryptType |
string |
備份倉庫加密類型。
|
HBR_PRIVATE |
| IndexAvailable |
boolean |
索引是否可用（不處於更新狀態）。 |
true |
| IndexLevel |
string |
索引等級。
|
OFF |
| IndexUpdateTime |
integer |
索引更新時間。 |
1639645628 |
| KmsKeyId |
string |
阿里雲 KMS 服務自訂金鑰 Key 或 Alias，僅當 EncryptType=KMS 時必填。 |
alias/acs/acm |
| LatestReplicationTime |
integer |
最後一次異地備份同步時間。UNIX 時間戳記，單位為秒。 |
1554347313 |
| RedundancyType |
string |
備份倉庫的資料冗餘儲存方式。取值包括：
|
LRS |
| Replication |
boolean |
是否為異地備份倉庫。
|
false |
| ReplicationProgress |
object |
備份庫複製進度。 |
|
| HistoricalReplicationProgress |
integer |
備份庫歷史資料複製進度。取值 0~100。 |
100 |
| NewReplicationProgress |
integer |
備份庫增量資料最新複製時間。 |
1579413159 |
| ReplicationSourceOwnerId |
integer |
複製來源帳號 ID。 |
123***7890 |
| ReplicationSourceRegionId |
string |
異地備份庫的來源庫所屬地域 ID（僅對異地備份庫有效）。 |
cn-shanghai |
| ReplicationSourceVault |
boolean |
是否是異地備份庫的來源庫。
|
false |
| ReplicationSourceVaultId |
string |
異地備份倉庫來源倉庫 ID。 |
v-********************* |
| ReplicationStatus |
string |
複製目標備份庫複製狀態。 |
RUNNING |
| ReplicationTargetOwnerId |
integer |
複製目標備份庫所屬帳號 ID。 |
123***7890 |
| ReplicationTargetRegionId |
string |
異地備份庫目標地域。 |
cn-shanghai |
| ReplicationTargetVaultId |
string |
複製目標備份庫 ID。 |
v-123***7890 |
| ResourceGroupId |
string |
資源群組 ID。 |
rg-********************* |
| Retention |
integer |
備份庫保留時長，單位：天。 |
2 |
| RsTargetAccountIds |
object |
||
| RsTargetAccountId |
array |
資源共用目標帳號。 |
|
|
integer |
資源共用目標帳號。 |
123***7890 |
|
| SearchEnabled |
boolean |
是否開啟備份搜尋。 |
true |
| SnapshotCount |
integer |
倉庫內的快照數量。 |
0 |
| SourceTypes |
object |
||
| SourceType |
array |
備份倉庫備份的資料來源類型。 |
|
|
string |
備份資料來源類型。 |
ECS_FILE |
|
| Status |
string |
備份儲存庫狀態。
|
CREATED |
| StorageSize |
integer |
備份庫使用量。單位為 Byte。 |
10 |
| Tags |
object |
||
| Tag |
array<object> |
備份倉庫的標籤資訊。 |
|
|
object |
備份倉庫的標籤資訊。 |
||
| Key |
string |
倉庫的標籤鍵。N 的取值範圍：1~20。
|
aaa |
| Value |
string |
倉庫的標籤值。N 的取值範圍：1~20。
|
a1 |
| TrialInfo |
object |
免費試用屬性。 |
|
| KeepAfterTrialExpiration |
boolean |
免費試用結束後是否轉為按量付費。 |
true |
| TrialExpireTime |
integer |
免費試用過期時間。 |
1584597600 |
| TrialStartTime |
integer |
免費試用開始時間。 |
1579413159 |
| TrialVaultReleaseTime |
integer |
免費試用倉庫釋放時間。 |
1594965600 |
| UpdatedTime |
integer |
備份倉庫更新時間。UNIX 時間戳記，單位為秒。 |
1554347313 |
| VaultId |
string |
備份儲存庫 ID。 |
v-********************* |
| VaultName |
string |
備份倉庫名稱。 |
vaultname |
| VaultOwnerId |
integer |
儲存庫所屬帳號 ID。 |
123***7890 |
| VaultRegionId |
string |
備份儲存庫所屬的地域 ID。 |
cn-shanghai |
| VaultStatusMessage |
string |
（僅異地備份儲存庫有效）儲存庫錯誤狀態資訊，取值範圍：
|
SOURCE_VAULT_ALREADY_HAS_REPLICATION |
| VaultStorageClass |
string |
備份儲存庫儲存類型。取值僅為 STANDARD，表示標準儲存。 |
STANDARD |
| VaultType |
string |
備份儲存庫類型。取值僅為 STANDARD，表示普通儲存庫。 |
STANDARD |
| WormEnabled |
boolean |
是否開啟備份鎖定。 |
true |
樣本
正常返回樣本
JSON格式
{
"Code": "200",
"Message": "successful",
"PageNumber": 1,
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true,
"TotalCount": 8,
"Vaults": {
"Vault": [
{
"ArchiveBytesDone": 1024000,
"ArchiveStorageSize": 1024000,
"BackupPlanStatistics": {
"Archive": 1,
"CommonFileSystem": 1,
"CommonNas": 1,
"Cpfs": 3,
"Csg": 1,
"EcsFile": 1,
"EcsHana": 1,
"Isilon": 1,
"LocalFile": 1,
"LocalVm": 1,
"MySql": 1,
"Nas": 1,
"Oracle": 1,
"Oss": 1,
"Ots": 1,
"SqlServer": 1
},
"BucketName": "hbr-0005i51******t58",
"BytesDone": 20,
"ChargeType": "FREE",
"ChargedStorageSize": 1024000,
"CompressionAlgorithm": "ZSTD",
"CreatedTime": 1554347313,
"Dedup": true,
"Description": "vault description",
"EncryptType": "HBR_PRIVATE",
"IndexAvailable": true,
"IndexLevel": "OFF",
"IndexUpdateTime": 1639645628,
"KmsKeyId": "alias/acs/acm",
"LatestReplicationTime": 1554347313,
"RedundancyType": "LRS",
"Replication": false,
"ReplicationProgress": {
"HistoricalReplicationProgress": 100,
"NewReplicationProgress": 1579413159
},
"ReplicationSourceOwnerId": 0,
"ReplicationSourceRegionId": "cn-shanghai",
"ReplicationSourceVault": false,
"ReplicationSourceVaultId": "v-*********************",
"ReplicationStatus": "RUNNING",
"ReplicationTargetOwnerId": 0,
"ReplicationTargetRegionId": "cn-shanghai",
"ReplicationTargetVaultId": "v-123***7890",
"ResourceGroupId": "rg-*********************",
"Retention": 2,
"RsTargetAccountIds": {
"RsTargetAccountId": [
0
]
},
"SearchEnabled": true,
"SnapshotCount": 0,
"SourceTypes": {
"SourceType": [
"ECS_FILE"
]
},
"Status": "CREATED",
"StorageSize": 10,
"Tags": {
"Tag": [
{
"Key": "aaa",
"Value": "a1"
}
]
},
"TrialInfo": {
"KeepAfterTrialExpiration": true,
"TrialExpireTime": 1584597600,
"TrialStartTime": 1579413159,
"TrialVaultReleaseTime": 1594965600
},
"UpdatedTime": 1554347313,
"VaultId": "v-*********************",
"VaultName": "vaultname",
"VaultOwnerId": 0,
"VaultRegionId": "cn-shanghai",
"VaultStatusMessage": "SOURCE_VAULT_ALREADY_HAS_REPLICATION",
"VaultStorageClass": "STANDARD",
"VaultType": "STANDARD",
"WormEnabled": true
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。