Skip to main content
API Explorer|API Explorer
Resource Center/Resource Pool/Volume Operations
PUTVolume OperationsSince 0.6SynchronousAuth Required

UpdateVolumeSnapshot

UpdateVolumeSnapshot

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

    The snapshot UUID.

Body Fields

  • updatevolumesnapshotObjectRequired

    updatevolumesnapshot request body object.

    • nameString

      Optional. The new name of the snapshot.

    • descriptionString

      Optional. The detailed description of the snapshot.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

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.

  • inventoryVolumeSnapshotInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • typeStringRequired

      类型。

    • volumeUuidStringRequired

      The volume UUID.

    • treeUuidStringRequired

      树UUID。

    • parentUuidStringRequired

      父级资源UUID。

    • primaryStorageUuidStringRequired

      The primary storage UUID.

    • primaryStorageInstallPathStringRequired

      主存储安装路径。

    • volumeTypeStringRequired

      量类型。

    • formatStringRequired

      数据格式或导出格式。

    • latestBooleanRequired

      最新。

    • sizeLongRequired

      返回记录数。

    • stateStringRequired

      当前状态。

    • statusStringRequired

      状态信息。

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • backupStorageRefsListRequired

      See backupStorageRefs.

      • volumeSnapshotUuidStringRequired

        The volume snapshot UUID.

      • backupStorageUuidStringRequired

        The backup storage UUID.

      • installPathStringRequired

        安装路径。

Endpoint

PUT/zstack/v1/volume-snapshots/{uuid}/actions

/zstack/v1/volume-snapshots/{uuid}/actions

Operation ID

UpdateVolumeSnapshot

Permalink

Request Example

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

Response Example

200
{ "inventory": { "uuid": "a50e9be4b0eb492aa1cbb767e38ee45e", "name": "My Snapshot 2", "primaryStorageUuid": "/Cloud_ps/rootVolumes/acct-e77f16d460ea46e18262547b56972273/vol-13c66bb52d0949398e520183b917f813/snapshots/2fa6979af5c6479fa98f37d316f44b5f.qcow2", "volumeType": "Root", "format": "qcow2", "latest": false, "size": 1310720.0, "state": "Enabled", "status": "Ready" } }

Change History

This API has no change history records yet.

View all change history