Docs
api
Cloud Disk(UDisk)
DetachDeleteUDisk

Uninstall and Delete Cloud Disk - DetachDeleteUDisk

Overview

Uninstall and delete a UDisk that has already been mounted on a specified UHost instance.

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DetachDeleteUDisk.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListNo
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
UDiskIdstringUDisk Instance ID to be UninstalledYes
UHostIdstringUHost Instance ID. [You must fill in either UHostId or HostId, this field is about to be deprecated, it is recommended to use HostId]No
HostIdstringHost Instance IDNo
DeleteSnapshotServicestringDo you want to delete the snapshot service? Yes: Delete, No: Do not delete, Default value: Yes.No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
UHostIdstringUninstall the UHost instance ID. [Soon to be deprecated, it is recommended to use HostId]No
HostIdstringUninstalled Host Instance IDNo
UDiskIdstringUninstall and delete UDisk instance IDNo

Example

Request Example

https://api.ucloud-global.com/?Action=DetachDeleteUDisk
&Region=jUjENnRU
&Zone=jyQMsime
&ProjectId=ysaijOEv
&UHostId=GEtUmxtW
&HostId=WcdKcRsT
&UDiskId=LaaTtNLf
&HostProduct=PlcPMTyc
&CloseSnapshotService=EhlaHTFE

Response Example

{
  "Action": "DetachDeleteUDiskResponse",
  "HostId": "zBFpZJeX",
  "RetCode": 0,
  "UDiskId": "ZEUGkdOT",
  "UHostId": "pbVjIMWx"
}