文档首页/ 弹性公网IP EIP/ API参考/ API V3/ 公共池/ 查询公网IP池类型 - ShowPublicipPoolTypes
更新时间:2026-06-18 GMT+08:00
分享

查询公网IP池类型 - ShowPublicipPoolTypes

功能介绍

查询公网IP池类型。

调试

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

授权信息

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

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

URI

GET /v3/{project_id}/eip/publicip-pool-types

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

marker

String

  • 功能说明:分页查询起始的资源ID,为空时为查询第一页

最小长度:0

最大长度:36

limit

Integer

  • 功能说明:每页返回的资源个数

  • 取值范围:1~2000

最小值:0

最大值:2000

fields

String

  • 功能说明:查询字段,形式为“fields=id&fields=name&...”

  • 支持字段: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/public_border_group

最小长度:0

最大长度:1024

sort_key

String

  • 功能说明:排序字段,形式为“sort_key=id&sort_dir=asc”

  • 支持字段:id/name/created_at/updated_at/public_border_group

最小长度:0

最大长度:36

sort_dir

String

  • 功能说明:排序方向

  • 取值范围:

    • asc 顺序

    • desc 倒序

最小长度:0

最大长度:16

id

String

  • 功能说明:根据id过滤

最小长度:0

最大长度:36

name

String

  • 功能说明:根据name过滤

最小长度:0

最大长度:64

size

Integer

  • 功能说明:根据size过滤

最小值:0

最大值:999999

status

String

  • 功能说明:根据status过滤

最小长度:0

最大长度:36

type

String

  • 功能说明:根据type过滤

最小长度:0

最大长度:36

description

String

  • 功能说明:根据description过滤

最小长度:0

最大长度:255

public_border_group

String

  • 功能说明:根据public_border_group过滤

最小长度:0

最大长度:64

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

publicip-pool-types

PublicPoolType object

  • 功能说明:公网IP池类型对象

表4 PublicPoolType

参数

参数类型

描述

id

String

  • 功能说明:弹性公网IP池类型ID

type

String

  • 功能说明:弹性公网IP池类型

请求示例

查询公网IP池类型

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

响应示例

状态码:200

Get操作正常返回

{
  "publicip-pool-types" : [ {
    "id" : "3e10d228-d4c8-4319-8ae3-4e881db084b2",
    "type" : "spec_bgp"
  } ],
  "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100"
}

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

    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();
        ShowPublicipPoolTypesRequest request = new ShowPublicipPoolTypesRequest();
        try {
            ShowPublicipPoolTypesResponse response = client.showPublicipPoolTypes(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
# 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 = ShowPublicipPoolTypesRequest()
        response = client.show_publicip_pool_types(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
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.ShowPublicipPoolTypesRequest{}
	response, err := client.ShowPublicipPoolTypes(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Get操作正常返回

错误码

请参见错误码

相关文档