InvokeCommand

1. 接口描述

本接口(InvokeCommand)用于执行一个已经创建并保存的命令。

注意事项

• 只支持在ZEC的实例上执行云命令。

• 实例必须处于运行状态。否则执行会失败。

• 实例必须安装QGA Agent。

• 执行命令调用成功后，会返回执行记录ID。可以通过该ID查询执行记录获取实例执行的详细信息。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
commandId	是	String	需要执行的命令ID。
timeout	否	Integer	每台实例执行命令的超时时间。 单位秒。 可选值范围：[1, 60]。 默认值：30。
instanceIds	是	Array of String	执行的实例ID列表。 目前只支持ZEC实例。 最多不得超过200个实例。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
invocationId	String	命令执行记录编号。

4. 代码示例

示例

1. 执行命令。

POST /api/v2/zap HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: InvokeCommand
<Common Request Params>

Request：
{
  "commandId": "<commandId>",
  "timeout": 30,
  "instanceIds": [
    "<instanceId>",
    "<instanceId>"
  ]
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "invocationId": "<invocationId>",
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明
404	INVALID_COMMAND_INVOCATION_NOT_FOUND	执行记录未找到。
404	INVALID_COMMAND_NOT_FOUND	指令未找到。
400	INVALID_COMMAND_NOT_SUPPORT_OS	根据命令类型，无法再实例的操作系统上运行该指令。
404	INVALID_INSTANCE_NOT_FOUND	实例不存在。
400	INVALID_INSTANCE_NOT_RUNNING	实例未运行。