更新时间:2024-03-30 GMT+08:00

查询中转IP项目标签

功能介绍

  • 查询租户在指定Project的所有中转IP标签集合。

  • 标签管理服务需要能够列出当前租户全部已使用的中转IP标签集合,为打中转IP标签和过滤中转IP实例时提供标签联想功能。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目的ID。

最小长度:1

最大长度:32

请求参数

表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 Tags objects

标签。

数组长度:1 - 10

表4 Tags

参数

参数类型

描述

key

String

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

最小长度:1

最大长度:128

values

Array of strings

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

最小长度:0

最大长度:255

请求示例

GET  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/tags

响应示例

状态码: 200

查询操作成功。

{
  "request_id" : "36479272a29de0be0a8a8b294c02ab7a",
  "tags" : [ {
    "key" : "keys",
    "values" : [ "value" ]
  }, {
    "key" : "key3",
    "values" : [ "value3", "value33" ]
  }, {
    "key" : "key1",
    "values" : [ "value1" ]
  }, {
    "key" : "key2",
    "values" : [ "value2", "value22" ]
  } ]
}

状态码

状态码

描述

200

查询操作成功。

错误码

请参见错误码