查询地址组详细信息_地址组管理_API_API参考（吉隆坡区域）

功能介绍

查询地址组详细

调用方法

URI

GET /v1/{project_id}/address-sets/{set_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，可以从调API处获取，也可以从控制台获取。项目ID获取方式
set_id	是	String	地址组id，可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。

表2 Query参数
参数	是否必选	参数类型	描述
enterprise_project_id	否	String	企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，用户未开启企业项目时为0
fw_instance_id	否	String	防火墙ID，可通过防火墙ID获取方式获取
query_address_set_type	否	Integer	查询地址组类型，0表示自定义地址组，1表示预定义地址组

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。可通过如何获取用户Token获取。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
data	data object	查询地址组详情数据

表5 data
参数	参数类型	描述
id	String	地址组id
name	String	地址组名称
description	String	地址组描述
address_set_type	Integer	地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组
address_type	Integer	地址类型0 ipv4，1 ipv6

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

查询项目id为9d80d070b6d44942af73c9c3d38e0429，地址组id为cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16的地址组的详情

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16

响应示例

状态码：200

查询地址组细节返回体

{
  "data" : {
    "address_set_type" : 0,
    "address_type" : 0,
    "description" : "",
    "id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16",
    "name" : "ABC"
  }
}

状态码：400

Bad Request，错误的请求

{
  "error_code" : "CFW.00200005",
  "error_msg" : "操作内容不存在"
}

状态码

状态码	描述
200	查询地址组细节返回体
400	Bad Request，错误的请求
401	Unauthorized，错误的请求
403	Forbidden，禁止访问
404	Not Found，网页未找到
500	Internal Server Error

错误码

请参见错误码。

查询地址组详细信息