ModifyCommand

1. API Description

This API is used to edit a command.

Note

If the command is running, you cannot edit it.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
commandId	Yes	String	Command ID to be edited.
name	No	String	Command name. The length should be no more than 64 characters.
content	No	String	Script content. The length should be no more than 4096 characters.
description	No	String	Command note. The length should be no more than 255 characters.

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.

4. Code Example

Example

Edit command name and script content.

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

Request：
{
  "commandId": "<commandId>",
  "name": "Test",
  "content": "echo 2"
}

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

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_INVOCATION_RUNNING_EXIST	Command is running. You cannot edit or delete the command.