云备份 CBR-查询存储库资源实例:请求参数

时间:2024-05-11 14:26:54

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

Boolean

不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。

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

不包含任一标签。

tags不允许为空列表。

tags中最多包含10个key。

tags中key不允许重复。

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

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

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

查询记录数(action为count时无此参数)如果action为filter时,默认为1000,limit最小值为1,limit最大值为1000, 不在范围内报错。返回的结果中记录数不超过limit。

offset

String

索引位置(action为count时无此参数)如果action为filter时,默认为0,offset最小值为0。返回的结果中第一条记录为符合查询条件的第offset+1条记录。

action

String

操作标识取值范围为:"filter", "count"。如果是filter就是分页查询,如果是count只需按照条件将总条数返回即可

matches

Array of Match objects

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

matches中key不允许重复。

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

数组长度:0 - 1

cloud_type

String

云类型

  • public: 公有云

  • hybrid: 混合云

object_type

String

资源类型

  • server: 云服务器

  • disk: 云硬盘

表3 TagsReq

参数

是否必选

参数类型

描述

key

String

键。

最大长度127个unicode字符。

不允许为空字符串。

前后的空格会被丢弃。

values

Array of strings

值列表。

values中最多包含10个value。

每个value最大长度255个unicode字符。前后的空格会被丢弃。

values中value不允许重复。

values中多个value之间是"或"的关系。

values允许为空列表,value允许为空字符串。

values如果为空列表,表示任意值。

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

表4 SysTags

参数

是否必选

参数类型

描述

key

String

键。 系统标签的key,从白名单中取,不能随意定义。 目前仅支持 _sys_enterprise_project_id字段,对应 的value为企业项目ID。

values

Array of strings

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

表5 Match

参数

是否必选

参数类型

描述

key

String

键。 key取值范围为:"resource_name",资源名称

value

String

值。 最大长度255个字符。 key为"resource_name"时,value为空字符串时精确匹配,为非空字符串时模糊匹配。

support.huaweicloud.com/api-cbr/ShowVaultResourceInstances.html