docs
api
Cloud Disk(UDisk)
AttachUDisk

Mount UDisk - AttachUDisk

Overview

Mount an available UDisk to a certain host. After the UDisk is successfully mounted, file system operations still need to be performed inside the host.

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is AttachUDisk.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
UDiskIdstringThe ID of the UDisk instance that needs to be mounted.Yes
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
MultiAttachstringAllow multiple mount points? (Yes: Allow multiple mount points, No: Do not allow multiple mount points, default is Yes if not filled in)No
HostIdstringHost Instance IDNo
EnableCrossPodAttachstringAllow cross-pod mounting (Yes: Allow cross-pod mounting, No: Do not allow cross-pod mounting, default is No if not filled)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
UHostIdstringThe mounted UHost instance ID. [Soon to be deprecated, it is recommended to use HostId]No
UDiskIdstringMounted UDisk Instance IDNo
DeviceNamestringMounted Device NameNo
HostIdstringMounted Host Instance IDNo

Example

Request Example

http://api.surfercloud.com/?Action=AttachUDisk
&Region=cn-bj2
&Zone=cn-bj2-04
&UHostId=uhost-xxx
&UDiskId=bs-xxx
&MultiAttach=Yes
&HostId=gsFtgfaB
&HostProduct=NvgPjjXU
&HostId=IgHkaFCi
&HostProduct=LBhvDhDs
&EnableCrossPodAttach=pIwxOOFZ

Response Example

{
  "Action": "AttachUDiskResponse",
  "DeviceName": "VidxyHWm",
  "HostId": "EvMeOnjG",
  "RetCode": 0,
  "UDiskId": "bs-xxx",
  "UHostId": "uhost-xxx"
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved