ListPublicIpAddressPools - Query IP address pools | EIP API - Elastic IP Address

Queries available IP address pools.

Operation description

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PublicIpAddressPoolIds	array	No	The IDs of the IP address pool. You can specify up to 100 IDs.
	string	No	The ID of the IP address pool. You can specify 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 for the next request to retrieve a new page of results. Not required for the first request. Set this to the token obtained from the previous query.	FFmyTO70tTpLG6I3FmYAXGKPd****
Isp	string	No	The line type. Valid values: BGP (default): BGP (Multi-ISP) line BGP_PRO: BGP (Multi-ISP) Pro line BGP (Multi-ISP) and BGP (Multi-ISP) Pro lines are described in 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. The name must be 1 to 128 characters in length, start with a letter, and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `http://` or `https://`.	AddressPoolName
DryRun	boolean	No	Specifies whether to perform only a dry run. Valid values: true: performs a dry run only. The system checks for missing parameter values, incorrect request syntax, and service limits. If the request fails, an error message is returned. If the request passes, the `DryRunOperation` error code is returned. false(default): performs a dry run and then executes the request. A 2xx HTTP status code is returned on success.	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. 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 and cannot start with `aliyun` or `acs:` or contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. You can specify up to 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 `aliyun` or `acs:` or contain `http://` or `https://`.	FinanceJoshua
RegionId	string	Yes	The region ID of the IP address pool. Call DescribeRegions to query the region ID.	cn-chengdu
SecurityProtectionEnabled	boolean	No	Specifies whether to enable Anti-DDoS Pro/Premium. Valid values: false true	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
NextToken	string	The pagination token for subsequent requests. If NextToken is empty, no next page exists. If NextToken is returned, use it to retrieve the next page.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The total number of entries returned.	1
PublicIpAddressPoolList	array<object>	The IP address pools.
	array<object>	The IP address pool details.
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 BGP (Multi-ISP) and BGP (Multi-ISP) Pro are described in 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	string	The user type. Valid values: admin: can delete, modify, and query IP address pools, and assign EIPs to the pool. user: can only assign EIPs and query the pool. Cannot modify or delete the pool.	admin
OwnerId	integer	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.
	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: available only to cloud box users. 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.
	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.
	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

Success response

JSON format

{
  "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": "admin",
      "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.
400	IllegalParam.NextToken	The specified NextToken is invalid.	The specified NextToken is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.