更新时间:2024-06-28 GMT+08:00
分享

查询规则标签

功能介绍

查询规则标签

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目id,用户支持企业项目后,由企业项目生成的id。

fw_instance_id

String

防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。

offset

Integer

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

limit

Integer

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

HttpGetAclTagResponseData object

获取规则标签数据

表5 HttpGetAclTagResponseData

参数

参数类型

描述

offset

Integer

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

limit

Integer

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

total

Integer

总数

records

Array of TagsVO objects

标签列表

表6 TagsVO

参数

参数类型

描述

tag_id

String

标签id

tag_key

String

标签键

tag_value

String

标签值

请求示例

查询项目id为14181c1245cf4fd786824efe1e2b9388的防火墙id为546af3f8-88e9-47f2-a205-2346d7090925的已有acl标签。

https://{Endpoint}/v2/14181c1245cf4fd786824efe1e2b9388/cfw-acl/tags?limit=1000&offset=0&fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default

响应示例

状态码: 200

查询规则标签返回值

{
  "data" : {
    "limit" : 1000,
    "offset" : 0,
    "records" : [ {
      "tag_id" : "98fdf013-e7ad-4581-9c71-6de04c76a18f",
      "tag_key" : "1",
      "tag_value" : "1"
    }, {
      "tag_id" : "36e6fbfe-7fcd-48be-872b-4f6074e1e4e8",
      "tag_key" : "1",
      "tag_value" : "2"
    }, {
      "tag_id" : "0bf41046-6587-42f2-8399-a6864022b504",
      "tag_key" : "测试",
      "tag_value" : "测试"
    } ],
    "total" : 3
  }
}

状态码

状态码

描述

200

查询规则标签返回值

错误码

请参见错误码

分享:

    相关文档

    相关产品