弹性IP列表查询
功能介绍
弹性IP列表查询
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/eips/protect
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
object_id |
是 |
String |
防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。 |
|
key_word |
否 |
String |
弹性公网ID/弹性公网IP |
|
status |
否 |
String |
防护状态 null-全部 0-开启防护 1-关闭防护 |
|
sync |
否 |
Integer |
是否同步租户EIP数据 0-不同步 1-同步 |
|
limit |
是 |
Integer |
每页显示个数，范围为1-1024 |
|
offset |
是 |
Integer |
偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
|
enterprise_project_id |
否 |
String |
企业项目id，用户支持企业项目后，由企业项目生成的id。 |
|
device_key |
否 |
String |
设备键 |
|
address_type |
否 |
Integer |
地址类型0 ipv4,1 ipv6 |
|
fw_instance_id |
否 |
String |
防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。 |
|
fw_key_word |
否 |
String |
所绑定防火墙id防火墙名称 |
|
eps_id |
否 |
String |
弹性公网ip的企业项目id |
|
tags |
否 |
String |
标签列表信息 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
EipResponseData object |
查询eip返回data |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
limit |
Integer |
每页显示个数，范围为1-1024 |
|
offset |
Integer |
偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
|
total |
Integer |
总数 |
|
records |
Array of EipResource objects |
eip资源记录 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
弹性公网ID |
|
public_ip |
String |
弹性公网IP |
|
status |
Integer |
EIP防护状态，0表示防护中，1表示未防护 |
|
public_ipv6 |
String |
弹性公网IP,IPV6 |
|
enterprise_project_id |
String |
企业项目id |
|
device_id |
String |
设备id |
|
device_name |
String |
设备名称 |
|
device_owner |
String |
设备拥有者 |
|
associate_instance_type |
String |
关联实例类型 |
|
fw_instance_name |
String |
防火墙名称 |
|
fw_instance_id |
String |
防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口。 |
|
fw_enterprise_project_id |
String |
Eip绑定的防火墙企业项目id |
|
object_id |
String |
防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。 |
|
tags |
String |
标签列表 |
|
domain_id |
String |
EIP所属用户 |
|
owner |
String |
所属用户的名称 |
|
fw_domain_id |
String |
防火墙所属用户 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
响应体 |
|
trace_id |
String |
trace id |
请求示例
查询项目id为9d80d070b6d44942af73c9c3d38e0429，防护对象id为cfebd347-b655-4b84-b938-3c54317599b2，非同步的第一页的数据
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/eips/protect?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&sync=0
响应示例
状态码： 200
EIP数据查询返回值
{
"data" : {
"limit" : 200,
"offset" : 0,
"records" : [ {
"associate_instance_type" : "PORT",
"device_id" : "c87579ab-c76a-4afd-83ce-62e0f531f13e",
"device_name" : "test",
"device_owner" : "compute:test",
"domain_id" : "7d07807209524a4280266db9df63c4fa",
"enterprise_project_id" : "0",
"fw_domain_id" : "7d07807209524a4280266db9df63c4fa",
"fw_enterprise_project_id" : "default",
"fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925",
"fw_instance_name" : "test",
"id" : "465b34fe-e017-4831-a21c-9c6c753bb1f2",
"object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b",
"public_ip" : "100.85.223.15",
"status" : 0,
"tags" : "combined_order_id=CBRCS23040615138M2KW912"
} ],
"total" : 1
}
}
状态码： 400
Bad Request
{
"error_code" : "CFW.00109004",
"error_msg" : "HTTP请求错误"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
EIP数据查询返回值 |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
