调用DescribeDisks查询一块或多块您已经创建的块存储(包括云盘以及本地盘)。

接口说明

  • 请求参数RegionIdZoneIdDiskIdsInstanceId等都是过滤器的概念,参数间是逻辑与(AND)关系。
  • 请求参数DiskIds是一个JSON格式的数组(Array),如果参数为空,则过滤器不起作用,但是DiskIds如果是一个空数组,则视为该过滤器有效,且返回空。
  • 支持以下两种方式查看返回数据:
    • 方式一:通过NextToken设置查询凭证(Token),其取值是上一次调用DescribeDisks返回的NextToken参数值,再通过MaxResults设置单页查询的最大条目数。
    • 方式二:通过PageSize设置单页返回的条目数,再通过PageNumber设置页码。

      以上两种方式只能任选其中之一。当返回的条目数较多时,推荐使用方式一。如果设置了NextToken,则请求参数PageSizePageNumber将失效,且返回数据中的TotalCount无效。

  • 开启多重挂载特性的云盘可以挂载到多个实例上,您可以根据返回结果的Attachment列表查看云盘涉及的所有挂载信息。

通过阿里云CLI调用API时,不同数据类型的请求参数取值必须遵循格式要求。更多信息,请参见CLI参数格式说明

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDisks

系统规定参数。取值:DescribeDisks

RegionId String cn-hangzhou

块存储所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

ZoneId String cn-hangzhou-g

可用区ID。

DiskIds String ["d-bp67acfmxazb4p****", "d-bp67acfmxazb4g****", … "d-bp67acfmxazb4d****"]

云盘或本地盘ID。一个带有格式的JSON数组,最多支持100个ID,用半角逗号(,)隔开。

InstanceId String i-bp67acfmxazb4q****

云盘或本地盘挂载的实例ID。

DiskType String all

要查询的云盘或本地盘类型。取值范围:

  • all:同时查询系统盘与数据盘。
  • system:只查询系统盘。
  • data:只查询数据盘。

默认值:all。

Category String all

云盘或本地盘种类。取值范围:

  • all:所有云盘以及本地盘。
  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD盘。
  • cloud_essd:ESSD云盘。

  • cloud_auto:ESSD AutoPL云盘。
  • local_ssd_pro:I/O密集型本地盘。
  • local_hdd_pro:吞吐密集型本地盘。
  • ephemeral:(已停售)本地盘。
  • ephemeral_ssd:(已停售)本地SSD盘。

默认值:all。

ESSD AutoPL云盘正在邀测中,邀测地域支持华东6(乌兰察布)和华南2(河源)。如需使用,请前往邀测页面申请

Status String All

云盘状态。更多信息,请参见云盘状态。取值范围:

  • In_use。
  • Available。
  • Attaching。
  • Detaching。
  • Creating。
  • ReIniting。
  • All。

默认值:All。

SnapshotId String s-bp67acfmxazb4p****

创建云盘时使用的快照ID。

Portable Boolean false

云盘或本地盘是否支持卸载。取值范围:

  • true:支持。可以独立存在,且可以在可用区内自由挂载和卸载。
  • false:不支持。不可以独立存在,且不可以在可用区内自由挂载和卸载。

以下类型块存储的Portable属性都为false,生命周期与实例等同:

  • 本地盘。
  • 本地SSD盘。
  • 包年包月数据盘。
DeleteWithInstance Boolean false

云盘是否设置了随实例释放。取值范围:

  • true:云盘随实例一起释放。
  • false:云盘保留不释放,转为按量付费数据盘而保留下来。

默认值:false。

DeleteAutoSnapshot Boolean false

释放云盘时,是否会同时释放自动快照。

  • true:是。
  • false:否。

默认值:false。

PageNumber Integer 1

云盘或本地盘状态列表的页码。

起始值:1。

默认值:1。

PageSize Integer 10

分页查询时设置的每页行数。

最大值:100。

默认值:10。

NextToken String AAAAAdDWBF2****

查询凭证(Token),取值为上一次API调用返回的NextToken参数值。

有关本接口查看返回数据的设置方式,请参见上文接口说明