コンテンツにスキップ

無効化/有効化



POST /api/v1/aggs_to_metric/set_disable

概要

現在のワークスペースにおけるメトリクスを生成する定期タスクを一括で無効化または有効化します。

本モジュールのリストで各 aggs UUID を確認した後、isDisable と完全な配列を送信します。true で無効化して status=2 を設定し、false で有効化して 0 を設定します。サーバー側は一致するルールとスケジュールスイッチを同期的に更新します。ヒットがない場合([] を含む)でも true を返すことがあり、項目ごとの結果は提供されません。現在のワークスペースの削除されていない項目のみを更新し、削除済みのルールは復元されません。

これらのエントリは共通のルール処理を共有しており、一部の対象クエリでは type=aggs による追加の限定がありません。誤読や他のルールの変更を避けるため、本モジュールのリストが返す UUID のみを使用してください。

有効化してもすぐに補完実行されたり履歴データが返されたりすることはなく、無効化しても生成済みメトリクスは削除されません。実行中のタスクは取り消しが保証されません。スケジュールとデータベースは同一のアトミックトランザクションではないため、失敗後は両側の状態を確認してから再試行してください。

リクエストヘッダー

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

リクエストボディパラメータ

パラメータ名 タイプ 必須 説明
ruleUUIDs[*] string 単一の完全な UUID です。空白は自動的に削除されません。
例: rul_aggs_example
取得または入力方法: メトリクスを生成するルール一覧から単一の aggs ルールの uuid を取得します。
isDisable boolean Y 必須の JSON ブール値です。文字列「true」は使用できません。
null の許可: False
例: true
取得または入力方法: true で以降の定期タスクを一時停止し、false で定期タスクを再開します。
ruleUUIDs array Y 必須の文字列配列です。空でないことを推奨します。カンマ区切りの文字列ではありません。本モジュールのリストにある aggs UUID のみを使用し、同じ rul_ プレフィックスに依存してタイプを判断しないでください。
null の許可: False
例: ["rul_aggs_example"]
取得または入力方法: メトリクスを生成するルール一覧から各ルールの UUID を取得します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/aggs_to_metric/set_disable' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ruleUUIDs":["rul_aggs_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 を修正してください。
400 ft.JsonFormatError JSON のトップレベルがオブジェクトではない 一部の json ファイルの形式エラー 例に従って JSON オブジェクトを送信してください。
403 ft.Forbidden インターフェースの操作権限が不足しているか、ヒットしたルールで現在の識別情報による操作が許可されていない 操作権限がありません API Key の権限と対象ルールを確認してください。
400 ft.OuterFuncFailed 一括スケジュールスイッチの呼び出しに失敗 外部関数の呼び出しに失敗 実際のルール状態とスケジュール状態を読み戻してから再試行してください。
400 ft.SameSetTraggerExists スケジュールサービスが重複設定のビジネスエラーを返した 同じ設定のトリガーが既に存在します まず既存のスケジュールを確認し、失敗が続く場合は traceId を提供してください。
500 ft.InternalServerError ダウンストリームのタイムアウト/一般的な 5xx、データベースまたは後続のメタデータ処理の失敗 内部エラー まずルールとその状態、出力メトリクス、スケジュールの現在の状態を読み取り、再試行するか判断してください。traceId を提供してください。

フィードバック

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