DescribeCommands

1. 接口描述

本接口(DescribeCommands)用于查询命令列表。

2. 请求参数

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

参数名称	必选	类型	描述
commandIds	否	Array of String	根据命令ID进行筛选。 最长不超过100个。
name	否	String	根据命令名称进行筛选。 该字段支持模糊搜索。
types	否	Array of CommandType	根据命令类型进行筛选。
pageSize	否	Integer	返回的分页大小，默认为20，最大为1000。 可选值范围：[1, 1000]。
pageNum	否	Integer	返回的分页数，默认为1。 可选值范围：[1, +)。
tagKeys	否	Array of String	根据标签键进行搜索。 最长不得超过20个标签键。
tags	否	Array of Tag	根据标签进行搜索。 最长不得超过20个标签。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
dataSet	Array of Command	命令列表。
totalCount	Integer	匹配条件的命令总数。

4. 代码示例

示例

1. 查询命令列表。

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

Request：
{
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "dataSet": [
      {
        "commandId": "<commandId>",
        "name": "Test",
        "description": "Echo test",
        "content": "echo 1",
        "type": "SHELL",
        "createTime": "2025-10-17 11:12:54",
        "latestInvocationTime": "2025-10-17 11:12:54",
        "tags": {
          "tags": [
            {
              "key": "test",
              "value": "test"
            }
          ]
        }
      }
    ],
    "totalCount": 0
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码	错误码	说明