查询地址组成员
功能介绍
查询地址组成员
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/address-items
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 租户项目id |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| set_id | 是 | String | 地址组id |
| key_word | 否 | String | 关键字 |
| limit | 是 | Integer | 每页显示个数，范围为1-1024 |
| offset | 是 | Integer | 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
| address | 否 | String | ip地址 |
| 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表示预定义地址组 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码： 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 | 地址组类型，0 ipv4,1 ipv6 |
| address | String | 地址组 |
状态码： 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | data object | 响应体 |
| trace_id | String | trace id |
请求示例
查询项目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 |
错误码
请参见错误码。
