文档首页/ NAT网关 NAT/ API参考（安卡拉区域）/ API（私网NAT网关）/ 中转IP标签管理/ 查询中转IP标签
更新时间：2024-04-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询中转IP标签

功能介绍

  • 查询指定中转IP实例的标签信息。

  • 标签管理服务需要使用该接口查询指定中转IP实例的全部标签数据。

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/transit-ips/{resource_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目的ID。

最小长度：1

最大长度：32

resource_id

是

String

中转IP的ID。

最小长度：36

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：10240

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

request_id

String

请求id。

最小长度：1

最大长度：36

tags

Array of Tag objects

标签。

数组长度：1 - 10
表4 Tag

参数

参数类型

描述

key

String

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

最小长度：1

最大长度：128

value

String

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

最小长度：0

最大长度：255

请求示例

GET  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/b0399473-c352-4d0c-8ff4-cfde719cfde9/tags

响应示例

状态码： 200

查询操作成功。

{
  "request_id" : "80ef5f21-b81a-4546-b23d-84272507d330",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  }, {
    "key" : "key3",
    "value" : "value3"
  } ]
}

状态码

状态码

描述

200

查询操作成功。

错误码

请参见错误码。

父主题： 中转IP标签管理