查询存储库资源实例 - ShowVaultResourceInstances

project_id

是

String

参数解释：

项目ID，获取方法请参见获取项目ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

enterprise_project_id

否

String

参数解释：

云备份企业项目ID，获取企业项目ID请参考查询企业项目列表。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

without_any_tag

否

Boolean

参数解释：

不包含任意一个标签

约束限制：

该字段为true时查询所有不带标签的资源，此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。

取值范围：

true：查询所有不带标签的资源

false：不按此条件过滤

默认取值：

不涉及

tags

否

Array of TagsReq objects

包含标签。

tags不允许为空列表。

tags中最多包含10个key。

tags中key不允许重复。

tags中多个key之间是“与”的关系。

结果返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。

无过滤条件时返回全量数据。

tags_any

否

Array of TagsReq objects

包含任一标签。

tags不允许为空列表。

tags中最多包含10个key。

tags中key不允许重复。

结果返回包含任一标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。

无过滤条件时返回全量数据。

not_tags

否

Array of TagsReq objects

不包含标签。

tags不允许为空列表。

tags中最多包含10个key。

tags中key不允许重复。

结果返回不包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。

无过滤条件时返回全量数据。

not_tags_any

否

Array of TagsReq objects

参数解释：

不包含任一标签，结果返回不包含任一标签的资源列表，key之间是或的关系，key-value结构中value是或的关系

约束限制：

tags不允许为空列表，最多包含10个key且tags中key不允许重复，无过滤条件时返回全量数据

取值范围：

不涉及

默认取值：

不涉及

sys_tags

否

Array of SysTags objects

仅op_service权限可以使用此字段做资源实例过滤条件。

目前TMS调用时只包含一个tag结构体。

• key： _sys_enterprise_project_id

• values：企业项目id列表

目前TMS调用时，key下面只包含一个value，0表示默认企业项目。

sys_tags和租户标签过滤条件（tags、tags_any、not_tags、not_tags_any）不能同时使用。

无sys_tags时按照tag接口处理，无tag过滤条件时返回全量数据。

sys_tags不能为空列表

limit

否

String

参数解释：

查询记录数

约束限制：

返回的结果中记录数不超过limit，action为count时无此参数

取值范围：

action为filter时，默认为1000，limit最小值为1，limit最大值为1000

默认取值：

不涉及

offset

否

String

参数解释：

索引位置

约束限制：

action为count时无此参数

取值范围：

action为filter时，默认为0，offset最小值为0。返回的结果中第一条记录为符合查询条件的第offset+1条记录

默认取值：

不涉及

action

是

String

参数解释：

查询存储库资源实例的操作标识

约束限制：

不涉及

取值范围：

filter：就是分页查询

count：按照条件将返回总条数

默认取值：

不涉及

matches

否

Array of Match objects

资源本身支持的查询条件。

matches中key不允许重复。

数组长度最大值为 1，后续再扩展。

cloud_type

否

String

参数解释：

云类型

约束限制：

不涉及

取值范围：

public：公有云; hybrid: 混合云

默认取值：

public

object_type

否

String

参数解释：

资源类型

约束限制：

不涉及

取值范围：

• server: 云服务器

• disk: 云硬盘

默认取值：

不涉及

key

是

String

参数解释：

资源标签键

约束限制：

不涉及

取值范围：

键最大长度127个unicode字符，不允许为空字符串且前后的空格会被丢弃

默认取值：

不涉及

values

是

Array of strings

参数解释：

资源标签值列表

约束限制：

values中value不允许重复，values中多个value之间是"或"的关系，values如果为空列表，表示任意值。

*为系统保留字符，如果value是以*开头表示按照*后面的值全模糊匹配，不能只传入“*”。

取值范围：

values中最多包含10个value，每个value最大长度255个unicode字符且前后的空格会被丢弃。

values允许为空列表，其中的value允许为空字符串。

默认取值：

不涉及

key

是

String

键。

系统标签的key，从白名单中取，不能随意定义。

目前仅支持 _sys_enterprise_project_id字段，对应 的value为企业项目ID。

values

是

Array of strings

值列表。

目前仅会用到企业项目ID，其中默 认的企业项目ID为“0”。

key

是

String

键。

key取值范围为："resource_name"，资源名称

value

是

String

值。

最大长度255个字符。

key为"resource_name"时，value为空字符串时精确匹配，为非空字符串时模糊匹配。

resources

Array of TagResource objects

符合查询条件的资源列表（action为count时无此参数）。

total_count

Integer

参数解释：

符合查询条件的资源总个数

取值范围：

不涉及

resource_id

String

参数解释：

资源ID，格式为UUID

取值范围：

不涉及

resource_detail

InstancesResourceDetail object

资源详情

tags

Array of Tag objects

标签列表

没有标签默认为空数组。

resource_name

String

参数解释：

待备份资源名称，长度限制：0-255字符

取值范围：

不涉及

sys_tags

Array of SysTag objects

仅op_service权限才可以获取此字段：

目前只包含一个resource_tag 结构体。

key：_sys_enterprise_project_id

value：企业项目id，0表示默认企业项目

非op_service场景不能返回此字段。

vault

Vault object

存储库

billing

Billing object

参数解释：

运营信息，包括存储库名称，绑定的资源等信息

取值范围：

不涉及

description

String

参数解释：

存储库自定义描述信息

取值范围：

不能包含“<”，“>”，最大支持255个字符

id

String

参数解释：

存储库id，获取方法可参考查询存储库列表

取值范围：

UUID，形式为32个十六进制数字

name

String

参数解释：

存储库名称。

取值范围：

只能由中文、字母、数字、“_”、“-”组成，最大支持64个字符。

project_id

String

参数解释：

项目ID，获取方法请参见获取项目ID

取值范围：

不涉及

provider_id

String

参数解释：

存储库资源类型ID

取值范围：

取值范围如下：

0daac4c5-6707-4851-97ba-169e36266b66，云服务器。d1603440-187d-4516-af25-121250c7cc97，云硬盘。3f3c3220-245c-4805-b811-758870015881，SFS Turbo。a13639de-00be-4e94-af30-26912d75e4a2，混合云VMware备份。

resources

Array of ResourceResp objects

参数解释：

存储库资源

取值范围：

不涉及

tags

Array of Tag objects

参数解释：

存储库资源的标签，标签由键值对组成

取值范围：

不涉及

enterprise_project_id

String

参数解释：

云备份企业项目ID，获取方法可参考查询企业项目列表接口。

取值范围：

不涉及

auto_bind

Boolean

参数解释：

是否支持自动挂载

取值范围：

• true：支持自动挂载

• false：不支持自动挂载

bind_rules

VaultBindRules object

参数解释：

绑定规则，用于配置存储库自动绑定功能的规则

取值范围：

不涉及

user_id

String

参数解释：

用户id

取值范围：

不涉及

created_at

String

参数解释：

创建时间，格式为YYYY-MM-DDTHH:MM:SS.ffffff

取值范围：

不涉及

auto_expand

Boolean

参数解释：

是否开启存储库自动扩容能力（只支持按需存储库）

取值范围：

true：支持自动扩容

false：不支持自动扩容

smn_notify

Boolean

参数解释：

使用smn发送通知的开关

取值范围：

• true：发送smn通知

• false：不发送smn通知

threshold

Integer

参数解释：

存储库容量阈值，存储库已用容量和总容量的百分比超过该值，如果smn_notify为开，将发送相关通知

取值范围：

1-100，代表已用容量占总容量的百分比

sys_lock_source_service

String

参数解释：

用于标识SMB服务，支持传入SMB和空

取值范围：

SMB：标识为SMB服务调用

空字符串：表示为普通服务调用

locked

Boolean

参数解释：

用于标识当前存储库是否已锁定，关于备份锁定的详细信息，请参考开启备份锁定

取值范围：

• true：锁定存储库

• false：不锁定存储库

availability_zone

String

参数解释：

存储库可用区信息

取值范围：

长度1~32个字符

allocated

Integer

参数解释：

已分配容量，单位GB

取值范围：

10-10485760

charging_mode

String

参数解释：

计费模式

取值范围：

post_paid：按需，pre_paid：包年包月

cloud_type

String

参数解释：

云类型

取值范围：

public：公有云; hybrid: 混合云

consistent_level

String

参数解释：

存储库规格

取值范围：

app_consistent: 应用一致性，crash_consistent: 崩溃一致性

object_type

String

参数解释：

对象类型

取值范围：

支持"server", "disk", "turbo", "workspace", "vmware", "rds"和"file"共七种。server：云服务器，disk：云硬盘，turbo：文件系统，workspace：云桌面，vmware：VMware，rds：关系型数据库，file：文件。

order_id

String

参数解释：

订单ID

取值范围：

格式为UUID

product_id

String

参数解释：

产品ID

取值范围：

格式为UUID

protect_type

String

参数解释：

保护类型

取值范围：

backup：备份，replication：复制

size

Integer

参数解释：

容量，单位MB

取值范围：

10-10485760

spec_code

String

参数解释：

规格编码

取值范围：

云服务备份存储库：vault.backup.server.normal；云硬盘备份存储库：vault.backup.volume.normal；文件备份存储库：vault.backup.turbo.normal

status

String

参数解释：

存储库状态

取值范围：

• available: 可用

• lock: 锁定

• frozen: 冻结

• deleting: 删除中

• error: 异常

storage_unit

String

参数解释：

存储库桶名

取值范围：

不涉及

used

Integer

参数解释：

已使用容量，单位MB

取值范围：

不涉及

frozen_scene

String

参数解释：

冻结场景，说明具体冻结原因

取值范围：

• POLICE：公安冻结场景

• ARREAR：欠费场景

• ILLEGAL：违规冻结场景

• VERIFY：客户未实名认证冻结场景

• DELETE_ACCOUNT：退订删除场景

is_multi_az

Boolean

参数解释：

存储库是否具有多AZ属性，即底层备份是否为多AZ备份

取值范围：

• true：存储库具有多AZ属性

• false：存储库不具有多AZ属性

extra_info

ResourceExtraInfoResp object

参数解释：

资源附加信息，包括备份时包含的卷或排除的卷等信息

取值范围：

不涉及

id

String

参数解释：

待备份资源id，需要该资源已经绑定到该存储库中，且属于可备份的状态。

获取方法请参见"查询存储库绑定资源信息"，"查询资源可保护性"。

取值范围：

取值范围不涉及

name

String

参数解释：

待备份资源名称。

取值范围：

长度为0~255个字符。

protect_status

String

参数解释：

保护状态

取值范围：

• available: 可用

• error: 异常

• protecting: 保护中

• restoring: 恢复中

• removing: 删除中

size

Integer

参数解释：

资源已分配容量，单位为GB

取值范围：

不涉及

type

String

参数解释：

待备份资源的类型

取值范围：

待备份资源的类型: OS::Nova::Server：云服务器； OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面。

backup_size

Integer

参数解释：

备份副本大小。单位GB。

取值范围：

不涉及

backup_count

Integer

参数解释：

备份副本数量

取值范围：

不涉及

exclude_volumes

Array of strings

参数解释：

需要排除备份的卷ID列表，列表元素为String类型的UUID。

取值范围：

不涉及

tags

Array of BindRulesTags objects

参数解释：

按标签过滤自动绑定的资源

取值范围：

最小长度：0

最大长度：5

key

String

参数解释：

标签的键，用于标识和分类存储库资源

取值范围：

key不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文，字母，数字，“-”，“_”组成。

value

String

参数解释：

标签的值，与键配合使用，用于更精确地标识和分类存储库资源

取值范围：

value不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文，字母，数字，“-”，“_”，“.”组成。

key

String

参数解释：

标签的键，用于标识和分类资源。

key最大长度为36个字符且不能为空字符串，前后空格会被丢弃。

key不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文，字母，数字，“-”，“_”组成。

创建时，如果请求体中存在重复key则报错，如果数据库存在就覆盖。

删除时，允许重复key，如果删除的标签不存在，默认处理成功,删除时不对标签字符集范围做校验。

删除时tags结构体不能缺失，key不能为空，或者空字符串。

取值范围：

不涉及

value

String

参数解释：

标签的值，用于描述存储库资源的具体属性。

添加标签时value必填，删除时选填，最大长度43字符且允许为空，前后空格会自动去除。此外，value不能包含非打印字符及= * < > \ , | /等特殊符号。

取值范围：

不涉及

key

String

参数解释：

系统标签的键

取值范围：

从白名单中取，不能随意定义。

value

String

参数解释：

系统标签的值

取值范围：

目前仅会用到企业项目ID，其中默认的企业项目ID为“0”。

error_code

String

请参见错误码。

error_msg

String

错误信息

200

OK

400

Bad Request