API网关 APIG-通过标签查询实例列表:请求参数

时间:2024-06-27 11:06:26

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表4 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

Boolean

不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”字段。 该字段为false或者未提供该参数时,该条件不生效。

tags

Array of TmsKeyValues objects

包含标签,最多包含20个key,每个key下面的value最多20个。无tag过滤条件时返回全量数据。

数组长度:0 - 20

sys_tags

Array of TmsKeyValues objects

企业项目.仅op_service权限可以使用此字段做资源实例过滤条件. 无sys_tags时按照tag接口处理,无tag过滤条件时返回全量数据。

数组长度:0 - 1

matches

Array of TmsMatchesKeyValue objects

搜索字段,key为要匹配的字段,当前限定为resource_name。value为匹配的值。 根据key的值确认是否需要模糊匹配,如resource_name需要实现前缀搜索。

表5 TmsKeyValues

参数

是否必选

参数类型

描述

key

String

键。

支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : = + - @; _sys_开头属于系统标签,租户不能输入

最小长度:1

最大长度:128

values

Array of strings

值。

支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @

表6 TmsMatchesKeyValue

参数

是否必选

参数类型

描述

key

String

要匹配的字段

  • resource_name 表示按照APIG实例的名称去匹配

枚举值:

  • resource_name

value

String

值。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @

最大长度:255

support.huaweicloud.com/api-apig/ListInstancesByTags.html