ModifyCommand

1. 接口描述

本接口(ModifyCommand)用于修改命令。

注意事项

  • 如果存在运行的执行记录,则无法进行命令内容修改。

2. 请求参数

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

参数名称
必选
类型
描述

commandId

String

需要修改的命令ID。

name

String

命令名称。

长度不能超过64个字符。

content

String

命令内容。

长度不能超过4096个字符。

description

String

命令的描述信息。

长度不能超过255个字符。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

4. 代码示例

1. 修改命令内容和名称。

POST /api/v2/zap 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. 开发者工具

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

6. 错误码

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

HTTP状态码
错误码
说明

404

INVALID_COMMAND_NOT_FOUND

指令未找到。

400

INVALID_COMMAND_INVOCATION_RUNNING_EXIST

命令正在执行,无法操作。

最后更新于