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

获取可绑定云主机的亲和组

获取可绑定云主机的亲和组

GET/zstack/v1/affinityGroup/attachingVm

操作 ID

GetCandidateAffinityGroupForAttachingVm

起始版本

4.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • vmUuid
    String必填

    云主机UUID

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

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

  • success
    boolean必填

    操作是否成功。

  • error
    ErrorCode必填

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

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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

  • inventories
    List必填

    详情参考inventories

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • policy
      String必填

      策略信息。

    • version
      String必填

      版本号。

    • type
      String必填

      类型。

    • appliance
      String必填

      设备。

    • state
      String必填

      当前状态。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • usages
      List必填

      详情参考usages

      • uuid
        String必填

        资源的UUID，唯一标示该资源

      • affinityGroupUuid
        String必填

        affinity组UUID。

      • resourceUuid
        String必填

        资源UUID。

      • resourceType
        String必填

        资源类型。

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

变更历史

查看全部变更历史

  • 变更时间

    新增响应字段 affinityGroupUuid, appliance, createDate...
    查看 API