Skip to Content
云硬盘 UDisk获取云硬盘列表 - DescribeUDisk

获取云硬盘列表 - DescribeUDisk

简介

获取UDisk实例

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称，当前 API 为 DescribeUDiskYes
PublicKeystring用户公钥，可从 控制台  获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名，参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
Zonestring可用区。参见 可用区列表No
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口No
UDiskIdstringUDisk Id(留空返回全部)No
Offsetint数据偏移量, 默认为0No
Limitint返回数据长度, 默认为20No
DiskTypestringProtocolVersion字段为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
ProtocolVersionint请求协议版本，建议升级为1，为1时DiskType与UHost磁盘类型定义一致；默认为0No
IsBootstringProtocolVersion字段为1且DiskType不为空时，必须设置，设置规则请参照DiskType；ProtocolVersion字段为1且DiskType为空时，该字段无效。ProtocolVersion字段为0或没有该字段时，该字段无效。No
IgnoreUBillInfostring是否忽略计费信息。Yes：忽略，No：不忽略，默认值（No）。（如不关心账单信息，建议选填“Yes”，可降低请求延时）No
IgnoreBackupModestring是否忽略快照服务信息。Yes：忽略，No：不忽略，默认值（No）。（如不关心快照服务信息，建议选填“Yes”，可降低请求延时）No
UDiskBasicInfostring是否只返回云盘基础信息（只包含云盘及关联主机的资源信息）。Yes：是，No：否，默认值（No）。（如仅需要基础信息，建议选填“Yes”，可降低请求延时）No
UHostIdForAttachmentstring根据传入的UHostIdForAttachment，筛选出能被挂载在该主机上的云盘【本字段即将废弃，建议使用HostIdForAttachment】No
HostIdForAttachmentstring根据传入的HostIdForAttachment，筛选出能被挂载在该主机上的云盘。目前主要针对RSSD云盘。No
HostIdstring根据传入的HostId，返回与该主机关联的云盘信息。No
HostProductstring宿主产品类型，可筛选挂载在该类型宿主上的云盘。可选值：uhost, uphost。为空拉取所有。（当HostIdForAttachment字段不为空时，该字段可以不填，若HostIdForAttachment与该字段宿主类型冲突，则以HostIdForAttachment字段为准。）No
Statusstring云盘状态。All(所有状态)，Available(可用)，Attaching(挂载中)，InUse(已挂载)， Detaching(卸载中)， Initializating(分配中)，Failed(创建失败)，Cloning(克隆中)，Restoring(恢复中)，RestoreFailed(恢复失败)。默认值：AllNo
Tagstring业务组名称No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码，为 0 则为成功返回，非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息，当 RetCode 非 0 时提供详细的描述信息No
DataSetarray[UDiskDataSet]JSON 格式的UDisk数据列表, 每项参数可见下面 UDiskDataSetNo
TotalCountint根据过滤条件得到的总数No

数据模型

UDiskDataSet

字段名类型描述信息必填
Zonestring可用区No
UDiskIdstringUDisk实例IdNo
Namestring实例名称No
Sizeint容量单位GBNo
Statusstring状态:Available(可用),Attaching(挂载中), InUse(已挂载), Detaching(卸载中), Initializating(分配中), Failed(创建失败),Cloning(克隆中),Restoring(恢复中),RestoreFailed(恢复失败)No
CreateTimeint创建时间No
ExpiredTimeint过期时间No
UHostIdstring挂载的UHost的Id。【即将废弃，建议使用HostId】No
UHostNamestring挂载的UHost的Name。【即将废弃，建议使用HostName】No
UHostIPstring挂载的UHost的IP。【即将废弃，建议使用HostIP】No
HostIdstring挂载的Host的IdNo
HostNamestring挂载的Host的NameNo
HostIPstring挂载的Host的IPNo
DeviceNamestring挂载的设备名称No
ChargeTypestringYear,Month,Dynamic,Trial,PostpayNo
Tagstring业务组名称No
IsExpirestring资源是否过期，过期:“Yes”, 未过期:“No”No
Versionstring是否支持数据方舟，支持:“2.0”, 不支持:“1.0”No
UDataArkModestring是否开启数据方舟，开启:“Yes”, 不支持:“No”No
SnapshotCountint该盘快照个数No
SnapshotLimitint该盘快照上限No
DiskTypestring请求中的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
CloneEnableint是否支持克隆，1支持 ，0不支持No
SnapEnableint是否支持快照，1支持 ，0不支持No
ArkSwitchEnableint是否支持开启方舟，1支持 ，0不支持No
UKmsModestring是否是加密盘，是:“Yes”, 否:“No”No
CmkIdstring该盘的cmk idNo
DataKeystring该盘的密文密钥No
CmkIdStatusstring该盘cmk的状态, Enabled(正常)，Disabled(失效)，Deleted(删除)，NoCmkId(非加密盘)No
CmkIdAliasstringcmk id 别名No
IsBootstring是否是系统盘，是：“True”, 否：“False”No
BackupModestring该盘的备份方式。快照服务：“SnapshotService”；数据方舟：“UDataArk”；无备份方式：""No
RdmaClusterIdstringRDMA集群id，仅RSSD、ERSSD返回该值；其他类型云盘返回""。当云盘的此值与快杰云主机的RdmaClusterId相同时，该云盘可以挂载到这台云主机No

示例

请求示例

https://api.tnqacloud.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

响应示例

{
  "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
}
【已废弃】拉取回收站中云硬盘列表 - DescribeRecycleUDisk获取云硬盘价格 - DescribeUDiskPrice