Huijuan, Wang 18d6c31e36 Modified the description about the parameter name and added the parameter description in Creating an ECS.

Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Huijuan, Wang <wanghuijuan738@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Huijuan, Wang <wanghuijuan738@noreply.gitea.eco.tsi-dev.otc-service.com>

2024-08-02 12:11:13 +00:00

12 KiB

Raw Blame History

Querying a Single Disk Attached to an ECS

Function

This API is used to query a disk attached to an ECS.

URI

GET /v2.1/servers/{server_id}/block_device/{volume_id}

Table 1 describes the parameters in the URI.

**Table 1** Parameter description
Parameter	Mandatory	Description
server_id	Yes	Specifies the ECS ID in UUID format.
volume_id	Yes	Specifies the EVS disk ID in UUID format.

Request

None

Response

Table 2 describes the response parameters.

**Table 2** Response parameters
Parameter	Type	Description
volumeAttachment	Object	Specifies the disk attached to an ECS. For details, see Table 3.

**Table 3** **volumeAttachment** parameters
Parameter	Type	Description
serverId	String	Specifies the ECS ID in UUID format.
volumeId	String	Specifies the EVS disk ID in UUID format.
id	String	Specifies the mount ID, which is the same as the EVS disk ID. The value is in UUID format.
size	Integer	Specifies the EVS disk size in GB.
device	String	Specifies the drive letter of the EVS disk, which is the device name of the EVS disk.
pciAddress	String	Specifies the PCI address.
bootIndex	Boolean	Specifies the EVS disk boot sequence. 0 indicates the system disk. A non-zero value indicates a data disk.
bus	String	Specifies the disk bus type. Options: virtio and scsi

Example Request

GET https://{endpoint}/v2.1/servers/{server_id}/block_device/{volume_id}

Example Response

{
    "volumeAttachment": {
        "pciAddress": "0000:02:01.0",
        "volumeId": "a26887c6-c47b-4654-abb5-asdf234r234r",
        "device": "/dev/vda",
        "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0",
        "id": "a26887c6-c47b-4654-abb5-asdf234r234r",
        "size": "40",
        "bootIndex": 0,
        "bus":"virtio"
    }
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: Disk Management

12 KiB Raw Blame History