コンテンツにスキップ

削除



POST /api/v1/notice/date/delete

概要

日付設定を削除します。デフォルトでは、まず削除されていないアラートポリシーから参照されているかを確認します。

呼び出し前の確認と使用手順

まずカスタム通知日一覧から、空でない対象 UUID 配列を選択します。デフォルトでは skipRefCheck=false です。関連するポリシーが見つかった場合、HTTP 200 で refAlertPolicyNames オブジェクトが返され、日付設定は保持されます。この時点では削除成功ではありません。content=true の場合にのみ、削除フローが完了したことを示します。一致する日付レコードが見つからない場合も true を返すことがあります。参照チェックはポリシー設定のテキストに基づいて照合されるため、通知される名称はアラートポリシー詳細と合わせて確認する必要があります。空の配列は有効な事前チェックリクエストとして扱われず、対象と無関係な参照通知が返る可能性があります。まずアラートポリシー詳細で参照を確認して調整してください。どうしても強制削除が必要な場合に限り、明示的に skipRefCheck=true を指定します。強制削除では、既存の alertOpt から UUID が自動的に削除されることはなく、これらの日付参照が無効になり、アラートポリシーキャッシュがクリアされるだけです。通知ウィンドウが一致しなくなる可能性があるため、ポリシー設定を再確認してください。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

ボディリクエストパラメータ

パラメータ名 型 必須 説明
noticeDatesUUIDs[*] string 単一の日付設定 UUID。
例: ndate_example
取得または入力方法: カスタム通知日一覧内の単一の ndate_ UUID を取得します。
noticeDatesUUIDs array Y 削除対象の日付設定 UUID 配列(必須)。日付テキストは入力しないでください。
null 許可: False
例: ["ndate_example"]
取得または入力方法: カスタム通知日一覧の content.data[].uuid から対象を取得し、空でない配列を送信します。
skipRefCheck boolean 任意の boolean。デフォルトは false で参照をチェックします。true の場合は参照チェックをスキップし、現在のワークスペース内の一致する設定を削除します。
null 許可: False
例: false
取得または入力方法: 通常の削除では、まず false を指定するか省略します。参照による影響を確認した後にのみ true を使用してください。

パラメータ補足事項

デフォルトの参照通知は成功レスポンスに含まれるものであり、エラーコードではありません。呼び出し側は content の型と refAlertPolicyNames を同時に確認する必要があり、HTTP 200 や success=true のみで判断してはいけません。削除によってアラートポリシー自体は削除されません。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/notice/date/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"noticeDatesUUIDs":["ndate_example"],"skipRefCheck":false}'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。

フィールド 型 説明
content object または boolean 参照があり、チェックをスキップしていない場合はオブジェクト。削除フローが完了した場合は true。
content.refAlertPolicyNames array<string> 参照チェックで通知されるアラートポリシー名。このフィールドがある場合、今回は削除されていないことを示します。
content.refAlertPolicyNames[] string 単一のポリシー名。
content.declaration object または null 空でないオブジェクトの通知分岐にのみ、ワークスペースの共通宣言が付加されます。true の分岐にはありません。
{
  "code": 200,
  "content": {
    "refAlertPolicyNames": [
      "生产服务告警"
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

参照がない場合、または参照チェックを明示的にスキップした場合で、削除処理が完了したとき

{
  "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 オブジェクトを送信してください。
500 ft.InternalServerError 参照チェック、削除、またはキャッシュのクリアに失敗 内部エラー まず日付設定および参照しているポリシーの現在の状態を確認してください。継続的に失敗する場合は traceId を提供してください。

フィードバック

このページは役に立ちましたか?