更新指定 Deployment 的配置信息。
前提
已完成 Endpoint 与鉴权配置，详见API 总览与认证。
接口
POST /deployments/{deployment_id}
路径参数
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
deployment_id | 是 | string | Deployment ID |
请求体
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
name | 否 | string | Deployment 名称，最长 256 字符 |
description | 否 | string | 部署用途描述 |
agent | 否 | object | 关联的 Agent |
environment_id | 否 | string | null | 关联的 Environment ID |
schedule | 否 | object | null | 定时触发配置；传 null 则清除定时触发 |
initial_events | 否 | array<object> | 触发时发送给 Agent 的初始事件列表，1-50 项 |
resources | 否 | array<object> | 挂载文件资源列表 |
vault_ids | 否 | array<string> | 关联的 Vault ID 列表 |
metadata | 否 | object | 业务自定义键值对 |
请求示例
响应
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | — |
type | string | — |
name | string | — |
description | string | — |
agent | object | — |
environment_id | string | — |
schedule | object | null | — |
initial_events | array<object> | — |
resources | array<object> | — |
vault_ids | array<string> | — |
metadata | object | — |
status | string | — |
paused_reason | object | null | 暂停原因，仅暂停状态时返回 |
archived_at | string | null | — |
created_at | string | — |
updated_at | string | — |
request_id | string | 本次请求的唯一标识，排查问题时附带 |
错误码
| 状态码 | 错误码 | 说明 |
|---|---|---|
| 400 | InvalidParameter | Required parameter missing or invalid. |
| 401 | InvalidApiKey | Invalid API-key provided. |
| 409 | DEPLOYMENT_STATE_CONFLICT | Cannot update an archived deployment. |