Skip to main content
Deployment

列出 Deployment

分页查询 Deployment 列表,支持按 Agent、状态、关键词等条件筛选。

前提

已完成 Endpoint 与鉴权配置,详见API 总览与认证

接口

GET /deployments

Query 参数

参数必填类型说明
agent_idstring按 Agent ID 筛选
keywordstring按 ID 或名称模糊搜索
statusstring按状态筛选
include_archivedboolean是否包含已归档的 Deployment,默认 false
limitinteger每页返回数量,最大 100,默认 20
pagestring分页游标
created_at[gte]string创建时间下界,RFC 3339
created_at[lte]string创建时间上界,RFC 3339

请求示例

curl "$AGENTSTUDIO_URL/deployments?agent_id=agent_xxx&keyword=data&status=active&include_archived=true&limit=20" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

响应

响应包含 data(部署对象数组)与 next_page(下一页游标,无更多数据时为 null)。
{
  "data": [
    {
      "id": "depl_xxx",
      "type": "deployment",
      "name": "每日订单汇总",
      "status": "active",
      "agent": {
        "id": "agent_xxx",
        "version": 12
      },
      "environment_id": "env_xxx",
      "schedule": {
        "type": "cron",
        "expression": "0 9 * * 1-5",
        "timezone": "Asia/Shanghai",
        "last_run_at": null,
        "next_run_at": "2026-07-28T01:00:00Z"
      },
      "initial_events": [],
      "resources": [],
      "vault_ids": [],
      "metadata": {},
      "paused_reason": null,
      "archived_at": null,
      "created_at": "2026-07-28T01:00:00Z",
      "updated_at": "2026-07-28T01:00:00Z",
      "request_id": "req_xxx"
    }
  ],
  "next_page": null
}

响应字段

字段类型说明
dataarray<object>部署对象数组
data[].idstringDeployment ID
data[].typestring固定为 deployment
data[].namestringDeployment 名称
data[].descriptionstringDeployment 用途说明
data[].agentobject关联 Agent 在锁定版本的快照
data[].environment_idstring关联 Environment ID
data[].scheduleobject定时触发配置
data[].initial_eventsarray<object>触发时发送给 Agent 的初始事件
data[].resourcesarray<object>挂载的文件资源
data[].vault_idsarray<string>关联 Vault ID 列表
data[].metadataobject业务自定义键值对
data[].statusstringDeployment 状态:activepaused
data[].paused_reasonobject | null暂停原因;仅状态为 paused 时返回
data[].archived_atstring | null归档时间,未归档时为 null
data[].created_atstring创建时间,ISO 8601
data[].updated_atstring最近更新时间,ISO 8601
data[].request_idstring请求唯一标识
next_pagestring | null下一页游标;无更多数据时为 null

错误码

状态码错误码说明
400InvalidParameterRequired parameter missing or invalid.
401InvalidApiKeyInvalid API-key provided.