更新时间:2025-11-21 GMT+08:00

查询标签信息

功能介绍

查询标签信息

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/cfw-cfw/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,可以从调API处获取,也可以从控制台获取。可通过项目ID获取方式获取

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页显示个数,范围为1-1024

offset

Integer

偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,用户未开启企业项目时为0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,可通过如何获取用户Token获取

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

tags

Array of TagValue objects

tag列表

表5 TagValue

参数

参数类型

描述

key

String

tag键

value

Array of strings

tag值

请求示例

查询防火墙ID为e743cfaf-8164-4807-aa13-d893d83313cf的标签信息

https://{Endpoint}/v2/408972e72dcd4c1a9b033e955802a36b/cfw-cfw/tags?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4

响应示例

状态码:200

查询标签返回值

{
  "tags" : [ {
    "key" : "test",
    "value" : [ "1" ]
  }, {
    "key" : "tag_zjw-1",
    "value" : [ "1" ]
  } ]
}

状态码

状态码

描述

200

查询标签返回值

401

Unauthorized,错误的请求

403

Forbidden,禁止访问

404

Not Found,网页未找到

错误码

请参见错误码