コンテンツにスキップ

削除



POST /api/v1/aggs_to_metric/delete

概要

メトリクスを生成するルールを一括でソフト削除し、対応する周期スケジュールとリソースの関連をクリーンアップします。

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

まず各対象 UUID を確認してください。本ワークスペース内の未削除ルールのみを操作します。リクエスト配列に一致するものがまったくない場合([] を含む)、ObjectNotExists が返されます。一部の UUID が一致しない場合でも、項目ごとのエラーは返されません。成功時は 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 を取得します。
ruleUUIDs array Y 必須の文字列配列。空でないことを推奨します。カンマ区切りの文字列ではありません。本モジュール一覧の aggs UUID のみを使用し、同じ rul_ プレフィックスで型を判断しないでください。
null を許可: False
例: ["rul_aggs_example"]
取得または入力方法: メトリクスを生成するルール一覧から各ルールの UUID を取得します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/aggs_to_metric/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ruleUUIDs":["rul_aggs_example"]}'

レスポンス

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 のトップレベルがオブジェクトではありません 一部の json ファイルの形式エラー 例に従って JSON オブジェクトを送信してください。
404 ft.ObjectNotExists 現在のワークスペースに、リクエスト UUID に対応する未削除ルールがありません([] を含む) 指定されたオブジェクトが存在しません 本モジュールの一覧から有効なルール UUID を取得してください。
403 ft.Forbidden 現在の認証情報に削除/リソース操作の権限がありません 操作権限がありません 対応する操作権限を持つ API Key を使用してください。
400 ft.OuterFuncFailed 下流のスケジュール削除が失敗を返した 外部関数の呼び出しに失敗 まずスケジュールとルールの状態を確認し、失敗が続く場合は traceId を提供してください。
500 ft.InternalServerError 下流のタイムアウト/通常の 5xx、データベースまたは後続のメタデータ処理の失敗 内部エラー まずルールとその状態、出力メトリクス、スケジュールの現在の状態を読み取ってから再試行するかどうかを判断し、traceId を提供してください。

フィードバック

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