ListPublicIpAddressPools - Elastic IP Address - Alibaba Cloud Documentation Center

Queries available IP address pools.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:ListPublicIpAddressPools	get	PublicIpAddressPool acs:vpc:{#regionId}:{#accountId}:publicipaddresspool/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
PublicIpAddressPoolIds	array	No	The IDs of the IP address pool. You can enter up to 100 IDs.
	string	No	The ID of the IP address pool. You can enter up to 100 IDs.	pippool-6wetvn6fumkgycssx****
Status	string	No	The status of the IP address pool. Valid values: Created Deleting Modifying	Created
MaxResults	integer	No	The maximum number of entries to return. Valid values: 10 to 100. Default value: 10.	10
NextToken	string	No	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****
Isp	string	No	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
Name	string	No	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
DryRun	boolean	No	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
ResourceGroupId	string	No	The ID of the resource group to which the IP address pool belongs.	rg-acfmxazb4pcdvf****
Tags	array<object>	No	The tags to add to the resource.
	object	No
Key	string	No	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
Value	string	No	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
RegionId	string	Yes	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
SecurityProtectionEnabled	boolean	No	Specifies whether to enable Anti-DDoS Pro/Premium. Valid values: false true	true

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
NextToken	string	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****
TotalCount	integer	The total number of entries returned.	1
PublicIpAddressPoolList	array<object>	The IP address pools.
PublicIpAddressPool	object	The structure of the IP address pool.
PublicIpAddressPoolId	string	The ID of the IP address pool.	pippool-6wetvn6fumkgycssx****
RegionId	string	The region ID of the IP address pool.	cn-chengdu
CreationTime	string	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
Isp	string	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
Name	string	The name of the IP address pool.	AddressPoolName
Status	string	The status of the IP address pool. Created Deleting Modifying	Created
Description	string	The description of the IP address pool.	AddressPoolDescription
TotalIpNum	integer	The total number of available IP addresses in the public IP address pool.	100
UsedIpNum	integer	The number of used IP addresses in the public IP address pool.	20
IpAddressRemaining	boolean	Indicates whether idle IP addresses exist. true false	true
UserType	boolean	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
OwnerId	long	The Alibaba Cloud account to which the IP address pool belongs.	121012345612****
ShareType	string	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
ResourceGroupId	string	The ID of the resource group to which the IP address pool belongs.	rg-acfmxazb4pcdvf****
Tags	array<object>	The tag list.
Tag	object
Key	string	The key of tag N.	FinanceDept
Value	string	The value of tag N.	FinanceDept
BizType	string	The service type of the IP address pool. CloudBox Only cloud box users can select this type. Default (default)	CloudBox
Zones	array	The zone of the IP address pool. This parameter is returned only when the service type of the IP address pool is CloudBox.
Zone	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
SecurityProtectionTypes	array	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.
SecurityProtectionType	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
BusinessStatus	string	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 code	Error code	Error message	Description
400	IllegalParam.Isp	The 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 time	Summary of changes	Operation
2024-08-08	The Error code has changed. The response structure of the API has changed	View Change Details
2024-07-31	The Error code has changed	View Change Details
2024-06-06	The Error code has changed	View Change Details
2024-05-27	The response structure of the API has changed	View Change Details
2024-01-22	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-08-08	The response structure of the API has changed	View Change Details
2023-05-15	The response structure of the API has changed	View Change Details