コンテンツにスキップ

有効化/無効化



POST /api/v1/checker/set_disable

概要

モニターとその既存のスケジュールを一括で有効化または無効化します。

呼び出し前の確認と使用手順

各ルールの現在の状態、操作権限、およびスケジュールの有効化/無効化後の状態を確認します。サーバー側ではルールと既存のメイン/サブ/クロスワークスペーススケジュールのスイッチを同期的に更新します。タスクを再作成したり再実行したりするものではありません。空の配列や一致する項目がない場合でも true を返すことがあり、項目ごとの結果は返されません。セルフホストインスペクションには本 API で作成される定期スケジュールがなく、その実際の実行はビジネス統合側で制御されます。現在の共有有効化パスでは、各履歴クロスワークスペーススケジュールの最新の認可を再確認していないため、有効化が成功してもソースデータがクエリ可能であることは保証されません。実際に検証する必要があります。非同期参照タスクは有効化/無効化時に SLO 計算を更新しません。

各ターゲットに対してカスタム操作権限が個別に検証されますが、API Key のインターフェース権限も引き続き必要です。スケジュールサービス、データベースのコミット、参照のクリーンアップ、非同期ディスパッチはサービスをまたぐアトミックトランザクションではありません。異常時には一部の状態やスケジュールがすでに更新されている可能性があるため、設定とスケジュールの現在の状態を読み直してからリトライし、HTTP 200 のみで受け入れ判断を行わないでください。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
ruleUUIDs[*] string グループ、履歴、SLO、または生成メトリクスの UUID ではありません。
例: rul_checker_example
取得または入力方法: 現在のワークスペースで操作可能な単一のモニター uuid。
isDisable boolean Y 必須のブール値で、それぞれ status=2/0 を設定します。削除済みのルールは復元しません。有効化しても失われたスケジュールは再作成しません。
null の許可: False
例: true
取得または入力方法: true で無効化、false で有効化。
ruleUUIDs array Y 必須の配列で、空でないことを推奨します。これらの共有メソッドはモニターのカテゴリを追加で限定しないため、rul_ プレフィックスのみで他の Rule リソース UUID を混在させないでください。
null の許可: False
例: ["rul_checker_example"]
取得または入力方法: モニター一覧 から対象の type ごとに本ワークスペースの uuid を取得します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/checker/set_disable' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ruleUUIDs":["rul_checker_example"],"isDisable":true}'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。

フィールド 型 説明
content boolean 成功時は true。項目ごとのヒット数や下流の実行結果の受け入れ結果ではありません。
{
  "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 Body のトップレベルがオブジェクトではない(配列/文字列など) 一部の json ファイルの形式エラー 例に従って JSON オブジェクトを送信してください。checkers や event の配列を直接送信することはできません。
403 ft.ForbiddenCheckerOperation 対象の通常モニターに対する操作権限がない モニター【{}】に対する操作権限がありません owner またはルールで許可された操作主体を使用し、API Key の権限を確認してください。
403 ft.ForbiddenSmartCheckerOperation 対象のインテリジェント/AI モニタリングに対する操作権限がない インテリジェントモニタリング【{}】に対する操作権限がありません 該当ルールの permissionSet と操作主体を確認してください。
400 ft.OuterFuncFailed スケジュールの一括有効化/無効化/削除が明確なビジネス上の失敗を返した 外部関数の呼び出しに失敗 スケジュールとルールの状態を確認してリトライし、traceId を提供してください。
500 ft.InternalServerError スケジュール接続/タイムアウト/無効な JSON などの捕捉されない例外、ストレージ、参照、またはコミット後の非同期ディスパッチの失敗 内部エラー まず各オブジェクトとスケジュールの現在の状態を読み取り、完了済みの手順を確認してから的を絞ってリトライし、traceId を提供してください。

フィードバック

このページは役に立ちましたか?