Updated on 2026-11-06 GMT+08:00

Querying EIP Pools

Function

This API is used to query all EIP pools of a tenant.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Maximum: 32

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

marker

No

String

  • Definition: Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.

Minimum: 0

Maximum: 36

limit

No

Integer

  • Definition: Number of resources returned on each page.

  • Range: 1 to 2000

Minimum: 0

Maximum: 2000

fields

No

String

  • Definition: Query 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: 0

Maximum: 1024

sort_key

No

String

  • Definition: Sorting key. Format: "sort_key=id&sort_dir=asc"

  • Supported fields: id, name, created_at, updated_at, and public_border_group

Minimum: 0

Maximum: 36

sort_dir

No

String

  • Definition: Sorting direction.

  • Range:

    • asc: ascending order

    • desc: descending order

Minimum: 0

Maximum: 16

id

No

String

  • Definition: ID is used as a filter.

Minimum: 0

Maximum: 36

name

No

String

  • Definition: name is used as a filter.

Minimum: 0

Maximum: 64

size

No

Integer

  • Definition: size is used as a filter.

Minimum: 0

Maximum: 999999

status

No

String

  • Definition: The global EIP pool status is used as a filter.

  • Constraints: N/A

  • Range:

    • ACTIVE

    • INACTIVE

    • SOLDOUT

  • Default Value: N/A

Minimum: 0

Maximum: 36

type

No

String

  • Definition: The EIP pool type is used as a filter.

  • Constraints: N/A

  • Range:

    • spec_bgp: dynamic

    • spec_sbgp: static

  • Default Value: N/A

Minimum: 0

Maximum: 36

description

No

String

  • Definition: description is used as a filter.

Minimum: 0

Maximum: 255

public_border_group

No

String

  • Definition: public_border_group is used as a filter.

Minimum: 0

Maximum: 64

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

publicip_pools

Array of PublicipPoolShowResp objects

Definition: EIP pools

Array Length: 0 - 9999

request_id

String

Request ID.

page_info

PageInfoOption object

Pagination page number information.

Table 4 PublicipPoolShowResp

Parameter

Type

Description

id

String

  • Definition: EIP pool ID.

name

String

  • Definition: EIP pool name.

status

String

  • Definition: EIP pool status.

  • Constraints: N/A

  • Range:

    • ACTIVE

    • INACTIVE

    • SOLDOUT

  • Default Value: N/A

type

String

  • Definition: EIP pool type.

  • Constraints: N/A

  • Range:

    • spec_bgp: dynamic

    • spec_sbgp: static

  • Default Value: N/A

description

String

  • Definition: Description.

project_id

String

size

Integer

  • Definition: Pool size.

used

Integer

  • Definition: Number of used EIPs.

created_at

String

  • Definition: Time when an EIP pool was assigned.

updated_at

String

  • Definition: Time when an EIP pool was updated.

billing_info

BillingInfoDict object

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

public_border_group

String

  • Definition: Whether it is a central or an edge resource. The value of an EIP pool is center.

shared

Boolean

  • Definition: Whether the resource is shared.

tags

Array of TagsInfo objects

  • Definition: Tags.

Array Length: 0 - 9999

enterprise_project_id

String

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

allow_share_bandwidth_types

Array of strings

  • Definition: 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.

  • Constraints: The EIP can be added only to the shared bandwidth of these types.

Maximum: 64

Array Length: 0 - 9999

Table 5 BillingInfoDict

Parameter

Type

Description

order_id

String

  • Definition: Order information.

product_id

String

  • Definition: Product ID.

Table 6 TagsInfo

Parameter

Type

Description

key

String

  • Definition: Tag key.

  • Constraints:

    • The key cannot be empty.

    • The key can contain up to 128 characters.

    • The key can contain letters, digits, underscores (_), and hyphens (-).

    • The key must be unique for each resource.

Maximum: 128

value

String

  • Definition: Tag value.

  • Constraints:

    • The value can contain a maximum of 255 characters.

    • The value can contain letters, digits, underscores (_), and hyphens (-).

Maximum: 255

Table 7 PageInfoOption

Parameter

Type

Description

previous_marker

String

Definition

Marker value of the previous page.

Range

N/A

next_marker

String

Definition

Marker value of the next page.

Range

N/A

current_count

Integer

Definition

Total number of data records on the current page.

Range

0 to 99999

Example Requests

Query EIP pools. You can filter EIP pools based on the query field.

GET https://{Endpoint}/v3/{project_id}/eip/publicip-pools

Example Responses

Status code: 200

{
  "publicip_pools" : [ {
    "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
    "name" : "test_pool_xxx",
    "status" : "active",
    "shared" : true,
    "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",
  "page_info" : {
    "previous_marker" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
    "current_count" : 1
  }
}

SDK Sample Code

The SDK sample code is as follows.

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.eip.v3.region.EipRegion;
import com.huaweicloud.sdk.eip.v3.*;
import com.huaweicloud.sdk.eip.v3.model.*;


public class ListPublicipPoolSolution {

    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();
        ListPublicipPoolRequest request = new ListPublicipPoolRequest();
        try {
            ListPublicipPoolResponse response = client.listPublicipPool(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 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 = ListPublicipPoolRequest()
        response = client.list_publicip_pool(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
38
39
40
41
42
43
44
45
46
47
48
49
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.ListPublicipPoolRequest{}
	response, err := client.ListPublicipPool(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Normal response to the GET operation

Error Codes

See Error Codes.