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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
swas-open:ListInstances	get	Instance acs:swas-open:{#regionId}:{#accountId}:instance/* Instance acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

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 servers. Valid values: Pending Starting Running Stopping Stopped Resetting Upgrading Disabled	Running
Tag	array<object>	No	The tags that are added to the simple application servers.
	object	No	The tag to add to the resource.
Key	string	No	The tag key of the simple application servers. A tag key can be 1 to 64 characters in length. Valid values of N: 1 to 20.	test
Value	string	No	The tag value of the simple application servers. A tag value can be 1 to 64 characters in length. Valid values of N: 1 to 20.	01
ResourceGroupId	string	No	The ID of the resource group to which the simple application servers belong.	rg-aek2bti7cf7****
InstanceName	string	No	The name of the simple application server. Fuzzy search with the asterisk (*) wildcard is supported.	test

Response parameters

Parameter	Type	Description	Example
	object	Schema of response.
Instances	array<object>	Details about the simple application servers.
Instance	object	The instance list.
Status	string	The status of the simple application server. Valid values: Pending: The server is being prepared. Starting: The server is being started. Running: The server is running. Stopping: The server is being stopped. Stopped: The server is stopped. Resetting: The server is being reset. Upgrading: The server is being upgraded. Disabled: The server is not available.	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 private 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 ID of the instance plan.	swas.s2.c2m2s50b4t08
PublicIpAddress	string	The public IP address.	42.1.XX.XX
RegionId	string	The region ID.	cn-hangzhou
ExpiredTime	string	The time when the simple application 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 simple application 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 the 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 for security reasons. EXPIRED: The server is expired.	EXPIRED
Combination	boolean	Indicates whether the simple application server uses a bundle plan.	false
CombinationInstanceId	string	The ID of the simple application server that uses a bundle plan.	com-f6c9a22****45b5b8de68ad608af1ba
Uuid	string	The universally unique identifier (UUID) of the simple application server.	41f30524-5df7-49c9-9c6e-32****489001
ResourceSpec	object	The specifications of the resource.
DiskCategory	string	The category of the disk. Valid values: ESSD: enhanced SSD (ESSD) of PL0 SSD: standard SSD CLOUD_EFFICIENCY: ultra disk	cloud_efficiency
Cpu	integer	The number of vCPUs of the simple application server.	2
Bandwidth	integer	The bandwidth of the server.	5
DiskSize	integer	The disk size.	60
Memory	double	The memory size of the server.	2
Flow	double	The amount of the traffic. A value of 0 indicates the traffic amount of a bandwidth-based simple application server. A non-zero value indicates the traffic amount of a data transfer plan-based simple application server.	818
Image	object	The description of the image.
OsType	string	The OS.	windows
ImageName	string	The name of the image.	test-custom-1686536882356
ImageVersion	string	The image tag.	V3.5
ImageType	string	The type of the image. 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	array<object>	The tags that are added to the simple application server.
tag	object	The tags.
Key	string	The tag key of the simple application server.	TestKey
Value	string	The tag value of the simple application server.	TestValue
Disks	array<object>	The disks that are attached to the simple application server.
disk	object	The information about the disks.
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.	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 in use. 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 after the disk is attached to the simple application server.	/dev/xvda
Size	integer	The disk size. Unit: GB.	50
DiskName	string	The disk name.	SystemDisk
DiskChargeType	string	The billing method of the disk.	PrePaid
DiskType	string	The disk type. Valid values: system: system disk data: data disk	System
Category	string	The category of the disk. Valid values: ESSD: ESSD of PL0 SSD: standard SSD CLOUD_EFFICIENCY: an ultra disk.	ESSD
DiskId	string	The disk ID.	d-bp14wq0149cpp2x****
RegionId	string	The region ID.	cn-hangzhou
Remark	string	The remarks of the disk.	remark
DiskTags	array<object>	The tags that are added to the disk.
tag	object	The tags of the disk.
Key	string	The tag key.	TestKey
Value	string	The tag value.	TestValue
ResourceGroupId	string	The ID of the resource group to which the disk belongs.	rg-aek2bti7cf7****
ResourceGroupId	string	The ID of the resource group to which the server belongs.	rg-aekz7jmhg5s****
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"
            }
          ],
          "ResourceGroupId": "rg-aek2bti7cf7****\n"
        }
      ],
      "ResourceGroupId": "rg-aekz7jmhg5s****"
    }
  ],
  "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-06-17	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-05-29	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-02-20	The Error code has changed. The response structure of the API has changed	View Change Details
2024-01-17	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-09-18	API Description Update. The Error code has changed	View Change Details
2023-07-19	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-05-25	The Error code has changed. The response structure of the API has changed	View Change Details