コンテンツにスキップ

RUM 設定の削除



POST /api/v1/rum_cfg/delete

概要

指定した RUM アプリケーション設定を削除し、マッピング削除を非同期に同期します。

呼び出し前と使用手順

現在の Key には rum.rumCfgManage が必要で、現在のワークスペースのみが対象です。appIds 配列を推奨します。旧 rumcfgUUIDs が空でない場合は優先的に使用され、appIds は完全に無視されます。フィールド名に UUID が含まれていても、値は公開 appId です。両方を省略/[]にするとアプリケーションは選択されず、{} が返されます。

現在のワークスペース内で未削除かつ一致するアプリケーションのみをソフト削除し、実際にヒットした appId→名前のオブジェクトを返します。未知/ワークスペース間/削除済みの項目は無視されます。custom のバインディング関係はソフト削除されますが、元のダッシュボードおよび組み込みビューは削除されません。SourceMap 管理対象のアプリケーションでは、同時にその保持ポリシーを停止し、未実行の retention クリーンアップをキャンセルしますが、ソースファイルの即時消去、実行済みクリーンアップのロールバック、またはデータ復元を意味するものではありません。

関連する Client Token を削除/失効させることはなく、このコントローラによって過去の RUM テレメトリデータを削除することもありません。アプリケーションの削除を収集認証情報の失効と見なすことはできません。送信後、リクエストの appId に基づいてマッピング削除の照合を投入し(一致しない重複削除項目を含む)、キューの失敗は許容されますが、成功してもクエリ/収集ノードが直ちに収束することを保証するものではありません。再試行すると照合を再度トリガーできます。まず簡易一覧と業務状態を読み戻してから処理を決定してください。

リクエストヘッダー

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

Body リクエストパラメータ

パラメータ名 型 必須 説明
appIds[*] string 公開 appId 文字列。
例: payment_web
取得または入力方法: RUM アプリケーション簡易一覧 から content[].appId(uuid は同じ値)を取得するか、現在のワークスペースの RUM アプリケーション設定から取得します。
rumcfgUUIDs[*] string 旧互換の appId 文字列。
例: payment_web
取得または入力方法: RUM アプリケーション簡易一覧 から content[].appId(uuid は同じ値)を取得するか、現在のワークスペースの RUM アプリケーション設定から取得します。
appIds array 推奨されるアプリケーション識別子配列。省略/[] は対象なし。複数項目でも項目ごとのエラーは返さず、実際に削除された名前マッピングのみを返します。
null 許可: False
例: ["payment_web"]
取得または入力方法: RUM アプリケーション簡易一覧 から content[].appId(uuid は同じ値)を取得するか、現在のワークスペースの RUM アプリケーション設定から取得します。
rumcfgUUIDs array 旧互換配列であり、新しい呼び出しでの使用は推奨しません。空でない場合は appIds より優先され、項目は内部 UUID ではなく appId のままです。空の場合のみ appIds にフォールバックします。
null 許可: False
例: []
取得または入力方法: RUM アプリケーション簡易一覧 から content[].appId(uuid は同じ値)を取得するか、現在のワークスペースの RUM アプリケーション設定から取得します。

リクエスト例

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

レスポンス

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

フィールド 型 説明
content object 実際に削除された appId から名前へのマッピング。一致なしの場合は {}(空オブジェクトは宣言を挿入しません)。
content.アプリケーション識別子 string 実際に削除されたあるアプリケーションの名前であり、ブール値や削除件数ではありません。
content.declaration object 空でない削除マッピングは現在のワークスペース宣言を挿入します。動的な appId 命名では declaration 予約キーの使用を避けてください。
{
  "code": 200,
  "content": {
    "payment_web": "支付Web",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}
{
  "code": 200,
  "content": {},
  "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 ファイル形式エラー appIds 配列オブジェクトを送信してください。
429 ft.OperationTooFrequently 現在のワークスペースで他の RUM 作成/変更/削除/Token 操作が書き込みロックを保持しており、5 秒以内に取得できなかった 操作が頻繁すぎます。しばらくしてから再試行してください 他の操作が終了するのを待ってバックオフしてください。現状を読み戻してから再試行し、並行して変更しないでください。
500 ft.InternalServerError データベースの削除、SourceMap 保持ポリシーの停止、またはロックサービスの異常 内部エラー まずアプリケーションが削除済みか確認し、その後管理者に SourceMap 保持ポリシー/クリーンアップおよび非同期マッピングの現状を確認してもらってください。失敗を理由に削除が発生していないと判断しないでください。

フィードバック

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