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

更新云主机GuestTools状态

更新云主机GuestTools状态

PUT/zstack/v1/vm-instances/{vmInstanceUuid}/guesttools-state

操作 ID

UpdateGuestToolsState

起始版本

4.6.21

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • vmInstanceUuid
    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

  • inventory
    GuestToolsStateInventory必填

    详情参考inventory

    • vmInstanceUuid
      String必填

      云主机UUID

    • version
      String必填

      云主机GuestTools版本

    • platform
      String必填

      云主机OS平台类型

    • osType
      String必填

      云主机OS类型

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • qgaState
      GuestToolsQgaState必填

      详情参考qgaState

      • NotInstalled
        GuestToolsQgaState必填

        未安装

      • Running
        GuestToolsQgaState必填

        运行中

      • NotRunning
        GuestToolsQgaState必填

        停止

      • NotUpgraded
        GuestToolsQgaState必填

        待升级

    • zwatchState
      GuestToolsZWatchState必填

      详情参考zwatchState

      • NotInstalled
        GuestToolsZWatchState必填

        未安装

      • Running
        GuestToolsZWatchState必填

        运行中

      • NotRunning
        GuestToolsZWatchState必填

        未运行