Pipelineの実行
このAPIを使用すると、Gitリポジトリ内の特定のブランチでパイプラインをトリガーできます。これは、リクエストボディでパラメータとしてブランチ名を渡すことで行えます。手動パイプラインをトリガーする場合は、リクエストJSONのブランチ名パラメータを省略できます。
このAPIをトリガーすると、パイプラインが実行され、実行のステータスがレスポンスとして返されます。
Pipeline詳細の取得
このAPIを使用すると、Catalystコンソールで作成されたパイプラインの詳細を取得できます。これは、リクエストURLにpipeline_idとproject_idを渡すことで行えます。APIは、パイプラインが作成されたプロジェクトの詳細とパイプラインの詳細を取得します。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/pipeline/{pipeline_id}/run
パイプラインが作成されたプロジェクトの一意のID
詳細を取得するパイプラインの一意のID
リクエストJSONプロパティ
注意:
- 手動のCatalyst Pipelineをトリガーする場合、BRANCH_NAMEは任意です。
- EVENTおよびURLキーは環境変数として追加されています。パイプラインの実行に必要なキーをイベントJSONで渡すことができます。
スコープ
pipeline.execution.CREATE
レスポンス詳細
パイプライン作成履歴の詳細を含むオブジェクトがレスポンスとして返されます。オブジェクトには、history_id、event_time、history_statusなどの詳細が含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/pipeline/29810101101/run
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-d ‘{
“BRANCH_NAME” : “main”,
“EVENT”: “push”, \
“URL”: “https://www.google.com”
}
{
“status”: “success”,
“data”: {
“history_id”: “5000000021007”,
“pipeline_id”: “29810101101”,
“event_time”: “Mar 20, 2024 02:02 PM”,
“event_details”: {
“BRANCH_NAME”: “main”,
“EVENT”: “push”,
“URL”: “https://www.google.com”
},
“history_status”: “Queued”
}
}
Yes
No
Thank you for your feedback!
Send your feedback to us