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

AttachDataVolumeToVm

AttachDataVolumeToVm

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • vmInstanceUuidStringRequired

    The VM instance UUID.

  • volumeUuidStringRequired

    The volume UUID.

Body Fields

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • 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.

  • inventoryVolumeInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • primaryStorageUuidStringRequired

      The primary storage UUID.

    • vmInstanceUuidStringRequired

      The VM instance UUID.

    • diskOfferingUuidStringRequired

      The disk offering UUID.

    • rootImageUuidStringRequired

      根镜像UUID。

    • installPathStringRequired

      安装路径。

    • typeStringRequired

      类型。

    • formatStringRequired

      数据格式或导出格式。

    • sizeLongRequired

      返回记录数。

    • actualSizeLongRequired

      实际大小。

    • deviceIdIntegerRequired

      设备ID。

    • stateStringRequired

      当前状态。

    • statusStringRequired

      状态信息。

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • isShareableBooleanRequired

      是否可分享。

    • volumeQosStringRequired

      No description provided.

    • lastDetachDateTimestampRequired

      最近一次detach时间。

    • lastVmInstanceUuidStringRequired

      最近一次云主机实例UUID。

Endpoint

POST/zstack/v1/volumes/{volumeUuid}/vm-instances/{vmInstanceUuid}

/zstack/v1/volumes/{volumeUuid}/vm-instances/{vmInstanceUuid}

Operation ID

AttachDataVolumeToVm

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/volumes/{volumeUuid}/vm-instances/{vmInstanceUuid}' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "4c118c4e51e54f839e6e0af9e17527f2", "name": "test-volume", "primaryStorageUuid": "9cd9e87803864fa1ae6cf4001fb5d4c8", "vmInstanceUuid": "8a6f516d0da04addb062c903dd000830", "diskOfferingUuid": "bdb5f71d810c49a08ff0e91f81936009", "rootImageUuid": "a12e3048aab340c1b2c6bad2e4187a3a", "installPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-4c118c4e51e54f839e6e0af9e17527f2/4c118c4e51e54f839e6e0af9e17527f2.qcow2", "type": "Root", "format": "qcow2", "size": 107374182400, "actualSize": 21474836480, "deviceId": 0, "state": "Enabled", "status": "Ready", "createDate": "Jun 7, 2017 9:20:35 PM", "lastOpDate": "Jun 7, 2017 9:20:35 PM" } }

Change History

This API has no change history records yet.

View all change history