DescribeVaults - 查询备份仓库信息 - 云备份

获取一个或者多个符合条件的备份仓库信息。

调试

您可以在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-*********************

返回参数

名称	类型	描述	示例值
	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	array<object>	备份仓库列表。	{'Vault': []}
Vault	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	long	索引更新时间。	1639645628
Description	string	仓库描述。	vault description
VaultStorageClass	string	备份仓库存储类型。取值仅为 STANDARD，表示标准存储。	STANDARD
Retention	long	备份库保留时长，单位：天。	2
CreatedTime	long	备份仓库创建时间。UNIX 时间戳，单位秒。	1554347313
IndexLevel	string	索引等级。 OFF：不创建索引 META：元数据索引 ALL：全文索引	OFF
VaultName	string	备份仓库名称。	vaultname
StorageSize	long	备份库使用量。单位为 Byte。	10
LatestReplicationTime	long	最后一次异地备份同步时间。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	long	备份仓库更新时间。UNIX 时间戳，单位为秒。	1554347313
ResourceGroupId	string	资源组 ID。	rg-*********************
BucketName	string	备份仓库试用的 oss bucket 名称。	hbr-0005i51******t58
SearchEnabled	boolean	是否开启备份搜索。	true
IndexAvailable	boolean	索引是否可用（不处于更新状态）。	true
BytesDone	long	备份数据量。单位为 Byte。	20
Tags	array<object>	备份仓库的标签信息。
Tag	object	备份仓库的标签信息。
Key	string	仓库的标签键。N 的取值范围：1~20。不支持以`aliyun`、`acs:`开头。不允许包含`http://`和`https://`。不允许为空字符串。	aaa
Value	string	仓库的标签值。N 的取值范围：1~20。不支持以`aliyun`、`acs:`开头。不允许包含`http://`和`https://`。不允许为空字符串。	a1
SourceTypes	array	备份仓库备份的数据源类型。
SourceType	string	备份数据源类型。	ECS_FILE
ReplicationProgress	object	镜像仓库数据同步进度。
HistoricalReplicationProgress	integer	镜像仓库历史数据同步进度。取值 0~100。	100
NewReplicationProgress	long	镜像仓库增量数据最新同步时间。	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	云存储网关类型备份计划数量。	1
EcsFile	integer	ECS 文件类型备份计划数量。	1
MySql	integer	MySQL 类型备份计划数量。	1
EcsHana	integer	SAP HANA 类型备份计划数量。	1
LocalVm	integer	本地虚拟机备份计划数量。	1
Ots	integer	表格存储类型备份计划数量。	1
Archive	integer	归档计划数量。	1
CommonFileSystem	integer	CPFS 备份计划数量。	1
TrialInfo	object	免费试用属性。
TrialStartTime	long	免费试用开始时间。	1579413159
TrialVaultReleaseTime	long	免费试用仓库释放时间。	1594965600
TrialExpireTime	long	免费试用过期时间。	1584597600
KeepAfterTrialExpiration	boolean	免费试用结束后是否转为按量付费。	true
EncryptType	string	备份仓库加密类型。 NONE：不加密 HBR_PRIVATE：HBR 提供密钥加密（默认） KMS：使用用户的 KMS key 加密	HBR_PRIVATE
WormEnabled	boolean	是否开启备份锁定。	true
SnapshotCount	long	仓库内的快照数量。	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	long	归档库计费容量，单位：字节。	1024000
ArchiveStorageSize	long	归档层计费容量，单位：字节。	1024000
ArchiveBytesDone	long	归档层备份数据量。单位：字节。	1024000
ReplicationSourceVault	boolean	是否是异地备份库的源库 true：是异地备份库的源库。 false：不是异地备份库的源库。	false
ReplicationTargetRegionId	string	异地备份库目标地域。	cn-shanghai

示例

正常返回示例

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 返回结构发生变更	查看变更详情