DedicatedIpList - Direct Mail - Alibaba Cloud Documentation Center

Lists purchased IPs.

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 index, starting from 1.	1
PageSize	integer	Yes	The page size.	10
Keyword	string	No	The search keyword for IP addresses.	xxx

Response elements

Element	Type	Description	Example
	object	The response object.
TotalCounts	integer	The total number of purchased IPs.	5
RequestId	string	The request ID.	xxx
HasMore	boolean	Indicates whether another page of results is available.	false
CurrentPage	integer	The current page number.	1
PageSize	integer	The page size.	10
Ips	array<object>	The list of IPs.
	array<object>	Details about a purchased IP.
Id	string	The ID of the IP address, which is the same as the ID of the purchased instance.	xxx
Ip	string	The IP address.	xxx
InstanceId	string	The ID of the purchased instance.	xxx
StartTime	string	The time when the IP was purchased.	2025-05-12T09:19:20Z
ExpiredTime	string	The expiration time.	2025-06-12T09:19:20Z
Status	string	The status of the IP. Valid values: sold : Purchased expired : Expired	sold
WarmupStatus	string	The warm-up status. Valid values: init : Pending processing : Processing finish : Completed	finish
WarmupType	string	The warm-up method. Valid values: sysCusStream : System warm-up cusSelfManager : Manual warm-up	cusSelfManager
IpPoolName	string	The name of the IP pool to which the IP belongs.	xxx
IpExt	object	Extended properties.
HasSendMail	boolean	Indicates whether an email has 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	The last time the warm-up status changed.	2025-08-07T07:23:49.329Z
ZoneId	string	The ID of the zone where the IP address is located. ap-southeast-1a ap-southeast-1b cn-hangzhou-k cn-shanghai-l eu-central-1a eu-central-1b us-east-1a us-east-1b	ap-southeast-1a

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": "2025-08-07T07:23:49.329Z"
      },
      "ZoneId": "ap-southeast-1a"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.