文档首页/ 弹性公网IP EIP/ API参考/ API V3/ 弹性公网IP/ 查询弹性公网IP详情 - ShowPublicip
更新时间:2026-09-24 GMT+08:00
分享

查询弹性公网IP详情 - ShowPublicip

功能介绍

查询单条指定的弹性公网IP详细信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v3/{project_id}/eip/publicips/{publicip_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID 参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

publicip_id

是

String

参数解释:

弹性公网IP的ID。

约束限制:

不涉及。

取值范围:

最大长度36。

默认取值:

不涉及。

最大长度:36

表2 Query参数

参数

是否必选

参数类型

描述

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对象。

取值范围:

不涉及。

表4 PublicipSingleShowResp

参数

参数类型

描述

id

String

参数解释:

弹性公网IP唯一标识。

取值范围:

不涉及。

project_id

String

参数解释:

项目ID。

取值范围:

不涉及。

ip_version

Integer

参数解释:

IP版本信息。

取值范围:

4:IPv4地址。

6:IPv6地址。

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、边缘站点名称。

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。创建弹性公网IP时,给弹性公网IP绑定企业项目ID。

取值范围:

最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。

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

参数解释:

用户标签。

取值范围:

不涉及。

associate_instance_metadata

String

参数解释:

记录实例的更上一层归属。例如associate_instance_type为PORT,此字段记录PORT的device_id和device_owner信息。仅有限场景记录。(默认不显示)

取值范围:

数组长度0-9999

associate_mode

String

参数解释:

开启支持直通模式后展示,表示直通模式的标识。(默认不显示)

取值范围:

不涉及。

allow_share_bandwidth_types

Array of strings

参数解释:

表示此publicip可以加入的共享带宽类型列表,如果为空列表,则表示该publicip不能加入任何共享带宽。publicip只能加入到有该带宽类型的共享带宽中

取值范围:

数组长度0-9999

cascade_delete_by_instance

Boolean

参数解释:

表示该eip是否支持与实例同步删除。(默认不显示)

取值范围:

不涉及。

表5 VnicInfo

参数

参数类型

描述

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

参数解释:

网卡虚拟接口的详细信息。

取值范围:

不涉及。

表6 PublicipBandwidthInfo

参数

参数类型

描述

id

String

参数解释:

带宽ID。

取值范围:

不涉及。

size

Integer

参数解释:

带宽大小。

取值范围:

默认5Mbit/s~2000Mbit/s。

share_type

String

参数解释:

带宽类型,标识是否是共享带宽。其中IPv6暂不支持WHOLE类型带宽。

取值范围:

  • PER:独享带宽

  • WHOLE:共享带宽

charge_mode

String

参数解释:

按流量计费还是按带宽计费。

取值范围:

  • bandwidth:按带宽计费

  • traffic:按流量计费

  • 95peak_plus:按增强型95计费

name

String

参数解释:

带宽名称。

取值范围:

1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。

billing_info

String

参数解释:

账单信息。如果billinginfo不为空,说明是包周期的带宽。

取值范围:

不涉及。

表7 ProfileInfo

参数

参数类型

描述

local_network_port

String

参数解释:

公网IP附属的5_xxx网络(如5_bgp)中的port_id。

取值范围:

不涉及。

standalone

Boolean

参数解释:

标识公网IP是否是和虚机一起创建的。

取值范围:

  • true:独立创建

  • false:和虚机一起创建

notify_status

String

参数解释:

云服务标识公网IP创建进度, 弹性公网IP服务内部使用。

取值范围:

  • PENDING_CREATE

  • PENDING_UPDATE

  • NOTIFYING

  • NOTIFYED

  • NOTIFY_DELETE

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加锁状态。

取值范围:

POLICE:公安冻结

LOCKED:普通冻结

  • 普通冻结细分状态:ARREAR-欠费冻结;DELABLE-可删除冻结;

freezed_status

String

参数解释:

公网IP冻结状态。

取值范围:

  • FREEZED:冻结状态。

  • UNFREEZED:未冻结状态。

bandwidth_info

BandwidthInfoResp object

参数解释:

公网IP绑定的带宽信息。

取值范围:

不涉及。

表8 BandwidthInfoResp

参数

参数类型

描述

bandwidth_name

String

参数解释:

带宽名称。

取值范围:

不涉及。

bandwidth_number

Integer

参数解释:

带宽大小。

取值范围:

不涉及。

bandwidth_type

String

参数解释:

根据带宽类型过滤。

取值范围:

  • PER:独享带宽。

  • WHOLE: 共享带宽。

bandwidth_id

String

参数解释:

带宽id。

取值范围:

格式:[A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}

请求示例

查询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代码示例如下。

 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
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("<YOUR REGION>"))
                .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());
        }
    }
}
 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
# 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("<YOUR REGION>")) \
        .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)
 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
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("<YOUR REGION>")).
         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的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

GET操作正常返回

错误码

请参见错误码。

相关文档