削除¶
POST /api/v1/monitor/mute/{mute_uuid}/delete
概要¶
現在のワークスペースのミュートルールを削除します。
呼び出し前の確認と使用手順¶
まず現在のワークスペース一覧で対象を確認してから削除し、完了後にルールと実際の有効状態を再クエリします。
この操作はミュートルールをソフト削除し、後続の設定通知と実行キャッシュを非同期でクリーンアップします。履歴イベントや監視データは削除しません。一致するレコードがない場合も true を返しますが、その UUID が存在したことを意味するものではありません。
削除が 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/delete' \
-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 を提供してください。 |