跳转到主要内容
ZStack
资源中心/云资源池/云主机相关接口

批量获取云主机能力

批量获取云主机能力

POST/zstack/v1/vm-instances/capabilities

操作 ID

GetVmsCapabilities

起始版本

4.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • vmUuids
      String必填

      待查询的云主机uuid集合

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • vmsCaps
    Map必填

    详情参考vmsCaps

    • supportLiveMigration
      boolean必填

      实时migration受支持。

    • supportVolumeMigration
      boolean必填

      量migration受支持。

    • supportReimage
      boolean必填

      reimage受支持。

    • supportMemorySnapshot
      boolean必填

      内存快照受支持。