Get a volume by its identifier
GET/v1/projects/:projectId/zones/:zoneName/volumes/:volumeId
Return the volume with its identifier in the path.
Request
Path Parameters
Project Identifier
Zone name
Volume Identifier
Header Parameters
Your SIU token if you use this API through Orange Developer.
Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.
Your SIU Id if you use this API through Orange Developer Inside.
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 503
Ok
- application/json
- Schema
- Example (auto)
Schema
- creating: resource creation in progress
- updating: resource update in progress
- deleting: resource deletion in progress
- active: resource created/updated successfully
- error: resource in error because the last creation/update/deletion failed
Unique resource name. This attribute can not be updated.
Possible values: Value must match regular expression [A-Za-z0-9-]
Resource description
tags object
Resource identifier.
Hypertext reference of the resource.
Creation date of the resource.
Date of the last modification of the resource.
Identifier of the user of the last create/update/delete operation requested on the resource.
Provisioning state of the resource. Possible state:
Possible values: [creating, updating, deleting, active, error]
Size of the volume in GB (max: 5000). NB: when updating a volume, the size can not be decreased.
Possible values: >= 1 and <= 5000
Name of the image to create the volume from. To be selected from the result of GET images. For a boot volume, the size can be increased only if it is not attached to a VM.
{
"name": "string",
"description": "string",
"tags": {},
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"hRef": "string",
"createdDate": "2024-07-29T15:51:28.071Z",
"lastModifiedDate": "2024-07-29T15:51:28.071Z",
"lastRequesterId": "string",
"provisioningState": "creating",
"size": 0,
"image": "string"
}
Bad Request
Request is not valid
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Unauthorized
Credentials are missing
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Forbidden
Valid credentials but not enough privileges to perform the operation
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Not Found
Unknown resource or service
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Method Not Allowed
Operation is not valid according to the state of the resource
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Internal Server Error
Unexpected error, please contact support
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Service Unavailable
Service probably in maintenance. Please retry later.
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
- curl
- python
- go
- nodejs
- php
- java
- CURL
curl -L '/v1/projects/:projectId/zones/:zoneName/volumes/:volumeId' \
-H 'Accept: application/json'