コンテンツにスキップ

削除



POST /api/v1/service_manage/delete

概要

指定したサービスリスト設定を一括削除します。

呼び出し前の準備と使用手順

API Key にはサービス管理権限(trace.serviceManage)が必要です。まずサービスリストを呼び出し、UUID と名前を項目ごとに確認します。リクエストの serviceUUIDs は、確認済みの空でないリストである必要があります。現在のインターフェースは空の配列を受け取ると本ワークスペースのすべてのアクティブなサービスリストを削除するため、クライアントは送信前に空の配列をブロックする必要があります。削除は一致したサービスリストをソフト削除し、これらの UUID に対応するタグの関連付けをクリーンアップします。呼び出し前に詳細を保存してバックアップしてください。結果が不明な場合は、まず設定を再一覧表示してから次のステップを決定します。

リクエストヘッダー

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

Body リクエストパラメータ

パラメータ名 型 必須 説明
serviceUUIDs[*] string 配列内の単一のサービスリスト UUID 文字列。
例: sman_example
取得または入力方法: サービスリストの content.data[].uuid からコピーします。
serviceUUIDs array Y 削除対象のサービスリスト UUID 配列。クライアントは空の配列を禁止する必要があります。現在、空の配列を指定するとワークスペース全体のアクティブなサービスリストを削除できます。
null を許可: False
例: ["sman_example"]
取得または入力方法: サービスリストの content.data[].uuid から、実際に削除するサービスを選択します。送信前に配列が空でないことを確認し、項目ごとに名前を照合してください。

パラメータ補足説明

削除してもサービスの収集は停止せず、収集済みのトレーシングデータも削除されません。自動検出が実行中の場合、後で対応するサービスリストが再び表示されることがあります。

リクエスト例

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

レスポンス

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

フィールド 型 説明
content boolean 成功時は true。存在しない UUID や現在のワークスペースに属さない UUID は無視されるため、これに基づいてすべての 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 オブジェクトとして構成します。

フィードバック

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