查询地址组成员
功能介绍
查询地址组成员
URI
GET /v1/{project_id}/address-items
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
set_id | 是 | String | 地址组id，可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 |
key_word | 否 | String | 关键字，包括地址组成员名称或描述的一部分 |
limit | 是 | Integer | 每页显示个数，范围为1-1024 |
offset | 是 | Integer | 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
address | 否 | String | ip地址 |
enterprise_project_id | 否 | String | 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 |
fw_instance_id | 否 | String | 防火墙id，可通过防火墙ID获取方式获取 |
query_address_set_type | 否 | Integer | 查询地址组类型，0表示自定义地址组，1表示预定义地址组 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。可通过如何获取用户Token获取。 |
Content-Type | 是 | String | 内容类型，只有application/json的值是适用的 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
data | data object | 查询地址组成员返回数据 |
参数 | 参数类型 | 描述 |
|---|---|---|
offset | Integer | 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
limit | Integer | 每页显示个数，范围为1-1024 |
total | Integer | 地址组成员总数 |
set_id | String | 地址组id |
records | Array of records objects | 地址组成员记录列表 |
参数 | 参数类型 | 描述 |
|---|---|---|
item_id | String | 地址组成员id |
name | String | 地址组成员name |
description | String | 描述 |
address_type | Integer | 地址Internet协议类型0 ipv4，1 ipv6 |
address | String | 地址信息 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
请求示例
查询项目id为9d80d070b6d44942af73c9c3d38e0429的项目的地址组id为8773c082-2a6c-4529-939a-edc28ef1a67c的地址组成员信息
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?set_id=8773c082-2a6c-4529-939a-edc28ef1a67c&limit=10&offset=0 响应示例
状态码：200
查询地址组成员返回值
{
"data" : {
"limit" : 10,
"offset" : 0,
"records" : [ {
"address" : "1.1.1.1",
"address_type" : 0,
"description" : "",
"item_id" : "294fab71-34bf-4858-a380-8f7530e1c816"
} ],
"set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c",
"total" : 1
}
} 状态码：400
Bad Request
{
"error_code" : "CFW.00200005",
"error_msg" : "操作内容不存在"
} 状态码
状态码 | 描述 |
|---|---|
200 | 查询地址组成员返回值 |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
错误码
请参见错误码。
