一括削除¶
POST /api/v1/slo/batch_delete
概要¶
現在のワークスペース内の SLO を一括削除します。
呼び出し前の準備と使用手順¶
現在の API Key には monitor.sloCfgManage が必要です。指標型の保存にはさらに対象指標の namespace 参照権限が必要であり、SLO 管理権限だけではこの事前チェックを通過できません。操作対象は Key が属するワークスペースのみです。パス内の SLO UUID は SLO 一覧の取得 の content.data[].uuid(通常は monitor_ プレフィックス)から取得します。関連するモニターの Rule UUID や metricQueryInfo.sloId ではありません。
これは書き込みの副作用を伴う POST 一括削除インターフェースです。呼び出す前に SLO とその関連をバックアップし、ステータスページなどの参照を調整する必要があるか確認してください。SLO 自体、その検出/計算コンポーネント、および SLI/アラートポリシー/タグの関連付けを削除します。参照されている元の SLI モニターとアラートポリシーは削除されず、過去の時系列データのクリーンアップも保証されません。まずリモートスケジューラを削除し、その後ローカル削除をコミットします。コミット後はポリシーキャッシュを非同期でクリーンアップします。各段階はサービスをまたぐトランザクションではないため、失敗時にはすでにスケジューリングが停止されている、またはローカル削除が完了している可能性があります。
現在のワークスペースで一致がない場合、または SLO 以外の項目のみの場合は [] を返します。実際に削除が行われた場合は true を返します(項目ごとの結果や削除件数ではありません)。一部の無効な UUID は無視されるため、リストを読み戻して項目ごとに確認する必要があります。確定済みの SLO UUID のみを送信し、通常のモニターグループなど他のリソースを混在させないでください。ネットワーク障害や 500 の後は、まず SLO 一覧とスケジューラの現在の状態を確認し、むやみに繰り返さないでください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作の権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| sloUUIDs[*] | string | 現在のワークスペース内の単一の SLO UUID 文字列。 例: monitor_example取得または入力方法: 配列の取得元と同じです。 |
|
| sloUUIDs | array | Y | 必須の配列です。実際の SLO UUID のみを渡し、[] は対象なしで [] を返します。無効/クロスワークスペース/削除済みの対象はローカル削除の対象として扱われません。本インターフェースは項目ごとの失敗を返しません。通常のモニターグループ UUID を混在させないでください。バッチ内に有効な SLO が 1 つでもあると、リモートスケジューラの削除は送信されたすべての UUID を走査します。 null 許可: False 例: ["monitor_example"]取得または入力方法: 現在のワークスペースの SLO 一覧から各 content.data[].uuid を取得し、先に名前と依存関係を確認します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/slo/batch_delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"sloUUIDs":["monitor_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要なフィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean または array<string> |
実際に削除が行われた場合は true。削除可能な SLO に一致しない場合は [] を返し、項目ごとの結果は返しません。 |
{
"code": 200,
"content": true,
"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 ファイル形式エラー | sloUUIDs 配列のオブジェクトを送信します。 |
| 400 | ft.OuterFuncFailed | リモートスケジューラサービスが失敗を返した | 外部関数呼び出し失敗(一部の分岐ではダウンストリームの message を使用) | message と traceId を確認し、管理者にスケジューラの可用性と設定の現在の状態を確認してもらってから再試行します。 |
| 400 | ft.SameSetTraggerExists | リモートスケジューラサービスが同一のトリガー設定が既に存在すると報告した | 同一設定のトリガーが既に存在 | まず該当 SLO とリモートスケジューラを確認し、残留/重複設定を処理してから送信します。 |
| 500 | ft.InternalServerError | データベース/キャッシュ、タスクキュー、不正な配列メンバー、または未処理のダウンストリーム例外。失敗時にはすでにリモート側の変更が行われている可能性がある | 内部エラー | まず対象 SLO の設定とスケジューラの現在の状態を確認します。削除に失敗した場合は削除済み状態も確認し、むやみに再作成したり一括で上書きしたりしないでください。 |