無効化/有効化¶
POST /api/v1/slo/{slo_uuid}/set_disable
概要¶
指定したSLOの有効/無効状態を設定します。
呼び出し前の準備と使用手順¶
現在のAPI Keyにはmonitor.sloCfgManageが必要です。メトリクス型を保存するには、対象メトリクスのnamespaceへのクエリ権限も必要で、SLO管理権限だけではこの事前チェックを通過できません。操作できるのはKeyが属するワークスペースのみです。パスのSLO UUIDは获取SLO列表のcontent.data[].uuid(通常はmonitor_プレフィックス)から取得し、関連するモニターのRule UUIDやmetricQueryInfo.sloIdではありません。
有効化/無効化はSLOおよび関連する検出/計算コンポーネントとリモートスケジューリングを同時に調整します。返されるのは今回実際に状態が変化したSLO名の配列のみで、リクエストしたすべてのUUIDや項目ごとの成功マッピングではありません。すでに目標状態の場合は[]となり、リモートを重複して変更しません。対象が無効/削除済み/別ワークスペースの場合はNotFoundSLOです。
メトリクス型の無効化では停止時刻が記録されます。無効化から再び有効化するとvalidAfterがリセットされ、復旧後の統計を旧有効期間に直接統合すべきではありません。モニター型の一時停止では元のSLIモニターは削除されません。今回の操作では元のモニター自体の一時停止は行いません。作成、変更、有効化/無効化はローカルトランザクションの最後にコミットされ、失敗時はリモートスケジューリングとキャッシュの復旧を試みます。ただし、リモート補償も失敗する可能性があり、HTTPの失敗だけですべてのシステムに変更がないと判断できません。ネットワークタイムアウト/500の後は、まず获取SLO详情で設定と状態を確認し、必要に応じて管理者にスケジューリングを確認してもらってから再試行してください。保存に成功しても検出結果がすでに生成されたことを意味しないため、検出頻度の経過を待って実際のデータを確認する必要があります。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| slo_uuid | string | Y | 対象SLO UUID。SLIモニターUUIDやmetricQueryInfo.sloIdではありません。 例: monitor_example取得/入力方法: 获取SLO列表からcontent.data[].uuidを読み取ります。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースのOpenAPI認証情報。 例: <DF-API-KEY>取得/入力方法: 対象ワークスペースのAPI Key管理から、この操作権限を持つOpenAPI Keyを取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| isDisable | boolean | Y | 必須のboolean。trueで無効化、falseで有効化。文字列やnullは受け付けません。無効化しても設定は削除されません。 null許可: False 例: true取得/入力方法: SLO検出を一時停止するかどうかで選択します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/slo/monitor_example/set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"isDisable":true}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | array<string> |
今回実際に状態が変化したSLO名。変化なしの場合は[]で、順序は保証されません。 |
| content[] | string | 状態が変化した1つのSLO名。 |
{
"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ファイル形式エラー | オブジェクトを送信します。 |
| 404 | ft.NotFoundSLO | 対象が現在のワークスペースにない、削除済み、またはSLOではない。変更の場合は必要な検出/計算コンポーネントの欠落も含む | 指定されたSLOが見つかりません | 現在のワークスペースのSLOリストからuuidを取得し、対象が存在することを確認します。コンポーネントが欠落している場合は管理者に修復を依頼してください。 |
| 400 | ft.OuterFuncFailed | リモートスケジューリングサービスが失敗を返した | 外部関数呼び出し失敗(一部の分岐では下流のmessageを使用) | messageとtraceIdを確認し、管理者にスケジューリングの可用性と設定の現状を確認してもらってから再試行します。 |
| 400 | ft.SameSetTraggerExists | リモートスケジューリングサービスが同じトリガー設定の存在を報告 | 同一設定のトリガーがすでに存在 | まずこのSLOとリモートスケジューリングを確認し、残留/重複設定を処理してから再送信します。 |
| 500 | ft.InternalServerError | データベース/キャッシュ、タスクキュー、不正な配列メンバー、または未処理の下流例外。失敗時はすでにリモート変更がある可能性 | 内部エラー | まず対象SLOの設定とスケジューリングの現状を確認します。削除失敗の場合は削除済み状態も確認し、盲目的に再作成したり一括上書きしたりしないでください。 |