削除¶
POST /api/v1/notify_object/delete
概要¶
ワークスペースの通知先を削除します。
呼び出し前と使用手順¶
まず通知先一覧で UUID を確認し、その通知先を参照しているアラートポリシーまたは通知ポリシーを調整してください。この操作は、現在のワークスペースで一致した通知先を論理削除し、アラートポリシーのキャッシュをクリアします。すべての参照が自動的に解除されることは保証されません。一致する通知先がない場合でも true を返し、重複して呼び出しても対象が存在しないというエラーは返しません。一括リクエストでは、いずれかの対象に操作権限がない場合に失敗します。サービス異常が発生した場合は、まず結果を再取得してから再試行してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエストボディパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| notifyObjectUUID | string | Y | 削除する単一の通知先 UUID。 null 許可: False 例: notify_example取得または入力方法: 通知先一覧が返す content.data[].uuid から、現在のワークスペースの通知先 UUID をコピーします。 |
パラメータの補足説明¶
処理対象となるのは、現在のワークスペース内で削除されていない通知先のみです。戻り値には削除件数は含まれません。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/notify_object/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"notifyObjectUUID":"notify_example"}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 削除処理が完了した場合に true になります。一致する通知先がない場合も含みます。 |
{
"code": 200,
"content": true,
"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 ファイルの形式エラー | 単一の JSON オブジェクトを送信してください。 |
| 403 | ft.ForbiddenNotifyObjOperation | 対象でカスタム権限が有効になっており、現在のアイデンティティが操作可能な範囲にない | 通知先【{}】を操作する権限がありません | 管理権限を持つアイデンティティで、対象の permissionSet とワークスペースの高度な権限設定を確認してください。 |
| 500 | ft.InternalServerError | 削除リクエストの送信、キャッシュのクリア、または後続の監査に失敗 | 内部エラー | まず一覧を確認して対象がまだ存在するかどうかを確かめ、500 を「未削除」と判断しないようにしてください。その後、traceId を付けて再試行するか、サポートに連絡してください。 |