DedicatedIpPoolList - Direct Mail - Alibaba Cloud Documentation Center

Lists IP pools.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dm:DedicatedIpPoolList

none

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageIndex	integer	Yes	The page number to return, starting from 1.	1
PageSize	integer	Yes	The number of entries per page.	10
Keyword	string	No	The keyword to search for IP pools by name.	xxx
All	boolean	No	Specifies whether to return all entries.	false

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The ID of the request.	xxx
HasMore	boolean	Indicates whether more results are available. Valid values: ture : More results are available. false : All results have been returned.	false
CurrentPage	string	The current page number.	1
PageSize	string	The number of entries on the current page.	10
TotalCounts	integer	The total number of entries that match the query.	5
IpPools	array<object>	A list of IP pools.
	array<object>	Details about an IP pool.
Id	string	The ID of the IP pool.	xxx
CreateTime	string	The time when the IP pool was created.	2025-05-23T07:41:43Z
Name	string	The name of the IP pool.	xxx
IpCount	integer	The number of source IP addresses in the IP pool.	1
Ips	array<object>	A list of IP addresses.
	object	Details about an IP address.
Id	string	The ID of the IP address instance.	xxx
Ip	string	The IP address.	xxx
ZoneId	string	The ID of the Availability Zone.	xxx

Examples

Success response

JSON format

{
  "RequestId": "xxx",
  "HasMore": false,
  "CurrentPage": "1",
  "PageSize": "10",
  "TotalCounts": 5,
  "IpPools": [
    {
      "Id": "xxx",
      "CreateTime": "2025-05-23T07:41:43Z",
      "Name": "xxx",
      "IpCount": 1,
      "Ips": [
        {
          "Id": "xxx",
          "Ip": "xxx",
          "ZoneId": "xxx"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.