Skip to main content
API Explorer|API Explorer
Compute Management/Image Storage Related Interfaces/Image Storage Related Interfaces
PUTImage Storage Related InterfacesSince 0.6SynchronousAuth Required

Change Backup Storage State

Change Backup Storage State

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    Resource UUID, uniquely identifies the resource

Body Fields

  • changebackupstoragestateObjectRequired

    changebackupstoragestate request body object.

    • stateEventStringRequired

      Target state of the backup storage

  • systemTagsList

    System tags

  • userTagsList

    User tags

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    Error code. If not null, the operation failed. This field is null when the operation succeeds. See error

    • codeStringRequired

      Error code number, globally unique identifier, for example SYS.1000, HOST.1001

    • descriptionStringRequired

      Brief description of the error

    • detailsStringRequired

      Detailed error information

    • elaborationStringRequired

      Reserved field, defaults to null

    • opaqueLinkedHashMapRequired

      Reserved field, defaults to null

    • causeErrorCodeRequired

      Root cause. The source error that triggered the current error. This field is null if there is no original error

  • inventoryBackupStorageInventoryRequired

    See inventory

    • uuidStringRequired

      Resource UUID, uniquely identifies the resource

    • nameStringRequired

      Resource name

    • urlStringRequired

      地址。

    • descriptionStringRequired

      Detailed description of the resource

    • totalCapacityLongRequired

      总容量。

    • availableCapacityLongRequired

      可用容量。

    • typeStringRequired

      类型。

    • stateStringRequired

      当前状态。

    • statusStringRequired

      状态信息。

    • createDateTimestampRequired

      Creation time

    • lastOpDateTimestampRequired

      Last modification time

    • attachedZoneUuidsListRequired

      附加区域UUID。

Endpoint

PUT/zstack/v1/backup-storage/{uuid}/actions

/zstack/v1/backup-storage/{uuid}/actions

Operation ID

ChangeBackupStorageState

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/backup-storage/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"changebackupstoragestate":{"stateEvent":"<stateEvent>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "name": "My Backup Storage", "description": "Public Backup Storage", "totalCapacity": 1.073741824E9, "availableCapacity": 9.68884224E8, "type": "Ceph", "state": "Disabled", "status": "Connected", "createDate": "Jun 7, 2017 9:20:45 PM", "lastOpDate": "Jun 7, 2017 9:20:45 PM", "attachedZoneUuids": [ "c1b882e3dfc944348ab63b478a64f257" ] } }

Change History

This API has no change history records yet.

View all change history