Get Block Device

Get Block Device

Get a single BlockDevice

Request
URI
GET
https://{api_host}/iaas/api/block-devices/{id}
COPY
Path Parameters
string
id
Required

The ID of the block device.

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about


Responses
200

successful operation

Returns BlockDevice of type(s) application/json
{
    "owner": "[email protected]",
    "externalZoneId": "us-east-1a",
    "externalRegionId": "us-east-1",
    "description": "my-description",
    "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
    "orgId": "9e49",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "organizationId": "deprecated",
    "capacityInGB": 10,
    "createdAt": "2012-09-27",
    "cloudAccountIds": [
        "string"
    ],
    "name": "my-name",
    "id": "9e49",
    "projectId": "9e49",
    "updatedAt": "2012-09-27",
    "status": "ATTACHED"
}
string
owner
Optional

Email of the user that owns the entity.

object
_links
Required

HATEOAS of the entity

string
externalZoneId
Required

The external zoneId of the resource.

string
externalRegionId
Required

The external regionId of the resource

string
description
Optional

A human-friendly description.

string
externalId
Optional

External entity Id on the provider side.

string
orgId
Optional

The id of the organization this entity belongs to.

array of Tag
tags
Optional

A set of tag keys and optional values that were set on this resource instance.

string
organizationId
Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

integer As int32 As int32
capacityInGB
Required

Capacity of the block device in GB.

string
createdAt
Optional

Date when the entity was created. The date is in ISO 6801 and UTC.

array of string
cloudAccountIds
Optional

Set of ids of the cloud accounts this entity belongs to.

object
customProperties
Optional

Additional properties that may be used to extend the base type.

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
id
Required

The id of this resource instance

string
projectId
Optional

The id of the project this entity belongs to.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
status
Required

Status of the block device

Possible values are : DETACHED, ATTACHED, AVAILABLE,

403

Forbidden

Operation doesn't return any data structure