有効化¶
POST /api/v1/monitor/mute/{mute_uuid}/enable
概要¶
現在のワークスペースのミュートルールを有効化します。
呼び出し前および使用手順¶
まず現在のワークスペースの一覧で対象を確認してから有効化し、完了後にルールと実際の有効状態を再取得します。
有効化するとルールの status は 0 に設定され、元の時刻は保持されます。期限切れのルールがこれによって自動的に延長されたり、直ちに有効になったりすることはありません。キャッシュは非同期で同期され、引き続き有効な時間/対象に従ってルール設定の通知がスケジュールされます。
現在一致するレコードがない場合、404 ではなく 500 が返ることがあります。エラーだけから書き込みが発生していないと判断せず、まず有効な UUID を再取得してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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/enable' \
-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 | 対象が存在しない、削除済み、または別ワークスペースである場合に有効化の分岐処理が失敗する可能性があります。あるいは保存/同期に失敗しました | 内部エラー | 現在のワークスペース一覧で UUID と現在の状態を確認してから再試行してください。失敗が続く場合は traceId を提供してください。 |