# DescribeDisks
## 1. API Description
This API (DescribeDisks) is used to query the details of disks.
## 2. Input Parameters
The following request parameter list only provides API request parameters.
| Parameter Name | Required | Type | Description |
| --------------- | -------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| diskIds | No | Array of String | ID list of disks. |
| diskName | No | String | Disk name. |
| diskStatus | No | [DiskStatus](/api-reference/compute/vm/datastructure.md#diskstatus) | Disk status. |
| diskType | No | [DiskType](/api-reference/compute/vm/datastructure.md#disktype) | Disk type.SYSTEM: System Disk;DATA: Data Disk. |
| diskCategory | No | String | Disk type.Standard Disk: Hard Disk DriveSSD: Solid State DriveThe default value is Standard Disk.
Call DescribeDiskCategory to obtain disk type.
|
| diskSize | No | Integer | Disk size. Unit: GB.
Value range: \[20, 20000]
|
| portable | No | Boolean | Whether the disk is detachable or not.
true: the disk is detachable, and thus will not be deleted while deleting its attached instance and becomes AVAILABLE.
false: the disk is undetachable, and thus will be deleted at the same time while deleting its attached instance.
|
| instanceId | No | String | Instance ID. |
| zoneId | No | String | Zone ID.
To obtain zone ID, call DescribeZones.
|
| pageNum | No | Integer | Number of pages returned.
Default value: 1.
Default value: 1
|
| pageSize | No | Integer | Number of items in the current page result.
Default value: 20;
Maximum value: 1000.
|
| resourceGroupId | No | String | Resource group ID.
If the value is null, then return all the instances in the authorized resource groups.
|
| tagKeys | No | Array of String | Query using tag keys.
A maximum of 20 tag keys can be used.
|
| tags | No | Array of [Tag](/api-reference/compute/vm/datastructure.md#tag) | Query using tags.
A maximum of 20 tags can be used.
|
## 3. Output Parameters
| Parameter Name | Type | Description |
| -------------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |
| requestId | String | The unique request ID, which is returned for each request.
RequestId is required for locating a problem.
|
| totalCount | Integer | Number of disks meeting the filtering conditions. |
| dataSet | Array of [DiskInfo](/api-reference/compute/vm/datastructure.md#diskinfo) | Information on a disk. |
## 4. Code Example
{% tabs %}
{% tab title="Example" %}
**Query the details of disks.**
```json
POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeDisks
Request:
{
"diskStatus": "AVAILABLE",
"diskSize": 20,
"portable": true,
"zoneId": "SIN-E"
}
Response:
{
"requestId": "T83B6A963-B111-4BF9-8466-1C3351E2DFD1",
"response": {
"requestId": "T83B6A963-B111-4BF9-8466-1C3351E2DFD1",
"dataSet": [
{
"diskName": "default-SIN-20GB-01",
"period": 1,
"instanceName": "Test-Instanc",
"chargeType": "PREPAID",
"portable": true,
"expiredTime": "2023-02-01T00:00:00Z",
"diskSize": 20,
"instanceId": "your-instance-id-1",
"createTime": "2023-02-01T00:00:00Z",
"zoneId": "SIN-E",
"diskStatus": "AVAILABLE",
"diskId": "disk-id-1",
"diskType": "DATA",
"diskCategory": "Standard Disk",
"autoRenew": true
},
{
"diskName": "default-SIN-20GB-01",
"period": 1,
"instanceName": "Test-Instance",
"chargeType": "PREPAID",
"portable": true,
"expiredTime": "2023-02-01T00:00:00Z",
"diskSize": 20,
"instanceId": "your-instance-id-1",
"createTime": "2023-01-01T00:00:00Z",
"zoneId": "SIN-E",
"diskStatus": "AVAILABLE",
"diskId": "disk-id-2",
"diskType": "SYSTEM",
"diskCategory": "Standard Disk",
"autoRenew": true
}
],
"totalCount": 2
}
}
```
{% endtab %}
{% endtabs %}
## 5. Developer Resources
Zenlayer Cloud API 2.0 integrates [SDKs](/api-reference/api-introduction/toolkit/api-sdk.md)，to make it easier for you to call APIs. More programming languages will be supported.
## 6. Error Codes
The following only lists the error codes related to the API business logic. For other error codes, see [Common Error Codes](/api-reference/api-introduction/instruction/commonerrorcode.md).
| HTTP Status Code | Error Code | Description |
| ---------------- | ------------------------- | --------------- |
| 404 | INVALID\_ZONE\_NOT\_FOUND | Zone not found. |
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.console.zenlayer.com/api-reference/compute/vm/disk/describedisks.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.