获取一个或者多个符合条件的备份仓库信息。
调试
您可以在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 | 否 | 备份仓库状态。
| 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-********************* |
返回参数
示例
正常返回示例
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"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-30 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-09-10 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-02-01 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-12-06 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-09-06 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-03-29 | OpenAPI 返回结构发生变更 | 查看变更详情 |