All Products
Search
Document Center

Virtual Private Cloud:ListPublicIpAddressPools

Last Updated:Aug 29, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PublicIpAddressPoolIdsarrayNo

The IDs of the IP address pool.

You can enter up to 100 IDs.

stringNo

The ID of the IP address pool.

You can enter up to 100 IDs.

pippool-6wetvn6fumkgycssx****
StatusstringNo

The status of the IP address pool. Valid values:

  • Created
  • Deleting
  • Modifying
Created
MaxResultsintegerNo

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

10
NextTokenstringNo

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

  • 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.
FFmyTO70tTpLG6I3FmYAXGKPd****
IspstringNo

The line type. Valid values:

  • BGP (default): BGP (Multi-ISP) line
  • BGP_PRO: BGP (Multi-ISP) Pro line

For more information about the BGP (Multi-ISP) line and BGP (Multi-ISP) Pro line, see the "Line types" section of What is EIP?

If you are allowed to use single-ISP bandwidth, you can also choose 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 parameter to BGP_FinanceCloud.

BGP
NamestringNo

The name of the IP address pool.

If you enter a name, 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://.

AddressPoolName
DryRunbooleanNo

Specifies whether to perform 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 message 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.
false
ResourceGroupIdstringNo

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

rg-acfmxazb4pcdvf****
Tagsarray<object>No

The tags to add to the resource.

objectNo
KeystringNo

The tag key to add to the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string.

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

FinanceDept
ValuestringNo

The tag value to add to the resource. You can specify up to 20 tag values. The tag value can be an empty string.

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

FinanceJoshua
RegionIdstringYes

The ID of the region in which the IP address pool that you want to query resides.

You can call the DescribeRegions operation to query the region ID.

cn-chengdu
SecurityProtectionEnabledbooleanNo

Specifies whether to enable Anti-DDoS Pro/Premium. Valid values:

  • false
  • true
true

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

4EC47282-1B74-4534-BD0E-403F3EE64CAF
NextTokenstring

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

  • If NextToken is empty, no next page exists.
  • If a value is returned for NextToken, the value is used to retrieve a new page of results.
FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCountinteger

The total number of entries returned.

1
PublicIpAddressPoolListarray<object>

The IP address pools.

object

The structure of the IP address pool.

PublicIpAddressPoolIdstring

The ID of the IP address pool.

pippool-6wetvn6fumkgycssx****
RegionIdstring

The region ID of the IP address pool.

cn-chengdu
CreationTimestring

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

2022-05-10T01:37:38Z
Ispstring

The line type.

  • BGP: BGP (Multi-ISP)
  • BGP_PRO: BGP (Multi-ISP) Pro

For more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see EIP 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.

BGP
Namestring

The name of the IP address pool.

AddressPoolName
Statusstring

The status of the IP address pool.

  • Created
  • Deleting
  • Modifying
Created
Descriptionstring

The description of the IP address pool.

AddressPoolDescription
TotalIpNuminteger

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

100
UsedIpNuminteger

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

20
IpAddressRemainingboolean

Indicates whether idle IP addresses exist.

  • true
  • false
true
UserTypeboolean

The user type. Valid values:

  • admin: An administrator can delete, modify, and query IP address pools, and can assign elastic IP addresses (EIPs) to the pool.
  • user: A user can only assign EIPs to the IP address pool and query the IP address pool, but cannot modify or delete the IP address pool.
admin
OwnerIdlong

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

121012345612****
ShareTypestring

The sharing type of the IP address pool.

  • If Shared is returned, the IP address pool is shared.
  • If an empty value is returned, the IP address pool is not shared.
Shared
ResourceGroupIdstring

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

rg-acfmxazb4pcdvf****
Tagsarray<object>

The tag list.

object
Keystring

The key of tag N.

FinanceDept
Valuestring

The value of tag N.

FinanceDept
BizTypestring

The service type of the IP address pool.

  • CloudBox Only cloud box users can select this type.
  • Default (default)
CloudBox
Zonesarray

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

string

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

ap-southeast-1-lzdvn-cb
SecurityProtectionTypesarray

The edition of Anti-DDoS.

  • If you do not set this parameter, Anti-DDoS Origin Basic is used.
  • If the value is set to AntiDDoS_Enhanced, Anti-DDoS Pro/Premium is used.
string

The edition of Anti-DDoS.

  • If you do not set this parameter, Anti-DDoS Origin Basic is used.
  • If the value is set to AntiDDoS_Enhanced, Anti-DDoS Pro/Premium is used.
AntiDDoS_Enhanced
BusinessStatusstring

The status of the IP address pool.

  • Normal
  • FinancialLocked
Normal

Examples

Sample success responses

JSONformat

{
  "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": true,
      "OwnerId": 0,
      "ShareType": "Shared",
      "ResourceGroupId": "rg-acfmxazb4pcdvf****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceDept"
        }
      ],
      "BizType": "CloudBox",
      "Zones": [
        "ap-southeast-1-lzdvn-cb"
      ],
      "SecurityProtectionTypes": [
        "AntiDDoS_Enhanced"
      ],
      "BusinessStatus": "Normal"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalParam.IspThe param of Isp [%s] is illegal.The error message returned because the Isp parameter is set to an invalid value. Specify a valid value and try again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-08-08The Error code has changed. The response structure of the API has changedView Change Details
2024-07-31The Error code has changedView Change Details
2024-06-06The Error code has changedView Change Details
2024-05-27The response structure of the API has changedView Change Details
2024-01-22The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-08-08The response structure of the API has changedView Change Details
2023-05-15The response structure of the API has changedView Change Details