有効化/無効化¶
POST /api/v1/pipeline/batch_set_disable
概要¶
Pipeline とそのソースの関連付けを一括で有効化または無効化します。
呼び出し前の確認と使用手順¶
まず本ワークスペースのリストから、削除されていない Pipeline UUID を 1 件ずつ照合してください。別ワークスペース、システムテンプレート、または一致しない識別子を混入させることはできません。メイン設定のクエリはワークスペースでフィルタされますが、関連ソースのステータス更新には入力集合全体が使用されます。メイン設定にヒットしないこと、または HTTP 200 が返ったことを、他の関連付けが影響を受けていないと解釈しないでください。true のみを返し、空の配列やメイン設定に一致しない場合でも成功する可能性があり、項目ごとの結果は提供されません。有効化しても過去データのリプレイはトリガーされず、無効化しても処理中の処理は取り消されません。この操作は設定バージョンをアーカイブしません。完了後はリストを再読み込みして各オブジェクトのステータスを照合してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作の権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| plUUIDs[*] | string | 名前や履歴 UUID ではありません。 例: pl_example取得または入力方法: 単一の Pipeline UUID。 |
|
| isDisable | boolean | Y | 必須のブール値。それぞれ status=2/0 に設定し、関連ソースのステータスを更新します。削除済みの項目は復元されません。 null を許可: False 例: true取得または入力方法: true で一時停止、false で有効化。 |
| plUUIDs | array | Y | 必須の配列。空でないことを推奨します。システムテンプレートは操作しません。 null を許可: False 例: ["pl_example"]取得または入力方法: Pipeline リスト から本ワークスペースの UUID 集合を取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/pipeline/batch_set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"plUUIDs":["pl_example"],"isDisable":true}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 成功で true。入力したすべての UUID がヒットしたことを意味しません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータの解析に失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 500 | ft.InternalServerError | 同期コンパイルサービスの利用不可/タイムアウト/形式異常(内部の PipelineValidationUnavailable が最終的に統一的にラップされる)、データベース、構造エラー、またはコミット後のフォーマット失敗 | 内部エラー | 後で再試行する前に、現在の設定とバージョンを読み取り、保存済みかどうかを確認してください。継続的に失敗する場合は traceId を提供してください。 |