NAT网关 NAT-查询公网NAT网关资源实例:请求参数

时间:2023-11-01 16:19:21

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

表3 请求Body参数

参数

是否必选

参数类型

描述

tags

Array of Tag objects

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

tags_any

Array of Tag objects

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

not_tags

Array of Tag objects

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

not_tags_any

Array of Tag objects

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

limit

String

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

offset

String

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

action

String

  • 操作标识(仅限于filter,count):filter(过滤),count(查询总条数)

  • 如果是filter就是分页查询,如果是count只需按照条件将总条数返回即可。禁止返回其他字段。

matches

Array of Match objects

  • 搜索字段列表,key为要匹配的字段,如resource_name等。value为匹配的值。此字段为固定字典值。

  • 根据不同的字段确认是否需要模糊匹配,如resource_name默认为模糊搜索(不区分大小写),如果value为空字符串精确匹配。resource_id为精确匹配。

表4 Tag

参数

是否必选

参数类型

描述

key

String

键。最大长度127个unicode字符。key不能为空。(搜索时不对此参数做校验) ,key不能为空或者空字符串,不能为空格,校验和使用之前先trim 前后空格。

values

Array of strings

  • 值列表。每个值最大长度255个unicode字符,不能为空格,校验和使用之前先trim 前后空格。

  • *为系统保留字符,value可为空但不可缺省。

  • 如果里面的value是以*开头表示按照*后面的值全模糊匹配。

  • 如果values为空列表,则表示any_value(查询任意value)。value之间为或的关系。

表5 Match

参数

是否必选

参数类型

描述

key

String

键。限定为resource_name。

value

String

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

support.huaweicloud.com/api-natgateway/ListNatsByTags.html