查询中转IP实例ListTransitIpsByTags_中转IP标签管理

华为云计算云知识查询中转IP实例ListTransitIpsByTags

新客秒杀 2核2G 3M L实例

68元/年

普惠上云领千元上云礼券

立即前往

企业专享 X实例 4核8G 5M

888元/年

热门域名 1元随心购

1元/年起

查询中转IP实例ListTransitIpsByTags

时间: 2023-10-12 15:21:59

API网关云计算

猜你想看：

实时语音识别云服务器配置 CDN是什么意思视频点播加速什么是云桌面

接口说明

使用标签过滤中转IP实例。
标签管理服务需要提供按标签过滤中转IP服务实例并汇总显示在列表中,需要中转IP服务提供查询能力。

URL

POST https://nat.cn-north-4.myhuaweicloud.com/v3/{project_id}/transit-ips/resource_instances/action

请求参数

名称	类型	IN	必选	描述
X-Auth-Token	string	header	是	用户Token。用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。
project_id	string	path	是	项目的ID。

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只需按照条件将总条数返回即可。
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是或的关系。无过滤条件时返回全量数据。

参数：

matches

名称	类型	必选	描述
key	string	是	搜索条件key值。
value	string	是	搜索条件value。

参数：

not_tags

名称	类型	必选	描述
key	string	是	键。最大长度128个unicode字符。搜索时不对此参数做校验,key不能为空或者空字符串,不能为空格,校验和使用之前先trim 前后空格。
values	Array of strings	是	值列表。每个值最大长度255个unicode字符。

参数：

tags

名称	类型	必选	描述
key	string	是	键。最大长度128个unicode字符。搜索时不对此参数做校验,key不能为空或者空字符串,不能为空格,校验和使用之前先trim 前后空格。
values	Array of strings	是	值列表。每个值最大长度255个unicode字符。

参数：

tags_any

名称	类型	必选	描述
key	string	是	键。最大长度128个unicode字符。搜索时不对此参数做校验,key不能为空或者空字符串,不能为空格,校验和使用之前先trim 前后空格。
values	Array of strings	是	值列表。每个值最大长度255个unicode字符。

参数：

not_tags_any

名称	类型	必选	描述
key	string	是	键。最大长度128个unicode字符。搜索时不对此参数做校验,key不能为空或者空字符串,不能为空格,校验和使用之前先trim 前后空格。
values	Array of strings	是	值列表。每个值最大长度255个unicode字符。

返回参数

返回码: 200

查询操作成功。
示例1:action为count时的响应体
示例2:action为filter时的响应体

名称	类型	必选	描述
resources	Array of Resource objects	是	资源列表。
request_id	string	是	请求id。
total_count	integer	是	总记录数。

200 resources

名称	类型	必选	描述
resource_detail	resource_detail object	是	资源详情。用于扩展。默认为空。
resource_id	string	是	资源的ID。
resource_name	string	是	资源名称,资源没有名称时默认为空字符串。
resource_tag	Array of ResourceTag objects	是	标签列表,没有标签默认为空数组。

200 resources.resource_tag

名称	类型	必选	描述
key	string	是	标签key值。
value	string	是	标签value。

请求示例

示例 1

action为filter的请求体。

"POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/resource_instances/action"

{ "offset": "10", "limit": "10", "action": "filter", "matches": [ { "key": "resource_name", "value": "resource1" } ], "not_tags": [ { "key": "key1", "values": [ "*value1", "value2" ] } ], "tags": [ { "key": "key1", "values": [ "*value1", "value2" ] } ], "tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ], "not_tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ] }

示例 2

action为count的请求体。

"POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/resource_instances/action"

{ "action": "count", "not_tags": [ { "key": "key1", "values": [ "value1", "*value2" ] } ], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ], "not_tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "resource_name", "value": "resource1" } ] }

返回示例

返回码：200

查询操作成功。
示例1:action为count时的响应体
示例2:action为filter时的响应体

示例 1

{
"request_id": "d70aabc854d3d301f9bb106e6b70ac99",
"total_count": 100
}

示例 2

{
"resources": [
{
"resource_detail": null,
"resource_id": "ae33be9b-d2c0-441b-a8d0-f6dafedf1778",
"resource_name": "transit_ips",
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value1"
}
]
}
],
"request_id": "9e47d9476cfd346f864cb77acb274185",
"total_count": 1
}

SDK

点击 NAT网关 (NAT) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

错误码

请参考错误码说明。

上一篇：《财政数字化最佳实践白皮书》主要内容是什么？下一篇：Pod中使用ConfigMap的方法