DescribeVaults - 查詢備份倉庫資訊 - Cloud Backup

擷取一個或者多個合格備份倉庫資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hbr:DescribeVaults

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
VaultId	string	否	備份倉庫 ID。	v-*********************
VaultRegionId	string	否	備份倉庫所屬的地區 ID。	cn-shanghai
Status	string	否	備份倉庫狀態。 UNKNOWN：未知 INITIALIZING：初始化中 CREATED：已建立 ERROR：錯誤	CREATED
PageNumber	integer	否	分頁頁碼，從 1 開始，預設值為 1。	1
PageSize	integer	否	分頁大小，最小值為 1，最大值為 99，預設值為 10。	10
VaultType	string	否	備份倉庫類型。取值 STANDARD：表示普通倉庫，可用於 ECS 檔案備份、OSS 備份、NAS 備份等。 OTS_BACKUP：表示 TableStore 倉庫，僅可用於 TableStore 備份，且 TableStore 需要使用該類型的倉庫。	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
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	請求是否成功。 true：成功 false：失敗	true
Code	string	返回碼。200 表示成功。	200
Message	string	返回資訊描述，成功一般返回 successful，錯誤時會返回相應錯誤資訊。	successful
PageNumber	integer	分頁頁碼，從 1 開始，預設值為 1。	1
PageSize	integer	分頁大小，最小值為 1，最大值為 99，預設值為 10。	10
TotalCount	integer	返回備份倉庫總數量。	8
Vaults	object
Vault	array<object>	備份倉庫列表。	{'Vault': []}
	array<object>	備份倉庫列表。
Status	string	備份倉庫狀態。 UNKNOWN：未知 INITIALIZING：初始化中 CREATED：已建立 ERROR：錯誤	CREATED
VaultId	string	備份倉庫 ID。	v-*********************
ChargeType	string	備份倉庫計費類型。	FREE
VaultType	string	備份倉庫類型。取值僅為 STANDARD，表示普通倉庫。	STANDARD
Dedup	boolean	是否開啟重刪功能。	true
ReplicationSourceVaultId	string	異地備份倉庫源倉庫 ID。	v-*********************
IndexUpdateTime	integer	索引更新時間。	1639645628
Description	string	倉庫描述。	vault description
VaultStorageClass	string	備份倉庫儲存類型。取值僅為 STANDARD，表示標準儲存。	STANDARD
Retention	integer	備份庫保留時間長度，單位：天。	2
CreatedTime	integer	備份倉庫建立時間。UNIX 時間戳記，單位秒。	1554347313
IndexLevel	string	索引等級。 OFF：不建立索引 META：中繼資料索引 ALL：全文索引	OFF
VaultName	string	備份倉庫名稱。	vaultname
StorageSize	integer	備份庫使用量。單位為 Byte。	10
LatestReplicationTime	integer	最後一次異地備份同步時間。UNIX 時間戳記，單位為秒。	1554347313
VaultStatusMessage	string	（僅異地備份倉庫有效）倉庫錯誤狀態資訊，取值範圍： UNKNOWN_ERROR表示未知錯誤。 SOURCE_VAULT_ALREADY_HAS_REPLICATION表示複製源倉庫已經設定了其他鏡像倉庫。	SOURCE_VAULT_ALREADY_HAS_REPLICATION
Replication	boolean	是否為異地備份倉庫。 true：異地備份倉庫。 false：本地備份倉庫。	false
ReplicationSourceRegionId	string	異地備份庫的源庫所屬地區 ID（僅對異地備份庫有效）	cn-shanghai
VaultRegionId	string	備份倉庫所屬的地區 ID。	cn-shanghai
UpdatedTime	integer	備份倉庫更新時間。UNIX 時間戳記，單位為秒。	1554347313
ResourceGroupId	string	資源群組 ID。	rg-*********************
BucketName	string	備份倉庫試用的 oss bucket 名稱。	hbr-0005i51******t58
SearchEnabled	boolean	是否開啟備份搜尋。	true
IndexAvailable	boolean	索引是否可用（不處於更新狀態）。	true
BytesDone	integer	備份資料量。單位為 Byte。	20
Tags	object
Tag	array<object>	備份倉庫的標籤資訊。
	object	備份倉庫的標籤資訊。
Key	string	倉庫的標籤鍵。N 的取值範圍：1~20。不支援以`aliyun`、`acs:`開頭。不允許包含`http://`和`https://`。不允許為空白字串。	aaa
Value	string	倉庫的標籤值。N 的取值範圍：1~20。不支援以`aliyun`、`acs:`開頭。不允許包含`http://`和`https://`。不允許為空白字串。	a1
SourceTypes	object
SourceType	array	備份倉庫備份的資料來源類型。
	string	備份資料來源類型。	ECS_FILE
ReplicationProgress	object	備份庫複製進度。
HistoricalReplicationProgress	integer	備份庫歷史資料複製進度。取值 0~100。	100
NewReplicationProgress	integer	備份庫增量資料最新複製時間。	1579413159
BackupPlanStatistics	object	備份倉庫備份計劃統計。
Oracle	integer	Oracle 類型備份計劃數量。	1
LocalFile	integer	本機伺服器類型備份計劃數量。	1
Nas	integer	NAS 類型備份計劃數量。	1
CommonNas	integer	通用 NAS 類型備份計劃數量。	1
Isilon	integer	Isilon 類型備份計劃數量。	1
Oss	integer	OSS 類型備份計劃數量。	1
SqlServer	integer	SQL Server 類型備份計劃數量。	1
Csg	integer	Cloud Storage Gateway類型備份計劃數量。	1
EcsFile	integer	ECS 檔案類型備份計劃數量。	1
MySql	integer	MySQL 類型備份計劃數量。	1
EcsHana	integer	SAP HANA 類型備份計劃數量。	1
LocalVm	integer	本地虛擬機器備份計劃數量。	1
Ots	integer	Table Store類型備份計劃數量。	1
Archive	integer	歸檔計劃數量。	1
CommonFileSystem	integer	CPFS 備份計劃數量。	1
TrialInfo	object	免費試用屬性。
TrialStartTime	integer	免費試用開始時間。	1579413159
TrialVaultReleaseTime	integer	免費試用倉庫釋放時間。	1594965600
TrialExpireTime	integer	免費試用到期時間。	1584597600
KeepAfterTrialExpiration	boolean	免費試用結束後是否轉為隨用隨付。	true
EncryptType	string	備份倉庫加密類型。 NONE：不加密 HBR_PRIVATE：HBR 提供祕密金鑰加密（預設） KMS：使用使用者的 KMS key 加密	HBR_PRIVATE
WormEnabled	boolean	是否開啟備份鎖定。	true
SnapshotCount	integer	倉庫內的快照數量。	0
CompressionAlgorithm	string	對備份庫進行壓縮的密碼編譯演算法，取值包括： DISABLED：不壓縮加密。 SNAPPY：使用 SNAPPY 密碼編譯演算法。 ZSTD：即 Zstandard，一種快速的無損壓縮演算法。	ZSTD
RedundancyType	string	備份倉庫的資料冗餘儲存方式。取值包括： LRS：備份庫（本地冗餘 LRS）。採用資料冗餘儲存機制，將每個對象的不同冗餘儲存在同一個可用性區域內多個設施的多個裝置上，確保硬體失效時的資料持久性和可用性。 ZRS：備份庫（同城冗餘 ZRS）。採用多可用性區域（AZ）機制，將使用者的資料分散存放在同一地區（Region）的 3 個可用性區域。當某個可用性區域不可用時，仍然能夠保障資料的正常訪問。	LRS
KmsKeyId	string	阿里雲 KMS 服務自訂密鑰 Key 或者 Alias，僅當 EncryptType=KMS 時必填。	alias/acs/acm
ChargedStorageSize	integer	歸檔庫計費容量，單位：位元組。	1024000
ArchiveStorageSize	integer	歸檔層計費容量，單位：位元組。	1024000
ArchiveBytesDone	integer	歸檔層備份資料量。單位：位元組。	1024000
ReplicationSourceVault	boolean	是否是異地備份庫的源庫 true：是異地備份庫的源庫。 false：不是異地備份庫的源庫。	false
ReplicationTargetRegionId	string	異地備份庫目標地區。	cn-shanghai
VaultOwnerId	integer	存放庫所屬帳號 ID	123***7890
ReplicationTargetVaultId	string	複製目標備份庫 ID	v-123***7890
ReplicationSourceOwnerId	integer	複製源端帳號 ID	123***7890
ReplicationTargetOwnerId	integer	複製目標備份庫所屬帳號 ID	123***7890
ReplicationStatus	string	複製目標備份庫複製狀態	RUNNING
RsTargetAccountIds	object
RsTargetAccountId	array	資源共用目標帳號
	integer	資源共用目標帳號	123***7890

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "Vaults": {
    "Vault": [
      {
        "Status": "CREATED",
        "VaultId": "v-*********************",
        "ChargeType": "FREE",
        "VaultType": "STANDARD",
        "Dedup": true,
        "ReplicationSourceVaultId": "v-*********************",
        "IndexUpdateTime": 1639645628,
        "Description": "vault description",
        "VaultStorageClass": "STANDARD",
        "Retention": 2,
        "CreatedTime": 1554347313,
        "IndexLevel": "OFF",
        "VaultName": "vaultname",
        "StorageSize": 10,
        "LatestReplicationTime": 1554347313,
        "VaultStatusMessage": "SOURCE_VAULT_ALREADY_HAS_REPLICATION",
        "Replication": false,
        "ReplicationSourceRegionId": "cn-shanghai",
        "VaultRegionId": "cn-shanghai",
        "UpdatedTime": 1554347313,
        "ResourceGroupId": "rg-*********************",
        "BucketName": "hbr-0005i51******t58",
        "SearchEnabled": true,
        "IndexAvailable": true,
        "BytesDone": 20,
        "Tags": {
          "Tag": [
            {
              "Key": "aaa",
              "Value": "a1"
            }
          ]
        },
        "SourceTypes": {
          "SourceType": [
            "ECS_FILE"
          ]
        },
        "ReplicationProgress": {
          "HistoricalReplicationProgress": 100,
          "NewReplicationProgress": 1579413159
        },
        "BackupPlanStatistics": {
          "Oracle": 1,
          "LocalFile": 1,
          "Nas": 1,
          "CommonNas": 1,
          "Isilon": 1,
          "Oss": 1,
          "SqlServer": 1,
          "Csg": 1,
          "EcsFile": 1,
          "MySql": 1,
          "EcsHana": 1,
          "LocalVm": 1,
          "Ots": 1,
          "Archive": 1,
          "CommonFileSystem": 1
        },
        "TrialInfo": {
          "TrialStartTime": 1579413159,
          "TrialVaultReleaseTime": 1594965600,
          "TrialExpireTime": 1584597600,
          "KeepAfterTrialExpiration": true
        },
        "EncryptType": "HBR_PRIVATE",
        "WormEnabled": true,
        "SnapshotCount": 0,
        "CompressionAlgorithm": "ZSTD",
        "RedundancyType": "LRS",
        "KmsKeyId": "alias/acs/acm",
        "ChargedStorageSize": 1024000,
        "ArchiveStorageSize": 1024000,
        "ArchiveBytesDone": 1024000,
        "ReplicationSourceVault": false,
        "ReplicationTargetRegionId": "cn-shanghai",
        "VaultOwnerId": 0,
        "ReplicationTargetVaultId": "v-123***7890",
        "ReplicationSourceOwnerId": 0,
        "ReplicationTargetOwnerId": 0,
        "ReplicationStatus": "RUNNING",
        "RsTargetAccountIds": {
          "RsTargetAccountId": [
            0
          ]
        }
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。