ListInstances - Simple Application Server - Alibaba Cloud Documentation Center

Queries the information about simple application servers in a region.

Operation description

You can call this operation to query the details of simple application servers in a specified region, including the names, public IP addresses, internal IP addresses, creation time, and expiration time of the servers.

QPS limit

You can call this API operation up to 10 times per minute per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application servers.	cn-hangzhou
InstanceIds	string	No	The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,). Note If you specify both `InstanceIds` and `PublicIpAddresses`, make sure that the specified IDs and the specified public IP addresses belong to the same simple application servers. Otherwise, an empty result is returned.	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]
ChargeType	string	No	The billing method of the simple application servers. Set the value to PrePaid, which indicates the subscription billing method. Default value: PrePaid.	PrePaid
PublicIpAddresses	string	No	The public IP addresses of the simple application servers. The value can be a JSON array that consists of up to 100 IP addresses. Separate multiple IP addresses with commas (,). Note If you specify both `InstanceIds` and `PublicIpAddresses`, make sure that the specified IDs and the specified public IP addresses belong to the same simple application servers. Otherwise, an empty result is returned.	["42.1..", "42.2.."]
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	10
Status	string	No	The status of the simple application server. Valid values: Pending Starting Running Stopping Stopped Resetting Upgrading Disabled	Running
Tag	object []	No	The tag. You can add at most 20 tags to an instance.
Key	string	No	The tag key. The tag key can be up to 128 characters in length, and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.	test
Value	string	No	The tag value.	01

Response parameters

Parameter	Type	Description	Example
	object	Schema of response.
Instances	object []	Details about the simple application servers.
Status	string	The status of the simple application server. Valid values: Pending Starting Running Stopping Stopped Resetting Upgrading Disabled	Running
CreationTime	string	The time when the simple application server was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-03-08T05:31:06Z
InnerIpAddress	string	The internal IP address of the simple application server.	172.26.XX.XX
ChargeType	string	The billing method of the simple application server.	PrePaid
InstanceId	string	The ID of the simple application server.	2ad1ae67295445f598017499dc****
PlanId	string	The plan ID.	swas.s2.c2m2s50b4t08
PublicIpAddress	string	The public IP address of the server.	42.1.XX.XX
RegionId	string	The region ID of the servers.	cn-hangzhou
ExpiredTime	string	The time when the server expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-05-08T16:00:00Z
InstanceName	string	The name of the server.	test-InstanceName
BusinessStatus	string	The status of the server. Valid values: Normal: The server is normal. Expired: The server expires. Overdue: The payment of the server is overdue.	Normal
DdosStatus	string	The DDoS protection status of the server. Valid values: Normal: The DDoS protection status of the server is normal. BlackHole: The server is in blackhole filtering. Defense: The server is being scrubbed.	Normal
ImageId	string	The ID of an image.	fe9c66133a9d4688872869726b52****
DisableReason	string	The reason why the server is disabled. Valid values: FINANCIAL: The server is locked due to overdue payments. SECURITY: The server is locked due to security reasons. EXPIRED: The server has expired.	EXPIRED
Combination	boolean	Indicates whether the plan is a bundle plan.	false
CombinationInstanceId	string	The ID of the bundle plan.	com-f6c9a22****45b5b8de68ad608af1ba
Uuid	string	The universally unique identifier (UUID) of the server.	41f30524-5df7-49c9-9c6e-32****489001
ResourceSpec	object	The specifications of the resource.
DiskCategory	string	The category of the disk. Valid values: ESSD: an enhanced SSD (ESSD) at performance level 0 (PL0). SSD: a standard SSD. CLOUD_EFFICIENCY: an ultra disk.	cloud_efficiency
Cpu	integer	The number of vCPUs.	2
Bandwidth	integer	The bandwidth of the server.	5
DiskSize	integer	The disk size.	60
Memory	double	The memory size.	2
Flow	double	The amount of the traffic. A value of 0 indicates that the server is a bandwidth-based server. A value of none-zero indicates that the server is a data transfer plan-based server.	818
Image	object	The description of the image.
OsType	string	The OS.	windows
ImageName	string	The image name.	test-custom-1686536882356
ImageVersion	string	The image tag.	V3.5
ImageType	string	The image type. Valid values: system app custom	system
ImageIconUrl	string	The URL of the image icon.	https://img.alicdn.com/imgextra/i3/O**1vdh9651ReKqWNMI2I_!!6000000002136**-24-24.svg
ImageContact	string	The image provider.	https://selfs****e.console.aliyun.com/ticket/createIndex
Tags	object []	The tags.
Key	string	The key of tag N to be added to the simple application server. Valid values of N: 1 to 20.	TestKey
Value	string	The value of tag N to be added to the simple application server. Valid values of N: 1 to 20.	TestValue
Disks	object []	Details about the disks.
CreationTime	string	The time when the Disk was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-02-24T02:20:10Z
Status	string	The status of the disk. Valid values: ReIniting: The disk is being initialized. Creating: The disk is being created. In_Use: The disk is being used. Available: The disk can be attached. Attaching: The disk is being attached. Detaching: The disk is being detached.	In_use
Device	string	The device name of the disk on the simple application server.	/dev/xvda
Size	integer	The size of the disk. Unit: GB.	50
DiskName	string	The name of the disk.	SystemDisk
DiskChargeType	string	The billing method of the disk.	PrePaid
DiskType	string	The type of the disk. Valid values: System: system disk. Data: data disk.	System
Category	string	The category of the disk. Valid values: ESSD: an enhanced SSD (ESSD) at performance level 0 (PL0). SSD: a standard SSD. CLOUD_EFFICIENCY:an ultra disk.	ESSD
DiskId	string	The ID of the disk.	d-bp14wq0149cpp2x****
RegionId	string	The region ID of the disks.	cn-hangzhou
Remark	string	Description about the disk.	remark
DiskTags	object []	The tags of the disk.
Key	string	The key of tag N to be added to the disk. Valid values of N: 1 to 20.	TestKey
Value	string	The value of tag N to be added to the disk. Valid values of N: 1 to 20.	TestValue
TotalCount	integer	The total number of entries returned.	1
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F****
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1

Examples

Sample success responses

JSONformat

{
  "Instances": [
    {
      "Status": "Running",
      "CreationTime": "2021-03-08T05:31:06Z",
      "InnerIpAddress": "172.26.XX.XX",
      "ChargeType": "PrePaid",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "PlanId": "swas.s2.c2m2s50b4t08",
      "PublicIpAddress": "42.1.XX.XX",
      "RegionId": "cn-hangzhou",
      "ExpiredTime": "2021-05-08T16:00:00Z",
      "InstanceName": "test-InstanceName",
      "BusinessStatus": "Normal",
      "DdosStatus": "Normal",
      "ImageId": "fe9c66133a9d4688872869726b52****",
      "DisableReason": "EXPIRED",
      "Combination": false,
      "CombinationInstanceId": "com-f6c9a22****45b5b8de68ad608af1ba",
      "Uuid": "41f30524-5df7-49c9-9c6e-32****489001",
      "ResourceSpec": {
        "DiskCategory": "cloud_efficiency",
        "Cpu": 2,
        "Bandwidth": 5,
        "DiskSize": 60,
        "Memory": 2,
        "Flow": 818
      },
      "Image": {
        "OsType": "windows",
        "ImageName": "test-custom-1686536882356",
        "ImageVersion": "V3.5",
        "ImageType": "system",
        "ImageIconUrl": "https://img.alicdn.com/imgextra/i3/O****1vdh9651ReKqWNMI2I_!!6000000002136****-24-24.svg",
        "ImageContact": "https://selfs****e.console.aliyun.com/ticket/createIndex"
      },
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "Disks": [
        {
          "CreationTime": "2023-02-24T02:20:10Z",
          "Status": "In_use",
          "Device": "/dev/xvda",
          "Size": 50,
          "DiskName": "SystemDisk",
          "DiskChargeType": "PrePaid",
          "DiskType": "System",
          "Category": "ESSD",
          "DiskId": "d-bp14wq0149cpp2x****",
          "RegionId": "cn-hangzhou",
          "Remark": "remark",
          "DiskTags": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ]
        }
      ]
    }
  ],
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "PageSize": 10,
  "PageNumber": 1
}

Error codes

HTTP status code	Error code	Error message
400	InvalidChargeType.ValueNotSupported	The specified parameter ChargeType is invalid.
400	InvalidPublicIpAddresses.ValueNotSupported	The specified parameter PublicIpAddresses is invalid.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.
500	InternalError	An error occurred while processing your request.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-02-20

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.

2024-01-17

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 500
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Tag

2023-09-18

API Description Update. The Error code has changed

see changesets

Change item	Change content
API Description	API Description Update.
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 500

2023-07-19

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 500
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Status

2023-05-25

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.