Help Center> Bare Metal Server> API Reference> Native OpenStack Nova V2.1 APIs> BMS Disk Management> Querying Information About a Disk Attached to a BMS (Native OpenStack API)
Updated on 2024-01-31 GMT+08:00

Querying Information About a Disk Attached to a BMS (Native OpenStack API)

Function

This API is used to query information about a single disk attached to a BMS based on the disk ID.

URI

GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id}

Table 1 lists the parameters.

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

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

server_id

Yes

Specifies the BMS ID.

You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).

volume_id

Yes

Specifies the EVS disk ID.

You can query attached EVS disks attached to a BMS using the Querying Information About the Disks Attached to a BMS (Native OpenStack API) API.

Request Parameters

None

Example Request

Querying information about an EVS disk (ID: b53f23bd-ee8f-49ec-9420-d1acfeaf91d6) attached to a BMS (ID: 95bf2490-5428-432c-ad9b-5e3406f869dd)
1
GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-volume_attachments/b53f23bd-ee8f-49ec-9420-d1acfeaf91d6

Response Parameters

Parameter

Type

Description

volumeAttachment

Object

Specifies information about the disk attached to the BMS. For details, see Table 2.

Table 2 volumeAttachment field data structure description

Parameter

Type

Description

device

String

Specifies the mount directory, for example, /dev/vdb.

id

String

Specifies the ID of the attached resource.

serverId

String

Specifies the ID of the BMS to which the disks are attached.

volumeId

String

Specifies the ID of the disk attached to the BMS.

Example Response

1
2
3
4
5
6
7
8
{
    "volumeAttachment": {
        "device": "/dev/vdb",
        "serverId": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa",
        "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6",
        "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6"
    }
                }

Returned Values

Normal values

Returned Values

Description

200

The request has been successfully processed.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.