Help Center/ Elastic Volume Service/ API Reference/ API/ Disk Management/ Querying Details About an EVS Disk (Deprecated)
Updated on 2024-02-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Details About an EVS Disk (Deprecated)

Function

This API is used to query details about a single EVS disk. This API has been deprecated. Use another API.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/os-vendor-volumes/{volume_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

volume_id

Yes

String

The disk ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

A token obtained from IAM is valid for 24 hours. When using a token for authentication, cache it to avoid frequently calling the API.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

volume

DiskDetail object

The disk details.
Table 4 DiskDetail

Parameter

Type

Description

attachments

Array of DiskAttachment objects

The disk attachment information.

availability_zone

String

The AZ to which the disk belongs.

bootable

String

Whether the disk is bootable.

consistencygroup_id

String

The ID of the consistency group where the disk belongs.

count

String

The number of disks queried.

created_at

String

The time when the disk was created.

Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

dedicated_storage_id

String

The ID of the dedicated storage pool housing the disk.

dedicated_storage_name

String

The name of the dedicated storage pool housing the disk.

description

String

The disk description.

encrypted

Boolean

Whether the disk is encrypted.

enterprise_project_id

String

The ID of the enterprise project that the disk has been added to. This field is currently not supported.

id

String

The disk ID.

links

Array of Link objects

The disk URI.

metadata

DiskMetadata object

The metadata.

multiattach

Boolean

Whether the disk is shareable.

name

String

The disk name.

os-vendor-extended:lock_check_endpoint

String

The callback URL used to check the lock validity.

os-vendor-extended:lock_scene

String

The operation or service that locks the disk.

os-vendor-extended:lock_source_id

String

The ID of resource to which the lock belongs.

os-vendor-extended:lock_source_service

String

The type of resource to which the lock belongs.

os-vol-host-attr:host

String

The host to which the disk belongs.

os-vol-mig-status-attr:migstat

String

The reserved field.

os-vol-mig-status-attr:name_id

String

The reserved field.

os-vol-tenant-attr:tenant_id

String

The ID of the tenant to which the disk belongs.

os-volume-replication:driver_data

String

The reserved field.

os-volume-replication:extended_status

String

The reserved field.

replication_status

String

The reserved field.

service_type

String

The service type. Supported services are EVS, DSS, and DESS.

shareable

String

Whether the disk is shareable.

size

Integer

The disk size.

snapshot_id

String

The snapshot ID.

source_volid

String

The source disk ID.

status

String

The disk status. For details, see EVS Disk Status.

tags

Object

The disk tags.

This field has values if the disk has tags. Or, it is left empty.

updated_at

String

The time when the disk was updated.

user_id

String

The reserved field.

volume_image_metadata

Object

The image metadata. This field has a value if the disk is created from an image. Or, null is returned.

NOTE:

For details about the volume_image_metadata field, see Querying Image Details (Native OpenStack API).

volume_type

String

The disk type.

The value can be SATA, SAS, GPSSD, or SSD.

  • SATA: the common I/O type

  • SAS: the high I/O type

  • GPSSD: the general purpose SSD type

  • SSD: the ultra-high I/O type

wwn

String

The unique identifier used when attaching the disk.

root_resource_type

String

The root resource type.

root_resource_id

String

The root resource ID.

parent_resource_type

String

The parent resource type.

parent_resource_id

String

The parent resource ID.
Table 5 DiskAttachment

Parameter

Type

Description

attached_at

String

The time when the disk was attached.

Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

attachment_id

String

The attachment ID.

device

String

The device name.

host_name

String

The name of the physical host housing the cloud server to which the disk is attached.

id

String

The ID of the attached disk.

server_id

String

The ID of the server to which the disk is attached.

volume_id

String

The disk ID.
Table 6 Link

Parameter

Type

Description

href

String

The corresponding shortcut link.

rel

String

The shortcut link marker name.
Table 7 DiskMetadata

Parameter

Type

Description

__system__cmkid

String

The encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes.

__system__encrypted

String

The encryption field in metadata. The value can be 0 (no encryption) or 1 (encryption). If this parameter does not appear, the disk is not encrypted.

full_clone

String

The clone method. When the disk is created from a snapshot, value 0 indicates the linked cloning method.

hw:passthrough

String

The parameter that describes the disk device type in metadata.

  • If this parameter value is true, the disk device type is SCSI, which allows ECS OSs to directly access the underlying storage media. SCSI reservation commands are supported.

  • If this parameter value is false, the disk device type is VBD, which supports only simple SCSI read/write commands.

  • If this parameter does not appear, the disk device type is VBD.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs. For details, seeParameters in the error field.
Table 9 Error

Parameter

Type

Description

code

String

The error code returned if an error occurs. For the error codes and their meanings, see Error Codes.

message

String

The error message returned if an error occurs.

Example Requests

GET https://{endpoint}/v2/{project_id}/os-vendor-volumes/{volume_id}

https://{endpoint}/v2/{project_id}/os-vendor-volumes/{volume_id}

Example Responses

Status code: 200

OK

{
  "volume" : {
    "attachments" : [ ],
    "links" : [ {
      "href" : "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
      "rel" : "self"
    }, {
      "href" : "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
      "rel" : "bookmark"
    } ],
    "availability_zone" : "az-dc-1",
    "os-vol-host-attr:host" : "az-dc-1#SSD",
    "encrypted" : false,
    "multiattach" : true,
    "updated_at" : "2016-02-03T02:19:29.895237",
    "replication_status" : "disabled",
    "id" : "591ac654-26d8-41be-bb77-4f90699d2d41",
    "size" : 40,
    "user_id" : "fd03ee73295e45478d88e15263d2ee4e",
    "os-vol-tenant-attr:tenant_id" : "40acc331ac784f34842ba4f08ff2be48",
    "metadata" : { },
    "tags" : {
      "key1" : "value1",
      "key2" : "value2"
    },
    "status" : "available",
    "description" : "auto-created_from_restore_from_backup",
    "name" : "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9",
    "bootable" : "false",
    "created_at" : "2016-02-03T02:19:11.723797",
    "service_type" : "EVS",
    "wwn" : " 688860300000d136fa16f48f05992360"
  }
}

Status code: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.

Parent Topic: Disk Management