Skip to main content
GET
Get a volume

Authorizations

Authorization
string
header
required

API key authentication. API keys should be passed using the format Bearer API_KEY.

Path Parameters

projectId
string
required
id
string
required

Response

A successful response.

dataCenterId
string
required
id
string
required
projectId
string
required
sizeGib
integer<int32>
required
commitmentEndTime
string<date-time>
commitmentTerm
enum<string>
default:COMMITMENT_TERM_NONE
Available options:
COMMITMENT_TERM_NONE,
COMMITMENT_TERM_1_MONTH,
COMMITMENT_TERM_3_MONTHS,
COMMITMENT_TERM_6_MONTHS,
COMMITMENT_TERM_12_MONTHS,
COMMITMENT_TERM_24_MONTHS,
COMMITMENT_TERM_36_MONTHS,
COMMITMENT_TERM_60_MONTHS
gibPriceHr
object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

nfsPath
string
read-only
nfsServer
string
read-only
sizeGibUsed
integer<int32>
read-only
state
enum<string>
default:VOLUME_STATE_UNSPECIFIED
Available options:
VOLUME_STATE_UNSPECIFIED,
CREATING,
ACTIVE,
UPDATING,
DELETING,
FAILED
totalPriceHr
object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.