跳转到主要内容
API Explorer|API Explorer
计算管理/虚拟机相关接口
PUTVM Related Interfaces起始版本 4.6.21同步需要认证

更新虚拟机VMTools状态

更新虚拟机VMTools状态

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

请求参数

路径参数

  • vmInstanceUuidString必填

    虚拟机UUID

请求体字段

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryGuestToolsStateInventory必填

    详情参考inventory

    • vmInstanceUuidString必填

      虚拟机UUID

    • versionString必填

      虚拟机VMTools版本

    • platformString必填

      虚拟机OS平台类型

    • osTypeString必填

      虚拟机OS类型

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • qgaStateGuestToolsQgaState必填

      详情参考qgaState

      • NotInstalledGuestToolsQgaState必填

        未安装

      • RunningGuestToolsQgaState必填

        运行中

      • NotRunningGuestToolsQgaState必填

        停止

      • NotUpgradedGuestToolsQgaState必填

        待升级

    • zwatchStateGuestToolsZWatchState必填

      详情参考zwatchState

      • NotInstalledGuestToolsZWatchState必填

        未安装

      • RunningGuestToolsZWatchState必填

        运行中

      • NotRunningGuestToolsZWatchState必填

        未运行

请求地址

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

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

操作 ID

UpdateGuestToolsState

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/vm-instances/{vmInstanceUuid}/guesttools-state' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "vmInstanceUuid": "321e85ca08b335e09f172041f7e710b5", "qgaState": "Running", "zwatchState": "Running", "version": "4.6.11", "platform": "Kylin", "osType": "Kylin" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史