跳转到主要内容
API Explorer|API Explorer
资源中心/云资源池/云主机相关接口
PUTVM Instance Operations起始版本 5.2.0同步需要认证

云主机执行命令

云主机执行命令

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • vmInstanceUuidString必填

      云主机UUID

    • platformString必填

      平台

    • commandString必填

      命令

    • commandTimeoutInteger

      超时时间

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • streamString必填

    流

  • vmInstanceVmInstanceInventory必填

    详情参考vmInstance

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

PUT/zstack/v1/vm-instances/commands/exec

/zstack/v1/vm-instances/commands/exec

操作 ID

ExecuteGuestVmCommand

永久链接

请求示例

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

响应示例

200
{ "stream": "standardStream: hello world, errorStream: 1/0 is not a goodScript", "vmInstance": { "uuid": "fc022ba201c135d8809c5e02bf6bf156", "name": "vm_1" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史