All Products
Search
Document Center

:ListPublicIpAddressPools

更新時間:Aug 30, 2023

Queries available IP address pools.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes ListPublicIpAddressPools

The operation that you want to perform. Set the value to ListPublicIpAddressPools.

PublicIpAddressPoolIds.N String No pippool-6wetvn6fumkgycssx****

The IDs of the IP address pools.

You can enter up to 100 IDs.

Status String No Created

The status of the IP address pool. Valid values:

  • Created
  • Deleting
  • Modifying
MaxResults Integer No 10

The maximum number of entries to return. Valid values: 10 to 100. Default value: 10.

NextToken String No FFmyTO70tTpLG6I3FmYAXGKPd****

The pagination token that is used in the next request to retrieve a new page of results. Valid values:

  • You do not need to specify this parameter for the first request.
  • You must specify the token that is obtained from the previous query as the value of NextToken.
Isp String No BGP

The line type. Valid values:

  • BGP (default)

  • BGP_PRO

For more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see Line types.

If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

  • ChinaTelecom
  • ChinaUnicom
  • ChinaMobile
  • ChinaTelecom_L2
  • ChinaUnicom_L2
  • ChinaMobile_L2

If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

Name String No AddressPoolName

The name of the IP address pool.

This parameter is optional. The name must be 1 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.

DryRun Boolean No false

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
ResourceGroupId String No rg-acfmxazb4pcdvf****

The ID of the resource group to which the IP address pool belongs.

Tags.N.Key String No FinanceDept

The key of tag N to add to the resource. You can specify at most 20 tag keys. The tag key cannot be an empty string.

The tag key can be at most 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

Tags.N.Value String No FinanceJoshua

The value of tag N to add to the resource. You can specify at most 20 tag values. The tag value can be an empty string.

The tag value can be up to 128 characters in length and cannot start with acs: or aliyun. The tag value cannot contain http:// or https://.

RegionId String Yes cn-chengdu

The ID of the region where you want to query IP address pools.

You can call the DescribeRegions operation to query the most recent region list.

Response parameters

Parameter

Type

Example

Description

RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The request ID.

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

A pagination token. It can be used in the next request to retrieve a new page of results. Valid values:

  • If the value of NextToken is not returned, it indicates that no next query is to be sent.
  • If a value is returned for NextToken, the value indicates the token that is used for the next query.
TotalCount Integer 1

The total number of entries returned.

PublicIpAddressPoolList Array of PublicIpAddressPool

The list of IP address pools.

PublicIpAddressPoolId String pippool-6wetvn6fumkgycssx****

The ID of the IP address pool.

RegionId String cn-chengdu

The ID of the region where you want to query IP address pools.

CreationTime String 2022-05-10T01:37:38Z

The time when the IP address pool was created. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.

Isp String BGP

The line type. Valid values:

  • BGP

  • BGP_PRO

For more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see Line types.

If you are allowed to use single-ISP bandwidth, one of the following values may be returned:

  • ChinaTelecom
  • ChinaUnicom
  • ChinaMobile
  • ChinaTelecom_L2
  • ChinaUnicom_L2
  • ChinaMobile_L2

If your services are deployed in China East 1 Finance, BGP_FinanceCloud is returned.

Name String AddressPoolName

The name of the IP address pool.

Status String Created

The status of the IP address pool. Valid values:

  • Created
  • Deleting
  • Modifying
Description String AddressPoolDescription

The description of the IP address pool.

TotalIpNum Integer 100

The total number of IP addresses in the public IP address pool.

UsedIpNum Integer 20

The number of occupied IP addresses in the public IP address pool.

IpAddressRemaining Boolean true

Indicates whether the IP address pool has idle IP addresses. Valid values:

  • true
  • false
UserType Boolean admin

The user type. Valid values:

  • admin: administrator. An administrator can delete, modify, and query IP address pools, and allocate elastic IP addresses (EIPs) to IP address pools.
  • user: regular user. A regular user can only allocate EIPS to IP address pools and query IP address pools. A regular user cannot modify or delete IP address pools.
OwnerId Long 121012345612****

The Alibaba Cloud account to which the IP address pool belongs.

ShareType String Shared

Indicates whether the IP address pool is shared.

  • Only Shared may be returned.
  • An empty value indicates that the IP address pool is not shared.
ResourceGroupId String rg-acfmxazb4pcdvf****

The ID of the resource group to which the IP address pool belongs.

Tags Array of Tag

The list of tags.

Key String FinanceDept

The key of tag N that is added to the resource.

Value String FinanceDept

The value of tag N that is added to the resource.

BizType String CloudBox

The service type of the IP address pool.

  • CloudBox Only cloud box users can select this type.
  • Default (default)
Zones Array of String ap-southeast-1-lzdvn-cb

The zone of the IP address pool. This parameter is returned only when the service type is CloudBox.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListPublicIpAddressPools
&PublicIpAddressPoolIds=["pippool-6wetvn6fumkgycssx****"]
&Status=Created
&MaxResults=10
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&Isp=BGP
&Name=AddressPoolName
&DryRun=false
&ResourceGroupId=rg-acfmxazb4pcdvf****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&RegionId=cn-chengdu
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListPublicIpAddressPoolsResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <TotalCount>1</TotalCount>
    <PublicIpAddressPoolList>
        <PublicIpAddressPoolId>pippool-6wetvn6fumkgycssx****</PublicIpAddressPoolId>
        <RegionId>cn-chengdu</RegionId>
        <CreationTime>2022-05-10T01:37:38Z</CreationTime>
        <Isp>BGP</Isp>
        <Name>AddressPoolName</Name>
        <Status>Created</Status>
        <Description>AddressPoolDescription</Description>
        <TotalIpNum>100</TotalIpNum>
        <UsedIpNum>20</UsedIpNum>
        <IpAddressRemaining>true</IpAddressRemaining>
        <UserType>false</UserType>
        <ShareType>Shared</ShareType>
        <ResourceGroupId>rg-acfmxazb4pcdvf****</ResourceGroupId>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceDept</Value>
        </Tags>
        <BizType>CloudBox</BizType>
        <Zones>ap-southeast-1-lzdvn-cb</Zones>
    </PublicIpAddressPoolList>
</ListPublicIpAddressPoolsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount" : 1,
  "PublicIpAddressPoolList" : [ {
    "PublicIpAddressPoolId" : "pippool-6wetvn6fumkgycssx****",
    "RegionId" : "cn-chengdu",
    "CreationTime" : "2022-05-10T01:37:38Z",
    "Isp" : "BGP",
    "Name" : "AddressPoolName",
    "Status" : "Created",
    "Description" : "AddressPoolDescription",
    "TotalIpNum" : 100,
    "UsedIpNum" : 20,
    "IpAddressRemaining" : true,
    "UserType" : false,
    "ShareType" : "Shared",
    "ResourceGroupId" : "rg-acfmxazb4pcdvf****",
    "Tags" : [ {
      "Key" : "FinanceDept",
      "Value" : "FinanceDept"
    } ],
    "BizType" : "CloudBox",
    "Zones" : [ "ap-southeast-1-lzdvn-cb" ]
  } ]
}

Error codes

For more error codes, see Service error codes.