弹性IP列表查询
功能介绍
弹性IP列表查询
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/eips/protect
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
object_id |
是 |
String |
防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,通过返回值中的data.records.protect_objects.object_id(.表示各对象之间层级的区分)获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。此处仅取type为0的防护对象id,可通过data.records.protect_objects.type(.表示各对象之间层级的区分)获得。 |
key_word |
否 |
String |
查询防护EIP列表关键字,可选用弹性公网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为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0 |
device_key |
否 |
String |
设备关键字,是eip绑定的资产的名称或id |
address_type |
否 |
Integer |
地址类型0 ipv4,1 ipv6 |
fw_instance_id |
否 |
String |
防火墙id,可通过防火墙ID获取方式获取 |
fw_key_word |
否 |
String |
防火墙关键字,可使用防火墙id或名称查询,可通过防火墙ID获取方式 |
eps_id |
否 |
String |
弹性公网ip的企业项目id,可通过如何获取企业项目ID获取,租户未开启企业项目时为0 |
tags |
否 |
String |
标签列表信息可通过查询EIP服务界面列表标签页签获得 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。可通过如何获取用户Token获取。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
EipResponseData object |
查询eip返回data |
参数 |
参数类型 |
描述 |
---|---|---|
limit |
Integer |
每页显示个数,范围为1-1024 |
offset |
Integer |
偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 |
total |
Integer |
查询获得EIP列表总数 |
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 |
Eip所在账户企业项目id |
device_id |
String |
EIP绑定设备(如ecs,nat)id |
device_name |
String |
EIP绑定设备(如ecs,nat)名称 |
device_owner |
String |
EIP绑定设备(如ecs,nat)拥有者 |
associate_instance_type |
String |
关联实例类型,包括:NATGW,ELB,PORT等。 |
fw_instance_name |
String |
防火墙名称 |
fw_instance_id |
String |
防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口。 |
fw_enterprise_project_id |
String |
Eip绑定的防火墙企业项目id |
object_id |
String |
防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,通过返回值中的data.records.protect_objects.object_id(.表示各对象之间层级的区分)获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。此处仅取type为0的防护对象id,可通过data.records.protect_objects.type(.表示各对象之间层级的区分)获得。 |
tags |
String |
标签列表 |
domain_id |
String |
EIP所属用户id,可通过获取账号、IAM用户、项目、用户组、区域、委托的名称和ID获取。 |
fw_domain_id |
String |
防火墙所属用户,可通过获取账号、IAM用户、项目、用户组、区域、委托的名称和ID获取。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
查询项目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请求错误" }
SDK代码示例
SDK代码示例如下。
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; public class ListEipsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); ListEipsRequest request = new ListEipsRequest(); try { ListEipsResponse response = client.listEips(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListEipsRequest() response = client.list_eips(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListEipsRequest{} response, err := client.ListEips(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
EIP数据查询返回值 |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。