Deployment Run を手動でトリガーします。
POST /api/v1/cloud/deployments/{id}/run
Deployment Run を手動でトリガーします。Deployment は active ステータス(一時停止やアーカイブ済みではない) である必要があります。CAS が Run のセッションを作成できなかった場合、返される Deployment Run の session_id は null になり、error オブジェクトが含まれます。
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
id | string | Deployment ID(dep_ プレフィックス) |
ヘッダー
| 名称 | 必須 | 値 |
|---|---|---|
Authorization | はい | Bearer $QODER_ACCESS_TOKEN |
Content-Type | はい | application/json |
リクエストボディ
リクエストボディは不要です。空の JSON オブジェクト {} を送るか、ボディを省略してください。
リクエスト例
レスポンス例
HTTP 200 OK
Deployment Run オブジェクトを返します。
レスポンスフィールド (Deployment Run)
| フィールド | 型 | 説明 |
|---|---|---|
id | string | Run の一意識別子(drun_ プレフィックス) |
type | string | 固定値 "deployment_run" |
deployment_id | string | 親 Deployment ID |
agent | object | Agent 参照: {id, type, version} |
error | object or null | セッションの作成に失敗した場合のエラー詳細({message, type})、session_id が存在する場合は null |
trigger_context | object | トリガーソース: {"type": "manual"} または {"type": "schedule", "scheduled_at": "..."} |
session_id | string or null | 関連付けられた Session ID。公開される行では session_id または error のいずれか一方のみが出現します。 |
created_at | string | レコード作成時刻(ISO 8601) |
エラー
| HTTP | type | 説明 |
|---|---|---|
| 401 | authentication_error | PAT または SAT が無効または期限切れ |
| 404 | not_found_error | Deployment が存在しない |
| 409 | conflict_error | Deployment がアーカイブ済みまたは active ステータスでない |