DedicatedIpList - Direct Mail - Alibaba Cloud Documentation Center

Queries the IP addresses that you have purchased.

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:DedicatedIpList

none

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageIndex	integer	Yes	The page number. The value starts from 1.	1
PageSize	integer	Yes	The number of entries per page.	10
Keyword	string	No	The keyword for searching IP addresses.	xxx

Response elements

Element	Type	Description	Example
	object	The response.
TotalCounts	integer	The total number of purchased IP addresses.	5
RequestId	string	The request ID.	xxx
HasMore	boolean	Indicates whether the next page exists.	false
CurrentPage	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10
Ips	array<object>	The list of IP addresses.
	array<object>	The information about the purchased IP address.
Id	string	The IP address ID. This is the same as the purchased instance ID.	xxx
Ip	string	The IP address.	xxx
InstanceId	string	The ID of the purchased instance.	xxx
StartTime	string	The purchase time.	2025-05-12T09:19:20Z
ExpiredTime	string	The expiration time.	2025-06-12T09:19:20Z
Status	string	The status of the IP address. Valid values: sold : The IP address is purchased. expired : The IP address has expired.	sold
WarmupStatus	string	The prefetch status. Valid values: init : The IP address is pending processing. processing : The IP address is being processed. finish : The process is complete.	finish
WarmupType	string	The prefetch method. Valid values: sysCusStream : System prefetch. cusSelfManager : Manual prefetch.	cusSelfManager
IpPoolName	string	The name of the IP pool to which the IP address belongs.	xxx
IpExt	object	The extended information.
HasSendMail	boolean	Indicates whether emails have been sent. Valid values: true : Yes false : No	true
AutoRenewal	boolean	Indicates whether auto-renewal is enabled. Valid values: true : Yes false : No	false
LastWarmUpTypeChangedTime	string

Examples

Success response

JSON format

{
  "TotalCounts": 5,
  "RequestId": "xxx",
  "HasMore": false,
  "CurrentPage": 1,
  "PageSize": 10,
  "Ips": [
    {
      "Id": "xxx",
      "Ip": "xxx",
      "InstanceId": "xxx",
      "StartTime": "2025-05-12T09:19:20Z",
      "ExpiredTime": "2025-06-12T09:19:20Z",
      "Status": "sold",
      "WarmupStatus": "finish",
      "WarmupType": "cusSelfManager",
      "IpPoolName": "xxx",
      "IpExt": {
        "HasSendMail": true,
        "AutoRenewal": false,
        "LastWarmUpTypeChangedTime": ""
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.