Skip to main content
API Explorer|API Explorer
Platform O&M/Backup Management/Backup Service (Plus)/Backup Service Operations
GETBackup Service OperationsSince 2.6.0SynchronousAuth Required

QueryVolumeBackup

QueryVolumeBackup

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoriesListRequired

    See inventories

    • uuidStringRequired

      The UUID of the volume backup.

    • volumeUuidStringRequired

      The UUID of the volume.

    • nameStringRequired

      The name of the backup.

    • descriptionStringRequired

      The detailed description of the backup.

    • typeStringRequired

      The type of the volume.

    • stateStringRequired

      The status of the backup.

    • statusStringRequired

      The availability status of the backup.

    • sizeLongRequired

      The size of the backup.

    • metadataStringRequired

      The metadata of the backup.

    • createDateTimestampRequired

      The time when the backup was created.

    • lastOpDateTimestampRequired

      The time when the backup was last modified.

    • backupStorageRefsListRequired

      See backupStorageRefs

      • volumeBackupUuidStringRequired

        The UUID of the volume backup.

      • backupStorageUuidStringRequired

        The UUID of the backup storage.

      • installPathStringRequired

        The storage path of the backup.

      • statusStringRequired

        The status of the backup in the backup storage.

      • createDateTimestampRequired

        The time when the backup was created.

      • lastOpDateTimestampRequired

        The time when the backup was last modified.

Endpoint

GET/zstack/v1/volume-backups

/zstack/v1/volume-backups

Operation ID

QueryVolumeBackup

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/volume-backups' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ { "uuid": "aaf2564bbbed3eab97b7ecff370d8ff1", "volumeUuid": "92dcb8125f7b3187887e2abc8532b749", "name": "backup-2", "description": "my backup", "size": 1310720.0 } ] }

Change History

This API has no change history records yet.

View all change history