# 查询弹性公网IP详情 - ShowPublicip #### 功能介绍 查询单条指定的弹性公网IP详细信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=ShowPublicip&version=v3)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v3/{project_id}/eip/publicips/{publicip_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | - 参数解释：项目ID。[请参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html) - 取值范围：不涉及 最大长度：**32** | | publicip_id | 是 | String | 弹性公网IP的ID 最大长度：**36** | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | fields | 否 | Array of strings | - 功能说明：查询字段，形式为"fields=id\&fields=owner\&..." - 支持字段：id/project_id/ip_version/type/public_ip_address/public_ipv6_address/network_type/status/description/created_at/updated_at/vnic/bandwidth/associate_instance_type/associate_instance_id/lock_status/billing_info/tags/enterprise_project_id/publicip_pool_name/allow_share_bandwidth_types/alias/publicip_pool_id/public_border_group 数组长度：**0 - 999** | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 本次请求的编号 | | publicip | [PublicipSingleShowResp] object | 功能说明：弹性公网IP对象 | 表4PublicipSingleShowResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 功能说明：弹性公网IP唯一标识 | | project_id | String | - 功能说明：项目ID | | ip_version | Integer | - 功能说明：IP版本信息 - 取值范围： - 4：公网IP地址为public_ip_address地址 - 6：公网IP地址为public_ipv6_address地址 | | public_ip_address | String | - 功能说明：弹性公网IP或者IPv6端口的地址 - 约束与限制：双栈（type=DUALSTACK）时会返回0.0.0.0，非正常EIPv4地址 | | public_ipv6_address | String | - 功能说明：IPv4时无此字段，IPv6时为申请到的弹性公网IP地址 | | network_type | String | - 功能说明：弹性公网IP的网络类型。废弃，功能由publicip_pool_name继承，默认不显示 | | status | String | - 功能说明：弹性公网IP的状态 - 取值范围： - FREEZED：冻结 - BIND_ERROR：绑定失败 - BINDING：绑定中 - PENDING_DELETE：释放中 - PENDING_CREATE：创建中 - NOTIFYING：创建中 - NOTIFY_DELETE：释放中 - PENDING_UPDATE：更新中 - DOWN：未绑定 - ACTIVE：绑定 - ELB：绑定ELB - VPN：绑定VPN - ERROR：失败 | | description | String | - 功能说明：弹性公网IP描述信息 - 约束与限制：用户以自定义方式标识资源，系统不感知 | | public_border_group | String | - 功能说明：表示中心站点资源或者边缘站点资源 - 取值范围： center、边缘站点名称 - 约束与限制：publicip只能绑定该字段相同的资源 | | created_at | String | - 功能说明：资源创建UTC时间 - 格式：yyyy-MM-ddTHH:mm:ssZ | | updated_at | String | - 功能说明：资源更新UTC时间 - 格式：yyyy-MM-ddTHH:mm:ssZ | | type | String | - 参数解释：弹性公网IP类型。 - 约束限制：不涉及 - 取值范围： - EIP：IPV4类型的弹性公网IP。 - DUALSTACK：IPV6类型的弹性公网IP。 - 默认取值：不涉及 | | vnic | [VnicInfo] object | - 功能说明：公网IP绑定实例有PORT时，PORT的相关信息 - 约束与限制：如果绑定的实例不依赖PORT，该对象为null | | bandwidth | [PublicipBandwidthInfo] object | 功能说明：公网IP绑定带宽信息 | | enterprise_project_id | String | 功能说明：企业项目ID。最大长度36字节,带"-"连字符的UUID格式，或者是字符串"0"。创建弹性公网IP时，给弹性公网IP绑定企业项目ID。 | | billing_info | String | - 功能说明：公网IP的订单信息 - 约束与限制：包周期才会有订单信息，按需资源此字段为空 | | lock_status | String | - 功能说明：记录公网IP当前的冻结状态 - 约束与限制：metadata类型，标识欠费冻结、公安冻结 - 取值范围： - police 公安冻结 - locked 资源加锁 | | associate_instance_type | String | - 功能说明：公网IP绑定的实例类型，可以根据associate_instance_type字段过滤 - 取值范围： - PORT（云服务器实例类型，云服务器通常包括ECS、BMS、CCE等） - NATGW（NAT网关实例类型） - ELB（弹性负载均衡ELB实例类型） - ELBV1（弹性负载均衡ELBV1实例类型，存量经典型ELBv1） - VPN（虚拟专用网络VPN实例类型） | | associate_instance_id | String | - 功能说明：公网IP绑定的实例ID | | publicip_pool_id | String | - 功能说明：公网IP所属网络的ID，publicip_pool_name对应的网络ID | | publicip_pool_name | String | - 功能说明：弹性公网IP的网络类型, 包括公共池类型，如5_bgp/5_sbgp...，和用户购买的专属池。 - 专属池见publicip_pool相关接口 | | alias | String | - 功能说明：弹性公网IP名称 | | profile | [ProfileInfo] object | - 功能说明：公网IP、元数据。（默认不显示） | | fake_network_type | Boolean | - 参数解释：该字段仅仅用于表示eip的bgp类型是否是真实的静态sbgp。 - 约束限制：不涉及 - 取值范围： - TRUE：该eip可以切换bgp类型。 - FALSE：该eip不可以切换bgp类型。（默认不显示）。 - 默认取值：不涉及 | | tags | Array of strings | - 功能说明：用户标签。 数组长度：**0 - 9999** | | associate_instance_metadata | String | - 功能说明：记录实例的更上一层归属。例如associate_instance_type为PORT，此字段记录PORT的device_id和device_owner信息。仅有限场景记录。（默认不显示） | | associate_mode | String | - 功能说明：开启支持直通模式后展示，表示直通模式的标识。（默认不显示） 最小长度：**1** 最大长度：**36** | | allow_share_bandwidth_types | Array of strings | - 功能说明：表示此publicip可以加入的共享带宽类型列表，如果为空列表，则表示该publicip不能加入任何共享带宽 - 约束与限制：publicip只能加入到有该带宽类型的共享带宽中 最大长度：**64** 数组长度：**0 - 9999** | | cascade_delete_by_instance | Boolean | - 功能说明：表示该eip是否支持与实例同步删除。（默认不显示） | 表5VnicInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | private_ip_address | String | - 功能说明：私网IP地址 | | device_id | String | - 功能说明：端口所属设备ID，表示使用子网内私有IP地址的云服务资源ID，比如云服务器的ID、ELB的ID。 - 约束与限制：不支持设置和更新，由系统自动维护 | | device_owner | String | - 功能说明：端口所属的设备，表示使用子网内私有IP地址的云服务资源。 - 取值范围：合法设备所属 - network:dhcp（表示DHCP服务） - network:VIP_PORT（表示创建的是虚拟IP） - network:router_interface_distributed（表示子网网关地址） - network:router_centralized_snat（表示SNAT网关地址） - 约束与限制：不支持设置和更新，由系统自动维护 | | vpc_id | String | - 功能说明：虚拟私有云ID | | port_id | String | - 功能说明：端口ID | | port_profile | String | - 功能说明：端口profile信息 | | mac | String | - 功能说明：端口MAC地址 - 约束与限制：由系统分配，不支持指定 | | vtep | String | - 功能说明：VTEP IP | | vni | String | - 功能说明：VXLAN ID | | instance_id | String | - 功能说明：端口所属实例ID，例如RDS实例ID - 约束与限制：不支持设置和更新，由系统自动维护 | | instance_type | String | - 功能说明：port的使用者。 - 约束限制：不涉及 - 取值范围： - PORT：弹性网卡。 - PEP_PORT：PEP弹性网卡。 - EVPN：以太网虚拟私有网络。 - NATGW：NAT网关。 - P2CVPN：P2C虚拟专用网络。 - 默认取值：不涉及 | | port_vif_details | String | - 功能说明：网卡虚拟接口的详细信息 | 表6PublicipBandwidthInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 功能描述：带宽ID | | size | Integer | - 功能描述：带宽大小 - 取值范围：默认5Mbit/s\~2000Mbit/s | | share_type | String | - 功能说明：带宽类型，标识是否是共享带宽 - 取值范围： - PER：独享带宽 - WHOLE：共享带宽 - 约束与限制：其中IPv6暂不支持WHOLE类型带宽。 | | charge_mode | String | - 功能说明：按流量计费还是按带宽计费 - 取值范围： - bandwidth：按带宽计费 - traffic：按流量计费 - 95peak_plus：按增强型95计费 | | name | String | - 功能说明：带宽名称 - 取值范围：1-64个字符，支持数字、字母、中文、_（下划线）、-（中划线）、.（点） | | billing_info | String | - 功能说明：账单信息。如果billinginfo不为空，说明是包周期的带宽 | 表7ProfileInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | local_network_port | String | - 功能说明：公网IP附属的5_xxx网络（如5_bgp）中的port_id | | standalone | Boolean | - 功能说明：标识公网IP是否是和虚机一起创建的。true-独立创建；false-和虚机一起创建 | | notify_status | String | - 功能说明：云服务标识公网IP创建进度, 弹性公网IP服务内部使用 | | create_time | String | - 功能说明：公网IP创建时间 | | fake_network_type | Boolean | - 参数解释：该字段仅仅用于表示eip的bgp类型是否是真实的静态sbgp。 - 约束限制：不涉及 - 取值范围： - TRUE：该eip可以切换bgp类型。 - FALSE：该eip不可以切换bgp类型。（默认不显示）。 - 默认取值：不涉及 | | create_source | String | - 功能说明：标识IP是和哪类资源一起购买的 | | ecs_id | String | - 功能说明：标识和公网IP一起购买的ecs的id | | lock_status | String | - 功能说明：公网IP加锁状态, eg："POLICE,LOCKED"。POLICE-公安冻结；LOCKED-普通冻结；普通冻结细分状态：ARREAR-欠费；DELABLE-可删除； | | freezed_status | String | - 参数解释：公网IP冻结状态。 - 约束限制：不涉及 - 取值范围： - FREEZED：该eip可以切换bgp类型。 - UNFREEZED：该eip不可以切换bgp类型。（默认不显示）。 - 默认取值：不涉及 | | bandwidth_info | [BandwidthInfoResp] object | - 功能说明：公网IP绑定的带宽信息 | 表8BandwidthInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bandwidth_name | String | - 功能说明：带宽名称 | | bandwidth_number | Integer | - 功能说明：带宽大小 | | bandwidth_type | String | - 参数解释：根据带宽类型过滤。 - 约束限制：不涉及 - 取值范围： - PER：独享带宽。 - WHOLE: 共享带宽。 - 默认取值：不涉及 | | bandwidth_id | String | - 功能说明：带宽id | #### 请求示例 查询id为006343a1-32bf-4361-958a-efd158153dd0的弹性公网IP详情 ``` GET https://{Endpoint}/v3/{project_id}/eip/publicips/006343a1-32bf-4361-958a-efd158153dd0 ``` #### 响应示例 **状态码：200** ``` { "publicip" : { "created_at" : "2022-03-17T09:46:22Z", "updated_at" : "2022-03-30T02:46:04Z", "lock_status" : null, "allow_share_bandwidth_types" : [ "bgp", "sbgp", "share", "share_yidongdanxian", "share_bgp_premium" ], "id" : "006343a1-32bf-4361-958a-efd158153dd0", "alias" : null, "project_id" : "060576787a80d5762fa2c00f07ddfcf4", "ip_version" : 4, "public_ip_address" : "88.88.1.141", "public_ipv6_address" : null, "status" : "DOWN", "description" : "", "enterprise_project_id" : "0", "billing_info" : null, "type" : "弹性公网IP", "vnic" : { "private_ip_address" : "172.16.1.235", "device_id" : "", "device_owner" : "", "vpc_id" : "1c30f428-9741-48b2-a788-0b2f359705eb", "port_id" : "22d3576d-c042-4f3d-8c7c-1330a2724627", "mac" : "fa:16:3e:3a:22:66", "vtep" : null, "vni" : null, "instance_id" : "", "instance_type" : "", "port_profile" : null, "port_vif_details" : "{\"primary_interface\": true}" }, "bandwidth" : { "id" : "149ff19b-5de4-4436-958f-2eca39952e93", "size" : 100, "share_type" : "PER", "charge_mode" : "traffic", "name" : "bandwidth-xym-br-eqos", "billing_info" : "" }, "associate_instance_type" : "PORT", "associate_instance_id" : "22d3576d-c042-4f3d-8c7c-1330a2724627", "publicip_pool_id" : "9af5f2e5-1765-4b86-b342-ece52e785c8b", "publicip_pool_name" : "5_union", "public_border_group" : "center", "tags" : [ "key=value" ] }, "request_id" : "ce1a33a85d2e105040497a21bbe58c26" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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.v3.region.EipRegion; import com.huaweicloud.sdk.eip.v3.*; import com.huaweicloud.sdk.eip.v3.model.*; public class ShowPublicipSolution { 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); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("")) .build(); ShowPublicipRequest request = new ShowPublicipRequest(); request.withPublicipId("{publicip_id}"); try { ShowPublicipResponse response = client.showPublicip(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] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkeip.v3.region.eip_region import EipRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeip.v3 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 = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("")) \ .build() try: request = ShowPublicipRequest() request.publicip_id = "{publicip_id}" response = client.show_publicip(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] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := eip.EipClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := eip.NewEipClient(hcClient) request := &model.ShowPublicipRequest{} request.PublicipId = "{publicip_id}" response, err := client.ShowPublicip(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/sdk?api=ShowPublicip&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | GET操作正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。