ListDisks - Simple Application Server - Alibaba Cloud Documentation Center

Queries the information about disks in a region.

Operation description

The InstanceId, DiskIds, and ResourceGroupId parameters are optional. However, you can specify them as filter conditions and combine them with the logical AND operator to filter disks that you want to query.

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

swas-open:ListDisks

get

*Disk

acs:swas-open:{#regionId}:{#accountId}:disk/{#DiskId}

*Disk

acs:swas-open:{#regionId}:{#accountId}:disk/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the disks.	cn-hangzhou
InstanceId	string	No	The ID of the simple application server.	2ad1ae67295445f598017499dc****
DiskIds	string	No	The IDs of the disks. The value can be a JSON array that consists of up to 100 disk IDs. Separate multiple disk IDs with commas (,).	["d-bp14wq0149cpp2x**", "d-bp14wq0149cpp2y**"]
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	10
PageNumber	integer	No	The page number. Default value: 1.	1
DiskType	string	No	The disk type. Valid values: system: system disk data: data disk By default, system disks and data disks are both queried.	system
Tag	array<object>	No	The tags that are added to the disks.
	object	No	The tags of the disk.
Key	string	No	The tag key. The tag key can be up to 64 characters in length. Valid values of N: 1 to 20.	TestKey
Value	string	No	The tag value. The tag value can be up to 64 characters in length. Valid values of N: 1 to 20.	TestValue
ResourceGroupId	string	No	The ID of the resource group.	rg-aek2bti7cf7****

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	1
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
Disks	array<object>	The queried disks.
	array<object>	The information 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.	2021-03-08T05:31:06Z
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 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 disk type. Valid values: system: system disk data: data disk	System
Category	string	The category of the disk. Valid values: ESSD: enhanced SSD (ESSD) of PL0 SSD: standard SSD CLOUD_EFFICIENCY: ultra disk	ESSD
DiskId	string	The disk ID.	d-bp14wq0149cpp2x****
InstanceId	string	The ID of the simple application server to which the disk is attached.	2ad1ae67295445f598017499dc****
RegionId	string	The region ID.	cn-hangzhou
Remark	string	The remarks of the disk.	remark
Tags	array<object>	The tags that are added to the disks.
	object	The tags of the disk.
Key	string	The tag key.	TestKey
Value	string	The tag value.	TestValue
InstanceName	string	The name of the simple application server.	myInstance
ResourceGroupId	string	The ID of the resource group to which the disk belongs.	rg-aek2bti7cf7****

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "Disks": [
    {
      "CreationTime": "2021-03-08T05:31:06Z",
      "Status": "In_use",
      "Device": "/dev/xvda",
      "Size": 50,
      "DiskName": "SystemDisk",
      "DiskChargeType": "PrePaid",
      "DiskType": "System",
      "Category": "ESSD",
      "DiskId": "d-bp14wq0149cpp2x****",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "RegionId": "cn-hangzhou",
      "Remark": "remark",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "InstanceName": "myInstance",
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.