Skip to main content
ZStack
Resource Center/Resource Pool/VM Instance Operations

GetVmsCapabilities

GetVmsCapabilities

POST/zstack/v1/vm-instances/capabilities

Operation ID

GetVmsCapabilities

Since

4.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • vmUuids
      StringRequired

      The UUID of the VM instance to be queried.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

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

    • code
      StringRequired

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

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

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

  • vmsCaps
    MapRequired

    For more information, see vmsCaps.

    • supportLiveMigration
      booleanRequired

      Whether live migration is supported.

    • supportVolumeMigration
      booleanRequired

      Whether volume migration is supported.

    • supportReimage
      booleanRequired

      Whether reimage is supported.

    • supportMemorySnapshot
      booleanRequired

      Whether memory snapshot is supported.