查询地址组列表
功能介绍
查询地址组列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/address-sets
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户项目id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
object_id |
是 |
String |
互联网边界防护对象id，可通过调用查询防火墙实例接口，type为0的为互联网边界防护对象id。 |
|
key_word |
否 |
String |
关键字 |
|
limit |
是 |
Integer |
每页显示个数，范围为1-1024 |
|
offset |
是 |
Integer |
偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
|
address |
否 |
String |
ip地址 |
|
address_type |
否 |
Integer |
地址类型0 ipv4,1 ipv6 |
|
enterprise_project_id |
否 |
String |
企业项目id，用户支持企业项目后，由企业项目生成的id。 |
|
fw_instance_id |
否 |
String |
防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。 |
|
query_address_set_type |
否 |
Integer |
查询地址组类型，0表示自定义地址组，1表示预定义地址组，当address_set_type不为0时，query_address_set_type为1时才可以生效。 |
|
address_set_type |
否 |
Integer |
地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
查询地址组列表返回数据 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
offset |
Integer |
偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
|
limit |
Integer |
每页显示个数，范围为1-1024 |
|
total |
Integer |
总数 |
|
records |
Array of records objects |
地址组列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
set_id |
String |
地址组id |
|
ref_count |
Integer |
引用次数 |
|
description |
String |
描述信息 |
|
name |
String |
地址组名称 |
|
address_type |
Integer |
地址类型0 ipv4,1 ipv6 |
|
object_id |
String |
互联网边界防护对象id，可通过调用查询防火墙实例接口，type为0的为互联网边界防护对象id。 |
|
address_set_type |
Integer |
地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
响应体 |
|
trace_id |
String |
trace id |
请求示例
查询项目id为5c69cf330cda42369cbd726ee1bc5e76，防护对象id为8a41d6a5-f215-428a-a76c-dc923b5d599a的第一页的ip地址组信息
https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/address-sets?object_id=8a41d6a5-f215-428a-a76c-dc923b5d599a&limit=10&offset=0
响应示例
状态码： 200
OK
{
"data" : {
"limit" : 10,
"offset" : 0,
"records" : [ {
"address_set_type" : 0,
"object_id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16",
"address_type" : 0,
"description" : "",
"name" : "test",
"ref_count" : 0,
"set_id" : "50da1eff-e58d-4380-b899-a78f94137d3b"
} ],
"total" : 1
}
}
状态码： 400
Bad Request
{
"error_code" : "CFW.0020016",
"error_msg" : "实例状态错误"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
