专属主机 DEH-按标签查询专属主机列表:请求消息

时间:2025-02-18 11:03:54

请求消息

表2 请求参数

参数

参数类型

是否必选

描述

tags

Array of objects

查询包含所有指定标签的专属主机。更多信息,请参见表3

  • 最多包含10个key,每个key下面的value最多10个。
  • 结构体不能缺失。
  • key不能为空或者空字符串。
  • key不能重复。
  • 同一个key中value不能重复。

not_tags

Array of objects

查询不包含所有指定标签的专属主机。更多信息,请参见表3

  • 最多包含10个key,每个key下面的value最多10个。
  • 结构体不能缺失。
  • key不能为空或者空字符串。
  • Key不能重复。
  • 同一个key中value不能重复。

limit

Integer

查询返回的专属主机数量限制,最多为1000,不能为负数。

  • 如果action的值为count,此参数无效。
  • 如果action的值为filter,limit默认为1000。

offset

Integer

索引位置,从offset指定的下一条数据开始查询。必须为数字,不能为负数。

查询第一页数据时,不需要传入此参数。查询后续页码数据时,将查询前一页数据时响应体中的值带入此参数。

  • 如果action的值为count,此参数无效。
  • 如果action的值为filter,offset默认为0。

action

String

操作标识,包括filter和count两种。

  • filter:表示按标签过滤专属主机,返回符合条件的专属主机列表。此时,为分页查询。
  • count:表示按标签搜索专属主机,返回符合条件的专属主机个数。

tags_any

Array of objects

包含任意标签。更多信息,请参见表3

  • 最多包含10个key,每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。
  • key不能重复,同一个key中value不能重复。
  • 结果返回包含标签的资源列表,key之间是“或”的关系,key-value结构中value是“或”的关系。
  • 无过滤条件时返回全量数据。

not_tags_any

Array of objects

不包含任意标签。更多信息,请参见表3

  • 最多包含10个key,每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。
  • key不能重复,同一个key中value不能重复。
  • 结果返回不包含标签的资源列表,key之间是“或”的关系,key-value结构中value是或的关系。
  • 无过滤条件时返回全量数据。

matches

Array of objects

搜索字段,用于按条件搜索专属主机。

当前仅支持按resource_name进行搜索。更多信息,请参见表4

表3 tag字段数据结构说明

参数

参数类型

是否必选

描述

key

String

键。

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

values

Array of strings

值列表。

  • 最多10个value。
  • value不允许重复。
  • 每个值最大长度255个unicode字符。
  • 如果value缺失则表示any_value。
  • value之间为“或”的关系。
表4 match字段数据结构说明

参数

参数类型

是否必选

描述

key

String

键,表示要匹配的字段。

  • key不能重复,value为匹配的值。
  • 此字段为固定字典值。
  • 不允许为空字符串。
说明:

当前key的参数值仅支持resource_name,此时value的参数值为专属主机名称。

value

String

值。

  • 每个值最大长度为255个unicode字符。
  • 不可以为空 。
support.huaweicloud.com/api-deh/deh_05_0904.html