コンテンツにスキップ

一括無効化/有効化



POST /api/v1/slo/batch_set_disable

概要

SLO の有効/無効状態を一括設定します。

呼び出し前の前提条件と使用手順

API Key には monitor.sloCfgManage が必要です。メトリクスタイプの保存には対象メトリクスの namespace 参照権限も必要であり、SLO 管理権限だけではこの事前チェックを通過できません。Key が所属するワークスペースのみを操作します。パス内の SLO UUID は SLO リストを取得 の content.data[].uuid(通常 monitor_ プレフィックス)から取得します。関連するモニターの Rule UUID や metricQueryInfo.sloId ではありません。

有効化/無効化では、SLO と関連する検出/計算コンポーネントおよびリモートスケジューラを同時に調整します。今回実際に状態が変化した SLO 名の配列のみを返します。リクエストした全 UUID や項目ごとの成功マッピングではありません。該当なし、対象がすでに指定状態、SLO 以外の項目のみ、のいずれでも [] となり、項目単位の「存在しない」エラーは返りません。

メトリクスタイプの無効化では停止時刻を記録します。無効化から再度有効化すると validAfter をリセットします。復旧後の統計を旧有効期間に直接統合しないでください。モニタータイプの一時停止では元の SLI モニターを削除しません。今回の操作は元のモニター自体の一時停止を担当しません。作成、変更、有効化/無効化はローカルトランザクションの最後にコミットされ、失敗時はリモートスケジューラとキャッシュの復元を試みます。リモート補償も失敗する可能性があり、HTTP の失敗だけで全システムに変更がないと判断できません。ネットワークタイムアウト/500 後は、まず SLO 詳細を取得 で設定と状態を確認し、必要に応じて管理者にスケジューラを確認してもらってから再試行してください。保存成功は検出結果がすでに生成されたことを意味しません。検出頻度の経過を待ち、実際のデータを確認してください。

リクエストヘッダー

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

Body リクエストパラメータ

パラメータ名 型 必須 説明
sloUUIDs[*] string 単一の SLO UUID 文字列。
例: monitor_example
取得または入力方法: 配列の取得元と同じです。
isDisable boolean Y 必須 boolean。true で無効化、false で有効化。文字列や null は受け付けません。無効化しても設定は削除されません。
null を許可: False
例: true
取得または入力方法: SLO 検出を一時停止するかどうかで選択します。
sloUUIDs array Y 必須配列。[] は操作なし。同一ワークスペース内の未削除 SLO のうち状態変更が必要な項目のみ変更し、その他の項目は通知なくスキップされ、項目ごとのエラーはありません。
null を許可: False
例: ["monitor_example"]
取得または入力方法: 現在のワークスペースの SLO リストの content.data[].uuid から取得します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/slo/batch_set_disable' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"isDisable":true,"sloUUIDs":["monitor_example"]}'

レスポンス

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

フィールド 型 説明
content array<string> 今回実際に状態が変化した SLO 名。変更なしの場合は []。順序は保証されません。
content[] string 状態が変化した SLO 1 件の名前。
{
  "code": 200,
  "content": [
    "支付服务可用性"
  ],
  "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 ファイル形式エラー オブジェクトを送信してください。
400 ft.OuterFuncFailed リモートスケジューラサービスが失敗を返しました 外部関数呼び出し失敗(一部分岐では下流の message を使用) message と traceId を確認し、管理者にスケジューラの可用性と設定の現状を確認してもらってから再試行してください。
400 ft.SameSetTraggerExists リモートスケジューラサービスが同一のトリガー設定の存在を報告 同一設定のトリガーがすでに存在します まず該当 SLO とリモートスケジューラを確認し、残留/重複設定を処理してから再送信してください。
500 ft.InternalServerError データベース/キャッシュ、タスクキュー、不正な配列メンバー、または未処理の下流例外。失敗時もリモート変更が反映済みの可能性があります 内部エラー まず対象 SLO の設定とスケジューラの現状を確認してください。削除失敗の場合は削除済み状態も確認し、むやみに再作成や一括上書きを行わないでください。

フィードバック

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