查询弹性公网IP列表
功能介绍
查询当前局点下用户所有弹性公网IP的列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/publicips
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取项目ID请参见获取项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
marker |
否 |
String |
最大长度:36 |
limit |
否 |
Integer |
最小值:0 |
ip_version |
否 |
Integer |
枚举值:
|
enterprise_project_id |
否 |
String |
关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。 |
port_id |
否 |
Array |
|
public_ip_address |
否 |
Array |
|
private_ip_address |
否 |
Array |
|
id |
否 |
Array |
|
allow_share_bandwidth_type_any |
否 |
Array |
|
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
publicips |
Array of PublicipShowResp objects |
弹性公网IP对象 |
参数 |
参数类型 |
描述 |
---|---|---|
bandwidth_id |
String |
最大长度:36 |
bandwidth_name |
String |
最小长度:1 最大长度:64 |
bandwidth_share_type |
String |
枚举值:
|
bandwidth_size |
Integer |
|
create_time |
String |
|
enterprise_project_id |
String |
关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。 最大长度:36 |
id |
String |
最大长度:36 |
port_id |
String |
最大长度:36 |
private_ip_address |
String |
|
profile |
ProfileResp object |
|
public_ip_address |
String |
最大长度:15 |
status |
String |
枚举值:
|
tenant_id |
String |
最大长度:36 |
type |
String |
最大长度:36 |
public_ipv6_address |
String |
最大长度:39 |
ip_version |
Integer |
枚举值:
|
public_border_group |
String |
最小长度:1 最大长度:64 |
allow_share_bandwidth_types |
Array of strings |
最大长度:64 |
alias |
String |
最大长度:64 |
请求示例
GET https://{Endpoint}/v1/{project_id}/publicips?limit=2&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d
响应示例
状态码: 200
GET操作正常返回
{ "publicips" : [ { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "bandwidth_name" : "bandwidth-test", "public_ip_address" : "161.xx.xx.9", "create_time" : "2015-07-16 04:22:32", "profile" : { "user_id" : "35f2b308f5d64441a6fa7999fbcd4321", "product_id" : "00301-48027-0--0", "region_id" : "xxx", "order_id" : "xxxxxxxxx" }, "type" : "5_bgp", "bandwidth_id" : "3fa5b383-5a73-4dcb-a314-c6128546d855", "bandwidth_size" : 5, "enterprise_project_id" : "b261ac1f-2489-4bc7-b31b-c33c3346a439", "ip_version" : 4, "private_ip_address" : "192.168.10.5", "bandwidth_share_type" : "PER", "id" : "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0", "status" : "ACTIVE", "port_id" : "4977b983-cd4f-4ecc-93a1-cb52d848a9b3", "public_border_group" : "center", "allow_share_bandwidth_types" : [ "share" ] }, { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "bandwidth_name" : "bandwidth-test1", "public_ip_address" : "161.xx.xx.10", "create_time" : "2015-07-16 04:23:03", "profile" : { }, "type" : "5_bgp", "bandwidth_id" : "a79fd11a-047b-4f5b-8f12-99c178cc780a", "bandwidth_size" : 5, "enterprise_project_id" : "0", "ip_version" : 4, "bandwidth_share_type" : "PER", "id" : "80d5b82e-43b9-4f82-809a-37bec5793bd4", "status" : "DOWN", "public_border_group" : "center", "allow_share_bandwidth_types" : [ "share" ] } ] }
SDK代码示例
SDK代码示例如下。
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 48 49 50 51 52 53 54 55 56 |
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.eip.v2.region.EipRegion; import com.huaweicloud.sdk.eip.v2.*; import com.huaweicloud.sdk.eip.v2.model.*; import java.util.List; import java.util.ArrayList; public class ListPublicipsSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("<YOUR REGION>")) .build(); ListPublicipsRequest request = new ListPublicipsRequest(); request.withMarker("<marker>"); request.withLimit(<limit>); request.withIpVersion(ListPublicipsRequest.IpVersionEnum.NUMBER_<ip_version>); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withPortId(); request.withPublicIpAddress(); request.withPrivateIpAddress(); request.withId(); request.withAllowShareBandwidthTypeAny(); try { ListPublicipsResponse response = client.listPublicips(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()); } } } |
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkeip.v2.region.eip_region import EipRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeip.v2 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"] credentials = BasicCredentials(ak, sk) client = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListPublicipsRequest() request.marker = "<marker>" request.limit = <limit> request.ip_version = <ip_version> request.enterprise_project_id = "<enterprise_project_id>" request.port_id = request.public_ip_address = request.private_ip_address = request.id = request.allow_share_bandwidth_type_any = response = client.list_publicips(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := eip.NewEipClient( eip.EipClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListPublicipsRequest{} markerRequest:= "<marker>" request.Marker = &markerRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest ipVersionRequest:= model.GetListPublicipsRequestIpVersionEnum().<IP_VERSION> request.IpVersion = &ipVersionRequest enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest response, err := client.ListPublicips(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
GET操作正常返回 |
错误码
请参见错误码。