InvokeCommand

1. API Description

This API is used to run an existing command.

Note

• You can only run commands on elastic compute instances.

• The instance must be in a stable running state.

• The instance must have QGA installed.

• After the command is successfully run, an execution ID is returned.\ You can use this ID to query the execution and view detailed results for each instance.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
commandId	Yes	String	Command ID to run.
instanceIds	Yes	Array of String	Instance ID to run command on. Only elastic compute instances are supported currently. You can run command on up to 200 instances.
timeout	No	Integer	The timeout for command execution on each instance. Unit: seconds. Valid range: [1, 60]. Default: 30.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
invocationId	String	Execution ID.

4. Code Example

Example

Run a command.

POST /api/v2/zos 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. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code	Error Code	Description
404	INVALID_COMMAND_NOT_FOUND	Command not found.
400	INVALID_COMMAND_NOT_SUPPORT_OS	The script language is incompatible with the instance’s operating system.
404	INVALID_INSTANCE_NOT_FOUND	Instance not found.
400	INVALID_INSTANCE_NOT_RUNNING	Instance is not in a stable running state.
400	INVALID_INSTANCE_QGA_REQUIRED	Instance have no QGA installed.