List Snapshot

GET 
/projects/:projectId/providers/Aruba.Storage/snapshots

List Snapshot

Request

Path Parameters

projectId stringrequired

Query Parameters

filter string
sort string
projection string
offset int32
limit int32
api-version string
The requested API version
Default value: 1.0

Responses

200

Success

text/plain

Schema

Schema

totalint64
selfstringnullable
prevstringnullable
nextstringnullable
firststringnullable
laststringnullable

values

object[]

nullable

Array [

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]nullable

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

sizeGbint32nullable

The blockStoages's size in gigabyte

billingPeriodstringnullable

The billing period for blockStorage. Only Hour is a valid value

volume

object

uristringnullable

Uri of the volume

namestringnullable

Current name of the volume

compoundResource

object

uristringnullable

Uri of the resource

dataCenterstringnullable

The datacenter where blockstorage will be created

For more information, check the documentation.

typestringnullable

The type of the original volume from which the snapshot was created

bootableboolean

True if the original volume of the snapshot was a bootable disk

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "metadata": {
        "id": "string",
        "uri": "string",
        "name": "string",
        "location": {
          "code": "string",
          "country": "string",
          "city": "string",
          "name": "string",
          "value": "string"
        },
        "project": {
          "id": "string"
        },
        "tags": [
          "string"
        ],
        "category": {
          "name": "string",
          "provider": "string",
          "typology": {
            "id": "string",
            "name": "string"
          }
        },
        "creationDate": "2024-07-29T15:51:28.071Z",
        "createdBy": "string",
        "updateDate": "2024-07-29T15:51:28.071Z",
        "updatedBy": "string",
        "version": "string",
        "createdUser": "string",
        "updatedUser": "string"
      },
      "status": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z",
        "disableStatusInfo": {
          "isDisabled": true,
          "reasons": [
            "string"
          ],
          "previousStatus": {
            "state": "string",
            "creationDate": "2024-07-29T15:51:28.071Z"
          }
        },
        "failureReason": "string"
      },
      "properties": {
        "sizeGb": 0,
        "billingPeriod": "string",
        "volume": {
          "uri": "string",
          "name": "string",
          "compoundResource": {
            "uri": "string"
          }
        },
        "dataCenter": "string",
        "type": "string",
        "bootable": true
      }
    }
  ]
}

application/json

Schema

Schema

totalint64
selfstringnullable
prevstringnullable
nextstringnullable
firststringnullable
laststringnullable

values

object[]

nullable

Array [

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]nullable

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

sizeGbint32nullable

The blockStoages's size in gigabyte

billingPeriodstringnullable

The billing period for blockStorage. Only Hour is a valid value

volume

object

uristringnullable

Uri of the volume

namestringnullable

Current name of the volume

compoundResource

object

uristringnullable

Uri of the resource

dataCenterstringnullable

The datacenter where blockstorage will be created

For more information, check the documentation.

typestringnullable

The type of the original volume from which the snapshot was created

bootableboolean

True if the original volume of the snapshot was a bootable disk

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "metadata": {
        "id": "string",
        "uri": "string",
        "name": "string",
        "location": {
          "code": "string",
          "country": "string",
          "city": "string",
          "name": "string",
          "value": "string"
        },
        "project": {
          "id": "string"
        },
        "tags": [
          "string"
        ],
        "category": {
          "name": "string",
          "provider": "string",
          "typology": {
            "id": "string",
            "name": "string"
          }
        },
        "creationDate": "2024-07-29T15:51:28.071Z",
        "createdBy": "string",
        "updateDate": "2024-07-29T15:51:28.071Z",
        "updatedBy": "string",
        "version": "string",
        "createdUser": "string",
        "updatedUser": "string"
      },
      "status": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z",
        "disableStatusInfo": {
          "isDisabled": true,
          "reasons": [
            "string"
          ],
          "previousStatus": {
            "state": "string",
            "creationDate": "2024-07-29T15:51:28.071Z"
          }
        },
        "failureReason": "string"
      },
      "properties": {
        "sizeGb": 0,
        "billingPeriod": "string",
        "volume": {
          "uri": "string",
          "name": "string",
          "compoundResource": {
            "uri": "string"
          }
        },
        "dataCenter": "string",
        "type": "string",
        "bootable": true
      }
    }
  ]
}

text/json

Schema

Schema

totalint64
selfstringnullable
prevstringnullable
nextstringnullable
firststringnullable
laststringnullable

values

object[]

nullable

Array [

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]nullable

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

sizeGbint32nullable

The blockStoages's size in gigabyte

billingPeriodstringnullable

The billing period for blockStorage. Only Hour is a valid value

volume

object

uristringnullable

Uri of the volume

namestringnullable

Current name of the volume

compoundResource

object

uristringnullable

Uri of the resource

dataCenterstringnullable

The datacenter where blockstorage will be created

For more information, check the documentation.

typestringnullable

The type of the original volume from which the snapshot was created

bootableboolean

True if the original volume of the snapshot was a bootable disk

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "metadata": {
        "id": "string",
        "uri": "string",
        "name": "string",
        "location": {
          "code": "string",
          "country": "string",
          "city": "string",
          "name": "string",
          "value": "string"
        },
        "project": {
          "id": "string"
        },
        "tags": [
          "string"
        ],
        "category": {
          "name": "string",
          "provider": "string",
          "typology": {
            "id": "string",
            "name": "string"
          }
        },
        "creationDate": "2024-07-29T15:51:28.071Z",
        "createdBy": "string",
        "updateDate": "2024-07-29T15:51:28.071Z",
        "updatedBy": "string",
        "version": "string",
        "createdUser": "string",
        "updatedUser": "string"
      },
      "status": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z",
        "disableStatusInfo": {
          "isDisabled": true,
          "reasons": [
            "string"
          ],
          "previousStatus": {
            "state": "string",
            "creationDate": "2024-07-29T15:51:28.071Z"
          }
        },
        "failureReason": "string"
      },
      "properties": {
        "sizeGb": 0,
        "billingPeriod": "string",
        "volume": {
          "uri": "string",
          "name": "string",
          "compoundResource": {
            "uri": "string"
          }
        },
        "dataCenter": "string",
        "type": "string",
        "bootable": true
      }
    }
  ]
}

400

Bad Request

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Not Found

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Server Error