Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Elastic IP/ API Reference/ API V3/ Common Pools/ Querying EIP Pool Details

Querying EIP Pool Details

Updated on 2025-02-08 GMT+08:00

Function

This API is used to query EIP pool details.

URI

GET /v3/{project_id}/eip/publicip-pools/{publicip_pool_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Minimum length: 1

Maximum length: 32

publicip_pool_id

Yes

String

EIP pool ID, which uniquely identifies the EIP pool.

Minimum length: 36

Maximum length: 36

Table 2 Query parameter

Parameter

Mandatory

Type

Description

fields

No

String

  • Field. Format: "fields=id&fields=name&..."
  • Supported fields: id, name, size, used, project_id, status, billing_info, created_at, updated_at, type, shared, is_common, description, tags, enterprise_project_id, allow_share_bandwidth_types, and public_border_group.

Minimum length: 0

Maximum length: 1024

Request Parameter

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

publicip_pool

PublicipPoolShowResp object

EIP pool details.

request_id

String

Request ID.

Table 4 PublicipPoolShowResp

Parameter

Type

Description

id

String

  • EIP pool ID.

Minimum length: 1

Maximum length: 36

name

String

  • EIP pool name.

Minimum length: 0

Maximum length: 64

status

String

  • EIP pool status.

Minimum length: 0

Maximum length: 36

type

String

  • EIP pool type.
  • The value can be:
    • spec_bgp: Dynamic
    • spec_sbgp: Static

Enumerated values:

  • spec_bgp
  • spec_sbgp

description

String

  • Supplementary information about the EIP pool.

Minimum length: 0

Maximum length: 1024

project_id

String

  • Tenant ID.

Minimum length: 1

Maximum length: 36

size

Integer

  • EIP pool size.

Minimum value: 0

Maximum value: 999999

used

Integer

  • Number of used EIPs.

Minimum value: 0

Maximum value: 999999

created_at

String

  • Time when an EIP pool is assigned.

Minimum length: 0

Maximum length: 64

updated_at

String

  • Time when an EIP pool is updated.

Minimum length: 0

Maximum length: 64

billing_info

BillingInfoDict object

Order information, which is available only for yearly/monthly resources.

public_border_group

String

  • Whether the EIP pool is in a central region or an edge site. The value can be center.

Minimum length: 0

Maximum length: 64

shared

Boolean

  • Whether the EIP pool is shared.

is_common

Boolean

  • Whether the EIP pool is a common pool.

tags

Array of TagsInfo objects

  • User tag. (The parameter is not displayed by default.)

enterprise_project_id

String

  • Enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). This is the ID of the enterprise project that you associate with the EIP when you assign the EIP.

Minimum length: 0

Maximum length: 36

allow_share_bandwidth_types

Array of strings

  • Types of the shared bandwidth that an EIP can be added to. If this parameter is left blank, the EIP cannot be added to any shared bandwidth.
  • The EIP can be added only to the shared bandwidth of these types.

Maximum length: 64

Table 5 BillingInfoDict

Parameter

Type

Description

order_id

String

  • Order information.

Minimum length: 0

Maximum length: 64

product_id

String

  • Product ID.

Minimum length: 0

Maximum length: 64

Table 6 TagsInfo

Parameter

Type

Description

key

String

  • Key. The tag key of a resource must be unique.

Minimum length: 0

Maximum length: 64

value

String

  • Values.

Minimum length: 0

Maximum length: 256

Example Request

None

Example Response

Status code: 200

Normal response to the GET operation

{
  "publicip_pool" : {
    "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
    "name" : "test_pool_xxx",
    "status" : "active",
    "shared" : true,
    "is_common" : false,
    "enterprise_project_id" : 0,
    "type" : "spec_bgp",
    "project_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "size" : 100,
    "used" : 20,
    "billing_info" : {
      "order_id" : "CS20081917179HW3H",
      "product_id" : "00301-335034-0--0"
    },
    "created_at" : "2020-07-17T09:25:53Z",
    "updated_at" : "2020-07-17T09:25:53Z",
    "description" : "test",
    "public_border_group" : "center",
    "allow_share_bandwidth_types" : [ "share" ]
  },
  "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100"
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback