Create a new volume
POST/projects/:projectId/zones/:zoneName/volumes
Create a volume. In case of success, the response body contains the created volume with its identifier.
Request
Path Parameters
Project Identifier
Zone name
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.
- application/json
Body
required
Volume attributes in Create request.
Possible values: <= 40 characters
, Value must match regular expression [A-Za-z0-9-]
Unique resource name. This attribute can not be updated.
Resource description
tags
object
Tags associated with the resource
Possible values: >= 1
and <= 5000
Size of the volume in GB (max: 5000). NB: when updating a volume, the size can not be decreased. For a boot volume, the size can be increased only if it is not attached to a VM.
Name of the image to create the volume from. To be selected from the result of GET images.
Responses
- 201
- 400
- 401
- 403
- 404
- 405
- 500
- 503
Created
Response Headers
X-Job-Href
string
Href of the asynchronous job that will process the request, in order to track its status.
X-Retry-After
integer
The number of seconds to wait before checking the status of the job.
- application/json
- Schema
- Example (from schema)
- OK
Schema
Resource identifier.
Hypertext reference of the resource.
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"hRef": "string"
}
{ "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "hRef": "/projects/{projectId}/zones/{zoneName}/volumes/{volumeId}" }
Bad Request
Request is not valid
- application/json
- Schema
- Example (from schema)
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 (from schema)
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 (from schema)
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 (from schema)
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 (from schema)
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 (from schema)
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 (from schema)
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"
}