無効化¶
POST /api/v1/monitor/mute/{mute_uuid}/disable
概要¶
現在のワークスペースのミュートルールを無効化します。
呼び出し前と使用手順¶
まず現在のワークスペースのリストで対象を確認してから無効化し、完了後にルールと実際の有効状態を再取得します。
無効化すると、一致するルールの status が 2 に設定され、非同期で実行キャッシュを同期し、後続の設定済み通知をキャンセルします。時刻と元の設定は保持されます。実行が開始されたメッセージの取り消しは保証されません。レコードに一致しない場合でも、現在は true を返します。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| mute_uuid | string | Y | 現在のワークスペースのミュートルールのパス UUID。 例: mute_example取得または入力方法: ミュートルール一覧 の content.data[].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/monitor/mute/mute_example/disable' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要なフィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 成功時は true。実際の一致と非同期状態の境界については使用説明を参照してください。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している場合 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 500 | ft.InternalServerError | 保存または非同期同期の送信に失敗 | 内部エラー | ルールの状態を再取得し、結果を確認してから再試行し、traceId を提供してください。 |