查询备份存储库列表 - ListBackupVaults
功能介绍
查询备份存储库列表，若进行绑定主机，则需要额外判断，同时满足以下条件：1、存储库状态为“可用”状态；2、备份策略状态为“已启用”；3、存储库有剩余可用备份容量；4、存储库绑定的服务器数量少于256。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/ransomware/optional/vaults
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 默认为0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
vault_name |
否 |
String |
备份存储库名称 |
|
vault_id |
否 |
String |
备份存储库id |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
查询备份存储库总数 |
|
data_list |
Array of BackupVaultInfo objects |
查询备份存储库列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vault_id |
String |
存储库ID |
|
vault_name |
String |
存储库名称 |
|
vault_size |
Integer |
存储库总容量，单位GB |
|
vault_used |
Integer |
已使用容量，单位MB，指的是已有备份占用的容量，例如绑定了1台主机，已经有两个备份数，两个备份60G，则已使用容量为60G。 |
|
vault_allocated |
Integer |
已分配容量，单位GB，指绑定的服务器大小，例如绑定了1台主机，主机大小40G，则已分配容量为40G。 |
|
vault_charging_mode |
String |
存储库创建模式：
|
|
vault_status |
String |
存储库状态。
|
|
backup_policy_id |
String |
备份策略ID，若为空，则为未绑定状态，若不为空，通过backup_policy_enabled字段判断策略是否启用 |
|
backup_policy_name |
String |
备份策略名称 |
|
backup_policy_enabled |
Boolean |
备份策略是否启用 |
|
resources_num |
Integer |
已绑定服务器（个） |
请求示例
无
响应示例
状态码：200
请求已成功
{
"total_num" : 2097152,
"data_list" : [ {
"vault_id" : "48a-5f59-4541XXX",
"vault_name" : "vault-XXX",
"vault_size" : 2097152,
"vault_used" : 2097152,
"vault_allocated" : 2097152,
"vault_charging_mode" : "pre_paid",
"vault_status" : "available",
"backup_policy_id" : "77d-6963-4ea3XXX",
"backup_policy_name" : "policy_XXX",
"backup_policy_enabled" : true,
"resources_num" : 1
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
