# 获取云硬盘列表 - DescribeUDisk

## 简介

获取UDisk实例





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `DescribeUDisk`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.genesissai.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Region** | string | 地域。 参见 [地域和可用区列表](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | 可用区。参见 [可用区列表](/docs/api/summary/regionlist) |No|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |No|
| **UDiskId** | string | UDisk Id(留空返回全部) |No|
| **Offset** | int | 数据偏移量, 默认为0 |No|
| **Limit** | int | 返回数据长度, 默认为20 |No|
| **DiskType** | string | ProtocolVersion字段为1时，需结合IsBoot确定具体磁盘类型:普通数据盘：DiskType:"CLOUD_NORMAL",IsBoot:"False"；普通系统盘：DiskType:"CLOUD_NORMAL",IsBoot:"True"；SSD数据盘：DiskType:"CLOUD_SSD",IsBoot:"False"；SSD系统盘：DiskType:"CLOUD_SSD",IsBoot:"True"；经济型SSD数据盘：DiskType:"CLOUD_ESSD",IsBoot:"False"；经济型SSD系统盘：DiskType:"CLOUD_ESSD",IsBoot:"True"；RSSD数据盘：DiskType:"CLOUD_RSSD",IsBoot:"False"；RSSD系统盘：DiskType:"CLOUD_RSSD",IsBoot:"True"；经济型RSSD数据盘：DiskType:"CLOUD_ERSSD",IsBoot:"False"；经济型RSSD系统盘：DiskType:"CLOUD_ERSSD",IsBoot:"True"；高效数据盘：DiskType:"CLOUD_EFFICIENCY",IsBoot:"False"；高效系统盘：DiskType:"CLOUD_EFFICIENCY",IsBoot:"True"；为空拉取所有。ProtocolVersion字段为0或没有该字段时，可设为以下几个值:普通数据盘：DataDisk；普通系统盘：SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；经济型SSD数据盘：ESSDDataDisk；经济型SSD系统盘：ESSDSystemDisk；RSSD数据盘：RSSDDataDisk；RSSD系统盘：RSSDSystemDisk；经济型RSSD数据盘：ERSSDDataDisk；经济型RSSD系统盘：ERSSDSystemDisk；高效数据盘：EfficiencyDataDisk；高效系统盘：EfficiencySystemDisk；为空拉取所有。 |No|
| **ProtocolVersion** | int | 请求协议版本，建议升级为1，为1时DiskType与UHost磁盘类型定义一致；默认为0 |No|
| **IsBoot** | string | ProtocolVersion字段为1且DiskType不为空时，必须设置，设置规则请参照DiskType；ProtocolVersion字段为1且DiskType为空时，该字段无效。ProtocolVersion字段为0或没有该字段时，该字段无效。 |No|
| **IgnoreUBillInfo** | string | 是否忽略计费信息。Yes：忽略，No：不忽略，默认值（No）。（如不关心账单信息，建议选填“Yes”，可降低请求延时） |No|
| **IgnoreBackupMode** | string | 是否忽略快照服务信息。Yes：忽略，No：不忽略，默认值（No）。（如不关心快照服务信息，建议选填“Yes”，可降低请求延时） |No|
| **UDiskBasicInfo** | string | 是否只返回云盘基础信息（只包含云盘及关联主机的资源信息）。Yes：是，No：否，默认值（No）。（如仅需要基础信息，建议选填“Yes”，可降低请求延时） |No|
| **UHostIdForAttachment** | string | 根据传入的UHostIdForAttachment，筛选出能被挂载在该主机上的云盘【本字段即将废弃，建议使用HostIdForAttachment】 |No|
| **HostIdForAttachment** | string | 根据传入的HostIdForAttachment，筛选出能被挂载在该主机上的云盘。目前主要针对RSSD云盘。 |No|
| **HostId** | string | 根据传入的HostId，返回与该主机关联的云盘信息。 |No|
| **HostProduct** | string | 宿主产品类型，可筛选挂载在该类型宿主上的云盘。可选值：uhost, uphost。为空拉取所有。（当HostIdForAttachment字段不为空时，该字段可以不填，若HostIdForAttachment与该字段宿主类型冲突，则以HostIdForAttachment字段为准。） |No|
| **Status** | string | 云盘状态。All(所有状态)，Available(可用)，Attaching(挂载中)，InUse(已挂载)， Detaching(卸载中)， Initializating(分配中)，Failed(创建失败)，Cloning(克隆中)，Restoring(恢复中)，RestoreFailed(恢复失败)。默认值：All |No|
| **Tag** | string | 业务组名称 |No|
| **UDiskName** | string | 云盘实例名称 |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **DataSet** | array[[*UDiskDataSet*](#UDiskDataSet)] | JSON 格式的UDisk数据列表, 每项参数可见下面 UDiskDataSet |No|
| **TotalCount** | int | 根据过滤条件得到的总数 |No|

#### 数据模型


#### UDiskDataSet

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Zone** | string | 可用区 |No|
| **UDiskId** | string | UDisk实例Id |No|
| **Name** | string | 实例名称 |No|
| **Size** | int | 容量单位GB |No|
| **Status** | string | 状态:Available(可用),Attaching(挂载中), InUse(已挂载), Detaching(卸载中), Initializating(分配中), Failed(创建失败),Cloning(克隆中),Restoring(恢复中),RestoreFailed(恢复失败) |No|
| **CreateTime** | int | 创建时间 |No|
| **ExpiredTime** | int | 过期时间 |No|
| **UHostId** | string | 挂载的UHost的Id。【即将废弃，建议使用HostId】 |No|
| **UHostName** | string | 挂载的UHost的Name。【即将废弃，建议使用HostName】 |No|
| **UHostIP** | string | 挂载的UHost的IP。【即将废弃，建议使用HostIP】 |No|
| **HostId** | string | 挂载的Host的Id |No|
| **HostName** | string | 挂载的Host的Name |No|
| **HostIP** | string | 挂载的Host的IP |No|
| **DeviceName** | string | 挂载的设备名称 |No|
| **ChargeType** | string | Year,Month,Dynamic,Trial,Postpay |No|
| **Tag** | string | 业务组名称 |No|
| **IsExpire** | string | 资源是否过期，过期:"Yes", 未过期:"No" |No|
| **Version** | string | 是否支持数据方舟，支持:"2.0", 不支持:"1.0" |No|
| **UDataArkMode** | string | 是否开启数据方舟，开启:"Yes", 不支持:"No" |No|
| **SnapshotCount** | int | 该盘快照个数 |No|
| **SnapshotLimit** | int | 该盘快照上限 |No|
| **DiskType** | string | 请求中的ProtocolVersion字段为1时，需结合IsBoot确定具体磁盘类型:普通数据盘：DiskType:"CLOUD_NORMAL",IsBoot:"False"； 普通系统盘：DiskType:"CLOUD_NORMAL",IsBoot:"True"；SSD数据盘：DiskType:"CLOUD_SSD",IsBoot:"False"；SSD系统盘：DiskType:"CLOUD_SSD",IsBoot:"True"；经济型SSD数据盘：DiskType:"CLOUD_ESSD",IsBoot:"False"；经济型SSD系统盘：DiskType:"CLOUD_ESSD",IsBoot:"True"；RSSD数据盘：DiskType:"CLOUD_RSSD",IsBoot:"False"；RSSD系统盘：DiskType:"CLOUD_RSSD",IsBoot:"True"；经济型RSSD数据盘：DiskType:"CLOUD_ERSSD",IsBoot:"False"；经济型RSSD系统盘：DiskType:"CLOUD_ERSSD",IsBoot:"True"；高效数据盘：DiskType:"CLOUD_EFFICIENCY",IsBoot:"False"；高效系统盘：DiskType:"CLOUD_EFFICIENCY",IsBoot:"True"。请求中的ProtocolVersion字段为0或没有该字段时，云硬盘类型参照如下:普通数据盘：DataDisk；普通系统盘：SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；经济型SSD数据盘：ESSDDataDisk；经济型SSD系统盘：ESSDSystemDisk；RSSD数据盘：RSSDDataDisk；RSSD系统盘：RSSDSystemDisk；经济型RSSD数据盘：ERSSDDataDisk；经济型RSSD系统盘：ERSSDSystemDisk；高效数据盘：EfficiencyDataDisk；高效系统盘：EfficiencySystemDisk。 |No|
| **CloneEnable** | int | 是否支持克隆，1支持 ，0不支持 |No|
| **SnapEnable** | int | 是否支持快照，1支持 ，0不支持 |No|
| **ArkSwitchEnable** | int | 是否支持开启方舟，1支持 ，0不支持 |No|
| **UKmsMode** | string | 是否是加密盘，是:"Yes", 否:"No" |No|
| **CmkId** | string | 该盘的cmk id |No|
| **DataKey** | string | 该盘的密文密钥 |No|
| **CmkIdStatus** | string | 该盘cmk的状态, Enabled(正常)，Disabled(失效)，Deleted(删除)，NoCmkId(非加密盘) |No|
| **CmkIdAlias** | string | cmk id 别名 |No|
| **IsBoot** | string | 是否是系统盘，是："True", 否："False" |No|
| **BackupMode** | string | 该盘的备份方式。快照服务："SnapshotService"；数据方舟："UDataArk"；无备份方式："" |No|
| **RdmaClusterId** | string | RDMA集群id，仅RSSD、ERSSD返回该值；其他类型云盘返回""。当云盘的此值与快杰云主机的RdmaClusterId相同时，该云盘可以挂载到这台云主机 |No|

## 示例

### 请求示例
    
```
https://api.genesissai.com/?Action=DescribeUDisk
&Region=cn-bj2-02
&UDiskId=bs-xxx
&Offset=0
&Limit=20
&ProtocolVersion=8
&IsBoot=irVoOnAn
&IgnoreUBillInfo=kcHclIeG
&UHostIdForAttachment=nMOZskoE
&HostProduct=FsHZvACv
&HostIdForAttachment=HdrfzmYJ
&HostIdForAttachment=gEfcFPyq
&HostProduct=pRsBGeKD
&HostProduct=bCAPVgsw
&IgnoreBackupMode=dfLRzlOw
&UDiskBasicInfo=vfZypiPf
&HostId=HKnuHzKP
&IgnoreBackupMode=UsDNysiR
&UDiskBasicInfo=dZHASGEc
&HostId=VplBwEPT
&IgnoreBackupMode=SUFDaFBS
&UDiskBasicInfo=XJaFNkfA
&HostId=bsRfMMHc
&Status=ZFCNKvKR
&Tag=YotklvEn
&UDiskName=fqjOTKuG
&UDiskName=yJnZVEaw
&UDiskName=XwMDKTOA
```

### 响应示例
    
```json
{
  "Action": "DescribeUDiskResponse",
  "DataSet": [
    {
      "ChargeType": "Dynamic",
      "CreateTime": 1492529621,
      "DeviceName": "",
      "DiskType": "DataDisk",
      "ExpiredTime": 1509706800,
      "IsExpire": "No",
      "Name": "udisk_uda_1",
      "Size": 10,
      "SnapshotCount": 0,
      "SnapshotLimit": 3,
      "Status": "Cloning",
      "Tag": "Default",
      "UDataArkMode": "No",
      "UDiskId": "bs-xxx",
      "UHostIP": "",
      "UHostId": "",
      "UHostName": "",
      "Version": "2.0",
      "Zone": "cn-bj2-02"
    }
  ],
  "RetCode": 0,
  "TotalCount": 50
}
```