Aller au contenu principal

Find volumes by searching criteria

GET 
/projects/:projectId/zones/:zoneName/volumes

Return volumes that match all searching criteria. Criteria are project identifier and volume name.

Request​

Path Parameters

    projectId stringrequired

    Project Identifier

    zoneName stringrequired

    Zone name

Query Parameters

    name string

    Name of the resource.

    provisioningState BasicStateEnum

    Possible values: [creating, updating, deleting, active, error]

    State of the searched volume.

    offset int32

    Default value: 0

    Requested pagination of response. The parameter offset is the index of the first element to retrieve. Zero is the first element of the collection.

    limit int32

    Possible values: >= 1

    Default value: 100

    Requested pagination of response. The parameter limit is the maximum number of elements to retrieve (it can be greater than the actual available number of items).

    sort string

    Possible values: <= 100 characters, Value must match regular expression -?[A-Za-z0-9]+(?:,[A-Za-z0-9]+)*

    The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.

Header Parameters

    X-API-Key string

    Your SIU token if you use this API through Orange Developer.

    Authorization string

    Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

    X-Requester-Id string

    Your SIU Id if you use this API through Orange Developer Inside.

Responses​

Ok

Response Headers

  • X-Total-Count

    integer

    Returns Pagination of response. The total number of items in the collection, after application of filters if any.

  • X-Result-Count

    integer

    The actual number of items contained in the response body. Note that it can be less than the requested "limit".

Schema

  • Array [

    • name stringrequired

    Possible values: <= 40 characters, Value must match regular expression [A-Za-z0-9-]

    Unique resource name. This attribute can not be updated.

    description string

    Resource description

    tags

    object

    Tags associated with the resource

    property name* string
    id uuidrequired

    Resource identifier.

    hRef urirequired

    Hypertext reference of the resource.

    createdDate date-timerequired

    Creation date of the resource.

    lastModifiedDate date-timerequired

    Date of the last modification of the resource.

    lastRequesterId stringrequired

    Identifier of the user of the last create/update/delete operation requested on the resource.

    provisioningState BasicStateEnum (string)required

    Possible values: [creating, updating, deleting, active, error]

    Provisioning state of the resource. Possible state:

    • 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
    size int32required

    Possible values: >= 1 and <= 5000

    Size of the volume in GB (max: 5000). NB: when updating a volume, the size can not be decreased.

    image string

    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.

  • ]

Loading...