Updated on 2024-07-16 GMT+08:00

Querying Disk Attachments of an ECS

Function

This API is used to query disk attachments of an ECS.

URI

GET /v1/{project_id}/cloudservers/{server_id}/os-volume_attachments

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

For details about how to obtain the ID, see Obtaining a Project ID.

server_id

Yes

Specifies the ECS ID in UUID format.

Request

None

Response

Table 2 describes the response parameters.
Table 2 Response parameters

Parameter

Type

Description

volumeAttachments

Array of objects

Specifies disks attached to an ECS. For details, see Table 3.

Table 3 volumeAttachments field description

Parameter

Type

Description

device

String

Specifies the drive letter of the EVS disk, displayed as the device name on the console.

For details, see How Do I Obtain My Disk Device Name in the ECS OS Using the Device Identifier Provided on the Console?

id

String

Specifies the mount ID, which is the same as the EVS disk ID.

The value is in UUID format.

serverId

String

Specifies the ECS ID in UUID format.

volumeId

String

Specifies the EVS disk ID in UUID format.

Example Request

Query the list of disks attached to an ECS.

GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/os-volume_attachments

Example Response

{
    "volumeAttachments": [
        {
            "device": "/dev/sdd",
            "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803",
            "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0",
            "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803"
        },
        {
            "device": "/dev/sdc",
            "id": "a26887c6-c47b-4654-abb5-dfadf7d3f804",
            "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0",
            "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f804"
        }
    ]
}

Error Codes

See Error Codes.