CreateCommand

1. 接口描述

本接口(CreateCommand)用于创建命令。

2. 请求参数

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

参数名称
必选
类型
描述

name

String

命令名称。

长度不能超过64个字符。

content

String

命令内容。

长度不能超过4096个字符。

description

String

命令描述信息。

最长不超过255个字符。

type

命令类型。

resourceGroupId

String

命令关联的资源组ID。

tags

命令绑定的标签信息。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

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

commandId

String

创建的命令ID。

4. 代码示例

1. 创建一个Shell命令。

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

Request:
{
  "name": "Test Command",
  "content": "echo 1",
  "type": "SHELL",
  "tags": {
    "tags": [
      {
        "key": "test",
        "value": "test"
      }
    ]
  }
}

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

5. 开发者工具

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

6. 错误码

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

HTTP状态码

错误码

说明

最后更新于