無効化/有効化¶
POST /api/v1/error_track_rule/set_disable
概要¶
エラー追跡ルールを一括で有効化または無効化します。
呼び出し前の確認と使用手順¶
現在のキーには errorCenter.errorTrackRuleManage が必要で、現在のワークスペースのみが対象です。一括 UUID はまず未削除項目を絞り込み、無効化済みルールも含みます。不明/別ワークスペース/削除済みの項目は直接無視されます。[] またはすべて無効でも true を返し、ヒット件数/項目別の結果はありません。成功しても各入力が反映されたことを証明するものではないため、一覧/詳細を読み戻して確認する必要があります。
isDisable は必ず true/false を明示してください。省略すると実際には有効化されます。ヒットした項目は元の状態が同じでも更新日時が変わります。無効化は状態を保存するだけで、ルール/過去のエラーを削除しません。有効化しても過去のすべてのデータが直ちに処理されるわけではないため、後続の出力は受け入れ確認が必要です。
本コントローラーは同期タスク/下流の確認を返しません。失敗後はまず読み戻して確認し、ネットワークエラーを未更新と誤認しないようにしてください。不明な項目が無視されることは、バッチ全体のアトミックな保証にはなりません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| ruleUUIDs[*] | any | 単一ルール UUID。文字列を推奨。元の宣言には要素ごとの型/非空検証がないため、クライアント側で確認してください。 例: issetrule_example取得または入力方法: 現在のワークスペースのルール一覧の uuid。 |
|
| isDisable | boolean | 任意のブール値。null は拒否。true で status=2、false で 0 を設定します。省略してコントローラーに渡すと None になり、実際には有効化の 0 として処理されるため、意図しない有効化を避けるため毎回明示してください。 null 許可: False 例: true取得または入力方法: 呼び出し元が無効化 true または有効化 false を明示的に選択します。 |
|
| ruleUUIDs | array | Y | 必須配列。[] はヒットなし。現在のワークスペースの status!=3 の項目のみ対象で、不明/別ワークスペース/削除済み項目は無視され、項目別の失敗一覧はありません。 null 許可: False 例: ["issetrule_example"]取得または入力方法: ルール一覧 から content.data[].uuid を取得し、現在の状態/型を確認します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/error_track_rule/set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"ruleUUIDs":["issetrule_example"],"isDisable":true}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 成功時は true(ヒットなしを含む)。declaration、ヒット件数、項目別ステータスは含みません。 |
{
"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 を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | JSON ファイル形式の一部が不正 | ruleUUIDs を含むオブジェクトを送信してください。 |
| 500 | ft.InternalServerError | データベースまたは履歴ルール形式などの未処理例外 | 内部エラー | ルール状態を読み戻してから再試行するか判断してください。traceId を保持し、失敗によって全項目が保存されなかったと断定しないでください。 |