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

Querying Common Pools

Function

This API is used to query common pools.

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/common-pools

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Maximum: 32

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

fields

No

String

  • Definition: Query field. Format: "fields=id&fields=name&.."

  • Supported fields: id, name, status, type, used, allow_share_bandwidth_types, and public_border_group

Minimum: 0

Maximum: 1024

name

No

String

  • Definition: Common pool name.

Minimum: 0

Maximum: 36

public_border_group

No

String

  • Definition: Whether it is a central or an edge common pool.

Minimum: 0

Maximum: 64

limit

No

String

  • Definition: Number of resources returned on each page.

  • Range: 1 to 2000

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

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

common_pools

Array of CommonPoolDict objects

Definition: Common pools

Array Length: 0 - 9999

request_id

String

Request ID.

Table 4 CommonPoolDict

Parameter

Type

Description

name

String

  • Common pool name

Minimum: 0

Maximum: 36

status

String

  • Definition: Common pool status.

  • Constraints: N/A

  • Range:

    • ACTIVE: IP addresses in the common pool can be purchased.

    • SOLDOUT: IP addresses in the common pool have been sold out.

  • Default Value: N/A

  • Maximum length: 36

  • Minimum length: 0

type

String

  • Definition: Type of a common pool.

  • Constraints: N/A

  • Range: All common pool types

    • 5_bgp: dynamic BGP EIP pool

    • 5_sbgp: static BGP EIP pool

    • 5_testbgp: IP address test pool

  • Default Value: N/A

Minimum: 0

Maximum: 36

used

Integer

  • Number of used IP addresses

Minimum: 0

Maximum: 99999

public_border_group

String

  • Definition: Whether the resource is in a central region or an edge site.

  • Range: The value can be center or an edge site name.

Minimum: 1

Maximum: 64

id

String

  • Definition: Common pool ID. The parameter is not displayed by default.

Minimum: 36

Maximum: 36

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

Example Requests

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

GET https://{Endpoint}/v3/{project_id}/eip/publicip-pools/common-pools?name=5_bgp

Example Responses

Status code: 200

{
  "common_pools" : [ {
    "name" : "5_bgp",
    "status" : "active",
    "type" : "bgp",
    "used" : 99,
    "public_border_group" : "center",
    "allow_share_bandwidth_types" : [ "share" ]
  } ],
  "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100"
}

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 ListCommonPoolsSolution {

    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();
        ListCommonPoolsRequest request = new ListCommonPoolsRequest();
        try {
            ListCommonPoolsResponse response = client.listCommonPools(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 = ListCommonPoolsRequest()
        response = client.list_common_pools(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.ListCommonPoolsRequest{}
	response, err := client.ListCommonPools(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.