Skip to main content
API Explorer|API Explorer
Compute Management/VM Related Interfaces
PUTVM Related InterfacesSince 0.6SynchronousAuth Required

Pause Virtual Machine

Pause Virtual Machine

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

    Virtual Machine UUID

Body Fields

  • systemTagsList

    System Tags

  • userTagsList

    User Tags

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

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

    • codeStringRequired

      Error code number, a globally unique identifier for the error, 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. If there is no original error, this field is null

  • inventoryVmInstanceInventoryRequired

    See inventory

    • uuidStringRequired

      Resource UUID, uniquely identifies the resource

    • nameStringRequired

      Resource name

    • descriptionStringRequired

      Detailed description of the resource

    • zoneUuidStringRequired

      Data Center UUID

    • clusterUuidStringRequired

      Cluster UUID

    • imageUuidStringRequired

      Image UUID

    • hostUuidStringRequired

      Host UUID

    • lastHostUuidStringRequired

      最近一次主机UUID。

    • instanceOfferingUuidStringRequired

      Compute Offering UUID

    • rootVolumeUuidStringRequired

      Root Volume UUID

    • platformStringRequired

      平台。

    • architectureStringRequired

      No description provided.

    • defaultL3NetworkUuidStringRequired

      No description provided.

    • typeStringRequired

      类型。

    • hypervisorTypeStringRequired

      No description provided.

    • memorySizeLongRequired

      内存大小。

    • cpuNumIntegerRequired

      No description provided.

    • cpuSpeedLongRequired

      No description provided.

    • allocatorStrategyStringRequired

      No description provided.

    • createDateTimestampRequired

      Creation Time

    • lastOpDateTimestampRequired

      Last Operation Date

    • stateStringRequired

      当前状态。

    • guestOsTypeStringRequired

      No description provided.

    • vmNicsListRequired

      See vmNics

      • uuidStringRequired

        Resource UUID, uniquely identifies the resource

      • vmInstanceUuidStringRequired

        Virtual Machine UUID

      • l3NetworkUuidStringRequired

        L3 Network UUID

      • ipStringRequired

        来源IP地址。

      • macStringRequired

        No description provided.

      • hypervisorTypeStringRequired

        No description provided.

      • netmaskStringRequired

        No description provided.

      • gatewayStringRequired

        No description provided.

      • metaDataStringRequired

        元数据。

      • ipVersionIntegerRequired

        IP protocol version

      • driverTypeStringRequired

        No description provided.

      • internalNameStringRequired

        内部名称。

      • deviceIdIntegerRequired

        设备ID。

      • typeStringRequired

        类型。

      • stateStringRequired

        NIC status

      • createDateTimestampRequired

        Creation Time

      • lastOpDateTimestampRequired

        Last Operation Date

      • usedIpsListRequired

        See usedIps

        • uuidStringRequired

          Resource UUID, uniquely identifies the resource

        • ipRangeUuidStringRequired

          IP Range UUID

        • l3NetworkUuidStringRequired

          L3 Network UUID

        • ipVersionIntegerRequired

          IP Protocol Version

        • ipStringRequired

          IP Address

        • netmaskStringRequired

          Network Mask

        • gatewayStringRequired

          Gateway Address

        • usedForStringRequired

          已使用用于。

        • ipInLonglongRequired

          No description provided.

        • vmNicUuidStringRequired

          Virtual Machine NIC UUID

        • createDateTimestampRequired

          Creation Time

        • lastOpDateTimestampRequired

          Last Operation Date

    • allVolumesListRequired

      See allVolumes

      • uuidStringRequired

        Resource UUID, uniquely identifies the resource

      • nameStringRequired

        Resource name

      • descriptionStringRequired

        Detailed description of the resource

      • primaryStorageUuidStringRequired

        Primary Storage UUID

      • vmInstanceUuidStringRequired

        Virtual Machine UUID

      • diskOfferingUuidStringRequired

        Disk Offering UUID

      • rootImageUuidStringRequired

        Root Image UUID

      • installPathStringRequired

        Volume path on primary storage

      • typeStringRequired

        Volume type, data volume/root volume

      • formatStringRequired

        Volume format

      • sizeLongRequired

        Volume size

      • actualSizeLongRequired

        Actual volume size

      • deviceIdIntegerRequired

        设备ID。

      • stateStringRequired

        Whether the volume is enabled

      • statusStringRequired

        Volume status

      • createDateTimestampRequired

        Creation Time

      • lastOpDateTimestampRequired

        Last Operation Date

      • isShareableBooleanRequired

        Whether the volume is shareable

      • volumeQosStringRequired

        Volume QoS, format such as total=1048576

      • lastDetachDateTimestampRequired

        最近一次detach时间。

      • lastVmInstanceUuidStringRequired

        最近一次云主机实例UUID。

    • vmCdRomsListRequired

      See vmCdRoms

      • uuidStringRequired

        Resource UUID, uniquely identifies the resource

      • vmInstanceUuidStringRequired

        Virtual Machine UUID

      • deviceIdIntegerRequired

        设备ID。

      • isoUuidStringRequired

        No description provided.

      • isoInstallPathStringRequired

        iso安装路径。

      • nameStringRequired

        Resource name

      • descriptionStringRequired

        Detailed description of the resource

      • createDateTimestampRequired

        Creation Time

      • lastOpDateTimestampRequired

        Last Operation Date

Endpoint

PUT/zstack/v1/vm-instances/{uuid}/actions

/zstack/v1/vm-instances/{uuid}/actions

Operation ID

PauseVmInstance

Permalink

Request Example

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

Response Example

200
{ "inventory": { "uuid": "490ed95a1006364fb8ed3832d64ed119", "name": "Test-VM", "description": "web server VM", "zoneUuid": "1b6f8b5259a636cc9dc599fac936ca4a", "clusterUuid": "4ae4901e17f93e20b9a4c95a5546c90a", "imageUuid": "dd3deeda9faa38768d7bdd59fd10775b", "hostUuid": "3d8f04e1ea8a39cd96e0fd5a09ac8629", "lastHostUuid": "f57b7a0e6d5b3c53bb6048c47cb81fa0", "instanceOfferingUuid": "152010d532313e1d89bb91f50d1fd200", "rootVolumeUuid": "e18005eff51c353288cbf61d28261053", "platform": "Linux", "defaultL3NetworkUuid": "ba83a71ef20533309034e18c5b3b714c", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 8589934592, "cpuNum": 1, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "state": "Running", "vmNics": [ { "uuid": "8d33b79019d731fe901838aaf01e14f3", "vmInstanceUuid": "490ed95a1006364fb8ed3832d64ed119", "usedIpUuid": "ae18a8f6bd7e3d4d8cf2ecbbbc74edd7", "l3NetworkUuid": "ba83a71ef20533309034e18c5b3b714c", "ip": "192.168.1.10", "mac": "00:0c:29:bd:99:fc", "hypervisorType": "KVM", "netmask": "255.255.255.0", "gateway": "192.168.1.1", "deviceId": 0, "state": "enable", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ], "allVolumes": [ { "uuid": "e18005eff51c353288cbf61d28261053", "name": "Root-Volume-For-VM-490ed95a1006364fb8ed3832d64ed119", "primaryStorageUuid": "ca53fd5c27eb352b9fefbcd8740a1334", "vmInstanceUuid": "490ed95a1006364fb8ed3832d64ed119", "diskOfferingUuid": "53f444b07ac83298be45d2bf3338cf10", "rootImageUuid": "dd3deeda9faa38768d7bdd59fd10775b", "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-e18005eff51c353288cbf61d28261053/e18005eff51c353288cbf61d28261053.qcow2", "type": "Root", "format": "qcow2", "size": 107374182400, "actualSize": 21474836480, "deviceId": 0, "state": "Enabled", "status": "Ready", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ] } }

Change History

This API has no change history records yet.

View all change history