Get Storage Class

Get Storage Class

Retrieves a specific storage class via URN.

Request
URI
GET
https://{api_host}/cloudapi/vcf/storageClasses/{storageClassUrn}
COPY
Path Parameters
string
storageClassUrn
Required

storageClassUrn

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns StorageClass of type(s) application/json;version=40.0 
{
    "id": "string",
    "name": "string",
    "region": {
        "name": "string",
        "id": "string"
    },
    "storageConsumedMiB": 0,
    "storageCapacityMiB": 0,
    "zones": [
        {
            "name": "string",
            "id": "string"
        }
    ]
}
string
id
Optional

Unique URN Id for the storage class.

string
name
Optional
Constraints: minLength: 1 maxLength: 63

Name for the storage class.

object
region
Optional

Entity reference used to describe VCD entities

integer As int64 As int64
storageConsumedMiB
Optional

For tenants, this represents the total storage given to all namespaces consuming from this storage class in mebibytes. For providers, this represents the total storage given to tenants from this storage class in mebibytes.

integer As int64 As int64
storageCapacityMiB
Optional

The total storage capacity of the storage class in mebibytes.

array of object
zones
Optional

The zones available to the storage class.


Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    [object Object]
Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/vcf/storageClasses/{storageClassUrn}
Availability
Added in 40.0
On This Page
Storage Classes Operations
GET
Query Storage Classes
GET
Get Storage Class