Get Cloud Disk List - DescribeUDisk

Overview

Get UDisk Instance

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUDisk`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
Zone	string	Availability Zone. See Availability Zone List	No
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
UDiskId	string	UDisk Id (Leave blank to return all)	No
Offset	int	Data offset, default is 0	No
Limit	int	Return data length, default is 20	No
DiskType	string	When the ProtocolVersion field is 1, the specific disk type needs to be determined in conjunction with IsBoot: Ordinary data disk: DiskType:"CLOUD_NORMAL", IsBoot:"False"; Ordinary system disk: DiskType:"CLOUD_NORMAL", IsBoot:"True"; SSD data disk: DiskType:"CLOUD_SSD", IsBoot:"False"; SSD system disk: DiskType:"CLOUD_SSD", IsBoot:"True"; RSSD data disk: DiskType:"CLOUD_RSSD", IsBoot:"False"; RSSD system disk: DiskType:"CLOUD_RSSD", IsBoot:"True"; High-efficiency data disk: DiskType:"CLOUD_EFFICIENCY", IsBoot:"False"; High-efficiency system disk: DiskType:"CLOUD_EFFICIENCY", IsBoot:"True"; If empty, pull all. When the ProtocolVersion field is 0 or there is no such field, it can be set to the following values: Ordinary data disk: DataDisk; Ordinary system disk: SystemDisk; SSD data disk: SSDDataDisk; SSD system disk: SSDSystemDisk; RSSD data disk: RSSDDataDisk; RSSD system disk: RSSDSystemDisk; High-efficiency data disk: EfficiencyDataDisk; High-efficiency system disk: EfficiencySystemDisk; If empty, pull all.	No
ProtocolVersion	int	Request for protocol version, it is recommended to upgrade to 1, when it is 1, DiskType is consistent with UHost disk type definition; default is 0.	No
IsBoot	string	When the ProtocolVersion field is 1 and DiskType is not empty, it must be set, please refer to DiskType for setting rules; When the ProtocolVersion field is 1 and DiskType is empty, this field is invalid. When the ProtocolVersion field is 0 or this field does not exist, this field is invalid.	No
IgnoreUBillInfo	string	Ignore billing information or not. Yes: Ignore, No: Do not ignore, default value (No). (If you are not concerned about the billing information, it is recommended to choose "Yes" to reduce request latency)	No
IgnoreBackupMode	string	Whether to ignore snapshot service information. Yes: Ignore, No: Do not ignore, default value (No). (If you do not care about snapshot service information, it is recommended to optionally fill in "Yes" to reduce request latency)	No
UDiskBasicInfo	string	Whether to only return the basic information of the cloud disk (including only the resource information of the cloud disk and the associated host). Yes: Yes, No: No, default value (No). (If only basic information is needed, it is recommended to optionally fill in "Yes" to reduce request latency)	No
UHostIdForAttachment	string	Filter out the cloud disks that can be mounted on the host according to the passed UHostIdForAttachment [This field is about to be deprecated, it is recommended to use HostIdForAttachment]	No
HostIdForAttachment	string	Filter out the cloud disks that can be mounted on the host according to the passed HostIdForAttachment. Currently mainly for RSSD cloud disks.	No
HostId	string	Returns the cloud disk information associated with the host based on the passed in HostId.	No
HostProduct	string	Host product type, which can be used to filter the cloud disks mounted on this type of host. Optional values: uhost, uphost. If empty, all will be fetched. (When the HostIdForAttachment field is not empty, this field can be left blank. If the HostIdForAttachment conflicts with the host type of this field, the HostIdForAttachment field will prevail.)	No
Status	string	Cloud Disk Status. All (All Status), Available (Available), Attaching (Mounting), InUse (Mounted), Detaching (Unmounting), Initializating (Allocating), Failed (Creation Failed), Cloning (Cloning), Restoring (Restoring), RestoreFailed (Restore Failed). Default value: All	No
Tag	string	Business Group Name	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
DataSet	array[UDiskDataSet]	JSON formatted UDisk data list, each parameter can be seen below in UDiskDataSet	No
TotalCount	int	Total count based on filter conditions	No

Data Model

UDiskDataSet

Field Name	Type	Description Information	Required
Zone	string	Availability Zone	No
UDiskId	string	UDisk Instance Id	No
Name	string	Instance Name	No
Size	int	Capacity Unit GB	No
Status	string	Status: Available(Available), Attaching(Attaching), InUse(In Use), Detaching(Detaching), Initializating(Allocating), Failed(Failed to Create), Cloning(Cloning), Restoring(Restoring), RestoreFailed(Failed to Restore)	No
CreateTime	int	Creation Time	No
ExpiredTime	int	Expiration Time	No
UHostId	string	The Id of the mounted UHost. [To be deprecated soon, it is recommended to use HostId]	No
UHostName	string	Name of the mounted UHost. [To be deprecated soon, it is recommended to use HostName]	No
UHostIP	string	The IP of the mounted UHost. [Soon to be deprecated, it is recommended to use HostIP]	No
HostId	string	Mounted Host's Id	No
HostName	string	Name of the Mounted Host	No
HostIP	string	Mounted Host's IP	No
DeviceName	string	Mounted Device Name	No
ChargeType	string	Yearly, Monthly, Dynamic, Trial, Postpay	No
Tag	string	Business Group Name	No
IsExpire	string	Whether the resource has expired, expired: "Yes", not expired: "No".	No
Version	string	Does it support UDataArk, support: "2.0", not support: "1.0".	No
UDataArkMode	string	Whether to enable UDataArk, enable: "Yes", not supported: "No".	No
SnapshotCount	int	The number of disk snapshots	No
SnapshotLimit	int	Snapshot limit for this disk	No
DiskType	string	When the ProtocolVersion field in the request is 1, the specific disk type needs to be determined in conjunction with IsBoot: Ordinary data disk: DiskType:"CLOUD_NORMAL", IsBoot:"False"; Ordinary system disk: DiskType:"CLOUD_NORMAL", IsBoot:"True"; SSD data disk: DiskType:"CLOUD_SSD", IsBoot:"False"; SSD system disk: DiskType:"CLOUD_SSD", IsBoot:"True"; RSSD data disk: DiskType:"CLOUD_RSSD", IsBoot:"False"; RSSD system disk: DiskType:"CLOUD_RSSD", IsBoot:"True"; High-efficiency data disk: DiskType:"CLOUD_EFFICIENCY", IsBoot:"False"; High-efficiency system disk: DiskType:"CLOUD_EFFICIENCY", IsBoot:"True". When the ProtocolVersion field in the request is 0 or there is no such field, the cloud disk type is as follows: Ordinary data disk: DataDisk; Ordinary system disk: SystemDisk; SSD data disk: SSDDataDisk; SSD system disk: SSDSystemDisk; RSSD data disk: RSSDDataDisk; RSSD system disk: RSSDSystemDisk; High-efficiency data disk: EfficiencyDataDisk; High-efficiency system disk: EfficiencySystemDisk.	No
CloneEnable	int	Does it support cloning, 1 for support, 0 for no support	No
SnapEnable	int	Does it support snapshot, 1 for support, 0 for not supported	No
ArkSwitchEnable	int	Does it support enabling Ark, 1 for support, 0 for no support	No
UKmsMode	string	Is it an encrypted disk, Yes: "Yes", No: "No".	No
CmkId	string	The cmk id of this disk	No
DataKey	string	The encrypted key of this disk	No
CmkIdStatus	string	The status of this disk's cmk, Enabled (Normal), Disabled (Invalid), Deleted (Deleted), NoCmkId (Unencrypted disk)	No
CmkIdAlias	string	cmk id alias	No
IsBoot	string	Is it a system disk, Yes: "True", No: "False".	No
BackupMode	string	The backup method of this disk. Snapshot service: "SnapshotService"; Data Ark: "UDataArk"; No backup method: "".	No
RdmaClusterId	string	RDMA cluster id, only RSSD returns this value; other types of cloud disks return "". When the value of this cloud disk is the same as the RdmaClusterId of the UHost, RSSD can be mounted to this UHost.	No

Example

Request Example

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

Response Example

{
  "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