云专线 DC-通过标签查询资源实例:请求参数

时间:2023-11-20 09:20:00

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

offset

String

索引位置, 从offset指定的下一条数据开始查询。 查询第一页数据时,不需要传入此参数,查询后续页码数据时,将查询前一页数据时响应体中的值带入此参数(action为count时无此参数)如果action为filter默认为0,必须为数字,不能为负数

limit

String

查询记录数(action为count时无此参数)如果action为filter默认为1000,limit最多为1000,不能为负数,最小值为1

action

String

操作标识(仅限于filter,count):filter(过滤),count(查询总条数) 如果是filter就是分页查询,如果是count只需按照条件将总条数返回即可。禁止返回其他字段。

枚举值:

  • filter
  • count

matches

Array of Match objects

搜索字段,key为要匹配的字段,如resource_name等。value为匹配的值。此字段为固定字典值。根据不同的字段确认是否需要模糊匹配,如resource_name默认为模糊搜索(不区分大小写),如果value为空字符串精确匹配。resource_id为精确匹配。第一期只做resource_name,后续在扩展。

not_tags

Array of Tags objects

不包含标签,最多包含10个key,每个key下面的value最多10个, 结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回不包含标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。

tags

Array of Tags objects

包含标签,最多包含10个key,每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。

tags_any

Array of Tags objects

包含任意标签,最多包含10个key,每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回包含标签的资源列表,key之间是或的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。

not_tags_any

Array of Tags objects

不包含任意标签,最多包含10个key,每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回不包含标签的资源列表,key之间是或的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。

sys_tags

Array of Tags objects

仅op_service权限可以使用此字段做资源实例过滤条件。目前TMS调用时只包含一个tag结构体。key:_sys_enterprise_project_id,value:企业项目id列表。目前TMS调用时,key下面只包含一个value。0表示默认企业项目。sys_tags和租户标签过滤条件(without_any_tag 、tags、tags_any、not_tags、not_tags_any)不能同时使用。

表3 Match

参数

是否必选

参数类型

描述

key

String

键。取值范围为包括dc-directconnect/dc-vgw/dc-vif

value

String

值。每个值最大长度255个unicode字符。

表4 Tags

参数

是否必选

参数类型

描述

key

String

键。最大长度127个unicode字符。 key不能为空。

values

Array of strings

值列表。每个值最大长度255个unicode字符。

support.huaweicloud.com/api-dc/ListTagResourceInstances.html