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

停止云主机

停止云主机

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

操作 ID

StopVmInstance

起始版本

0.6

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • uuid
    String必填

    云主机UUID

请求体字段

  • type
    String

    停止云主机的方式。 grace：优雅关机，需要云主机里安装了相关ACPI驱动； cold：冷关机，相当于直接断电

  • stopHA
    String

    彻底关闭HA云主机

  • 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

  • inventory
    VmInstanceInventory必填

    详情参考inventory

    • uuid
      String必填

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

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • zoneUuid
      String必填

      区域UUID

    • clusterUuid
      String必填

      集群UUID

    • imageUuid
      String必填

      镜像UUID

    • hostUuid
      String必填

      物理机UUID

    • lastHostUuid
      String必填

      最近一次主机UUID。

    • instanceOfferingUuid
      String必填

      计算规格UUID

    • rootVolumeUuid
      String必填

      根云盘UUID

    • platform
      String必填

      平台。

    • defaultL3NetworkUuid
      String必填

      默认三层3网络UUID。

    • type
      String必填

      类型。

    • hypervisorType
      String必填

      hypervisor类型。

    • memorySize
      Long必填

      内存大小。

    • cpuNum
      Integer必填

      暂无描述。

    • cpuSpeed
      Long必填

      暂无描述。

    • allocatorStrategy
      String必填

      allocator策略。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • state
      String必填

      当前状态。

    • vmNics
      List必填

      详情参考vmNics

      • uuid
        String必填

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

      • vmInstanceUuid
        String必填

        云主机UUID

      • l3NetworkUuid
        String必填

        三层网络UUID

      • ip
        String必填

        来源IP地址。

      • mac
        String必填

        MAC地址。

      • netmask
        String必填

        暂无描述。

      • gateway
        String必填

        网关IP地址。

      • metaData
        String必填

        元数据。

      • ipVersion
        Integer必填

        ip协议号

      • deviceId
        Integer必填

        设备ID。

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

      • usedIps
        List必填

        详情参考usedIps

        • uuid
          String必填

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

        • ipRangeUuid
          String必填

          IP段UUID

        • l3NetworkUuid
          String必填

          三层网络UUID

        • ipVersion
          Integer必填

          IP协议号

        • ip
          String必填

          IP地址

        • netmask
          String必填

          网络掩码

        • gateway
          String必填

          网关地址

        • usedFor
          String必填

          intended使用。

        • ipInLong
          long必填

          IP地址represented长integer。

        • vmNicUuid
          String必填

          云主机网卡UUID

        • createDate
          Timestamp必填

          创建时间

        • lastOpDate
          Timestamp必填

          最后一次修改时间

    • allVolumes
      List必填

      详情参考allVolumes

      • uuid
        String必填

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

      • name
        String必填

        资源名称

      • description
        String必填

        资源的详细描述

      • primaryStorageUuid
        String必填

        主存储UUID

      • vmInstanceUuid
        String必填

        云主机UUID

      • diskOfferingUuid
        String必填

        云盘规格UUID

      • rootImageUuid
        String必填

        根镜像UUID。

      • installPath
        String必填

        安装路径。

      • type
        String必填

        类型。

      • format
        String必填

        数据格式或导出格式。

      • size
        Long必填

        返回记录数。

      • actualSize
        Long必填

        实际大小。

      • deviceId
        Integer必填

        设备ID。

      • state
        String必填

        当前状态。

      • status
        String必填

        状态信息。

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

      • isShareable
        Boolean必填

        是否资源可分享。