コンテンツにスキップ

変更



POST /api/v1/monitor/mute/{obj_uuid}/modify

概要

既存のミュートルールの範囲、時刻、通知設定、カスタム宣言を変更します。

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

まず一覧を読み取って元の設定を保存し、その後、完全なリクエストを構築します。muteRanges と tags を省略すると元の値がクリアされます。その他の条件付き更新フィールドの省略規則はパラメータ表を参照してください。このインターフェースは汎用的な部分パッチではありません。

単発ルールの変更時に開始/終了時刻を省略すると保持されますが、endTime に空文字列を指定しても、現在は終了を確実にクリアできません。終了なしのルールが必要な場合は、まず既存ルールを確認するか、コンソールで調整してください。繰り返しモードへ切り替える場合は、開始、Cron、継続秒数、期限設定を完全に指定する必要があります。永久繰り返しには "0" を渡します。

通知先の変更は全体置換であり、[] は削除を意味します。変更時は作成時のように通知本文と通知先の整合性をチェックしません。自身で確認してください。既存の muteIncident は元の値のまま保持され、現在の公開リクエストでは変更できません。

ルールは一致したイベントの通知をミュートするよう制御しますが、イベントおよびモニタリングデータは従来のフローで処理されます。muteIncident はインシデント通知の拡張機能であり、現在の公開書き込みパラメータには含まれていません。調整が必要な場合はコンソールで操作してください。内部パラメータを公開リクエストのフィールドとして送信しないでください。

保存後、非同期タスクによって実行キャッシュとルール通知が更新されます。成功は、同期やメッセージ配信が直ちに完了したことを意味しません。現在アクティブなルールの変更では、設定済みの通知先に再度通知される可能性があり、新しく追加した通知先だけに通知されることを保証しません。失敗した場合は、まずルールと有効化状態を確認してください。

成功レスポンスでは repeatCrontabSet が必ず提供されるわけではありません。この構造が必要な場合は、再度一覧を読み取ってください。レスポンスには crontab、時刻、および保存済みの完全なフィールドが含まれますが、workStatus は含まれません。

ルートパラメータ

パラメータ名 タイプ 必須 説明
obj_uuid string Y パス内のミュートルール UUID。現在のワークスペースに属し、削除されていない必要があります。
例: mute_example
取得または入力方法: ミュートルール一覧 の content.data[].uuid から取得します。

リクエストヘッダー

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

Body リクエストパラメータ

パラメータ名 タイプ 必須 説明
muteRanges[*] json 単一の範囲オブジェクト。マッチングは UUID フィールドによって決定され、name/type は表示情報です。通常、1 項目には 1 種類のリソースキーのみを設定します。
例: {"checkerUUID": "rul_example", "name": "生产接口监控"}
取得または入力方法: 同じワークスペースのモニター/SLO、アラートポリシー、またはモニタータグ管理から対応する UUID を取得します。表示名を安定した識別子の代わりに使用しないでください。
muteRanges[*].checkerUUID string モニター UUID。checker 範囲でよく使用されます。
例: rul_example
取得または入力方法: 現在のワークスペースのモニター、インテリジェントモニタリング、またはインテリジェントインスペクション設定から rul_ UUID を取得します。
muteRanges[*].sloUUID string SLO 識別子。実行時に対応する SLO 検出モニターへマッピングされます。有効な検出関係がない場合、有効になることを保証しません。
例: monitor_example
取得または入力方法: 現在のワークスペースの SLO 一覧から monitor_ UUID を取得します。
muteRanges[*].alertPolicyUUID string アラートポリシー識別子。alertPolicy 範囲で使用します。
例: altpl_example
取得または入力方法: アラートポリシー一覧 の content.data[].uuid から取得します。
muteRanges[*].tagUUID string モニタータグ識別子。実行時にはタグ名に基づいてイベントの df_label をマッチングします。
例: tag_example
取得または入力方法: モニタータグ管理からタグ UUID を取得します。任意のイベントフィールド値ではありません。
muteRanges[*].name string クライアント表示名。UUID の代わりにはなりません。
例: 生产接口监控
取得または入力方法: 対応するリソースの表示名を使用します。省略可能です。
muteRanges[*].type string 表示用タイプ。実際の範囲セマンティクスはトップレベルの type と UUID フィールドによって決まります。
例: 监控器
取得または入力方法: クライアントの必要に応じてリソースの表示タイプを保持します。省略可能です。
tags.フィールド array このフィールドでマッチングする実際の値の配列。
例: ["production"]
取得または入力方法: キーには実際のイベントフィールド(例: env)を使用し、値は配列で指定することを推奨します。
tags.フィールド[*] string 単一のマッチング値。実際のデータ型に応じて選択します。
例: production
取得または入力方法: イベント内の同じフィールドの値を取得します。
notifyTargets[*] json 単一の通知先グループ。type と to を使用します。
例: {"type": "mail", "to": ["acnt_example"]}
取得または入力方法: アカウントはワークスペースメンバーから acnt_ UUID を取得し、チームは現在のワークスペースのチーム管理から group_ UUID を取得し、通知先は通知先一覧から notify_ UUID を取得します。
notifyTargets[*].type string 通知先タイプ。実行タスクがサポートする mail/notifyObject/memberGroup から選択します。不明なタイプは保存されても有効な通知を生成しない可能性があります。
例: mail
取得または入力方法: メールアカウントは mail、通知先は notifyObject、チームメールは memberGroup を使用します。
notifyTargets[*].to array mail にはアカウント UUID、notifyObject には通知先 UUID、memberGroup にはチーム UUID を設定します。同じワークスペース内の有効なリソースのみを送信してください。
例: ["acnt_example"]
取得または入力方法: アカウントはワークスペースメンバーから acnt_ UUID を取得し、チームは現在のワークスペースのチーム管理から group_ UUID を取得し、通知先は通知先一覧から notify_ UUID を取得します。
notifyTargets[*].to[*] string 対応するタイプの単一 UUID。メールアドレスをそのままアカウント UUID として扱わないでください。
例: acnt_example
取得または入力方法: アカウントはワークスペースメンバーから acnt_ UUID を取得し、チームは現在のワークスペースのチーム管理から group_ UUID を取得し、通知先は通知先一覧から notify_ UUID を取得します。
declaration.カスタムフィールド JSON カスタム宣言の内容。ルールのマッチングや認可を変更しません。
例: MAINT-EXAMPLE
取得または入力方法: 独自の業務に合わせてフィールド名と値を定義します。
crontabDuration int 繰り返しモードでは条件付き必須。0 より大きい必要があります。単発モードでは endTime を制御しません。
null 許容: False
例: 3600
取得または入力方法: 各ミュートウィンドウの継続時間を正の整数秒で指定します。例: 3600 は 1 時間です。
declaration json 任意のルールカスタム宣言オブジェクト。変更時に省略すると保持され、{} でクリアされます。単発ルールのレスポンスの content.declaration がこのフィールドであり、ワークスペースの共通宣言で上書きされることはありません。
null 許容: False
例: {"ticket": "MAINT-EXAMPLE"}
取得または入力方法: 呼び出し元が保持する必要のあるルール固有の説明または業務追跡識別子を入力します。
description string 任意の説明。512 文字以下を推奨します。変更時に省略すると保持され、空文字列でクリアされます。
空文字列許容: True
null 許容: False
例: 生产服务维护窗口。
取得または入力方法: メンテナンス理由と影響範囲を説明します。
endTime string 単発の終了時刻。作成時に省略または空文字列を指定すると end=-1 が保存され、終了を設定しないことを示します。変更時に省略すると保持されますが、空文字列を渡すと現在は内部エラーが返る可能性があります。単発ルールでは有限の終了時刻を明示的に指定することを推奨します。
空文字列許容: True
null 許容: False
例: 2026/11/20 10:00:00
取得または入力方法: 単発ルールでは実際の終了時刻を startTime より後に指定します。
filterString string 任意のイベント属性条件。宣言上の最大長は 2048 文字ですが、現在の保存容量はより短いため、1024 文字以下を推奨します。空でない場合は tags より優先されます。変更時に省略すると保持され、空文字列でクリアされます。
空文字列許容: True
null 許容: False
最大長: 2048
例: service:checkout-api
取得または入力方法: FilterString の構文に従って入力します。コンソールのイベントフィルターからコピーできます。
muteRanges array 完全な範囲配列。作成時に省略すると [] になります。変更時に省略した場合も元の範囲はクリアされます。各項目にはタイプに応じた UUID を設定します。custom 範囲、tags、filterString がすべて空の場合、ワークスペース全体のイベント通知をミュートする可能性があるため、送信前に実際の範囲を確認してください。
null 許容: False
例: []
取得または入力方法: 同じワークスペースのモニター/SLO、アラートポリシー、またはモニタータグ管理から対応する UUID を取得します。表示名を安定した識別子の代わりに使用しないでください。
name string ルール名。作成時と変更時は明示的に指定することを推奨します。省略した場合、作成時は範囲/タグ/条件に基づいて短い名前を生成できますが、変更時は元の名前が保持されます。
null 許容: False
例: 生产维护静默
取得または入力方法: 業務担当者がメンテナンスウィンドウに名前を付けます。64 文字以下を推奨します。
notifyMessage string 任意の通知本文。最大 3000 文字。作成時に notifyTargets のいずれかの項目に空でない to が含まれる場合、空でない内容を指定する必要があります。変更時は通知先と内容の完全性を自身で保証してください。
null 許容: False
最大長: 3000
例: 生产维护静默窗口已配置。
取得または入力方法: ミュートルールの通知内容を入力します。機密認証情報を含めないでください。
notifyTargets array 任意のルール設定通知先。ミュートルール自体の通知に作用し、ミュート対象のアラートの受信者ではありません。変更時は全体置換で、[] は削除、省略は保持を意味します。
null 許容: False
例: []
取得または入力方法: アカウントはワークスペースメンバーから acnt_ UUID を取得し、チームは現在のワークスペースのチーム管理から group_ UUID を取得し、通知先は通知先一覧から notify_ UUID を取得します。
notifyTimeStr string 任意の通知時刻。作成時に省略または空文字列を指定すると即時通知の意図として扱われ、変更時に省略すると保持され、空文字列を指定すると即時通知の意図に変更されます。実際の送信は有効な通知先、ルール状態、時刻に依存します。通知をキャンセルするスイッチではありません。繰り返しルールでは、開始時刻との差分に応じて各周期で通知できます。
空文字列許容: True
null 許容: False
例:
取得または入力方法: ルールの timezone に従って YYYY/MM/DD HH:MM:SS を入力します。
repeatCrontabSet object 繰り返しモードで条件付き必須の 5 段 Cron オブジェクト。単発モードでは省略します。公開宣言にオブジェクト型がないため、ドキュメントでは実際のオブジェクトとして説明します。フィールドが欠けると無効な Cron が組み立てられる可能性があります。
null 許容: False
例: {"min": "0", "hour": "9", "day": "*", "month": "*", "week": "1-5"}
取得または入力方法: 繰り返しモードではルールの timezone に従って開始周期を選択し、以下の 5 つの文字列フィールドを完全に送信します。
repeatCrontabSet.day string 繰り返し時にこのフィールドを文字列で送信します。月内日(1〜31 または *)。5 つの段は直接連結され、実行可能な時点が存在するか検証されます。
null 許容: False
例: *
取得または入力方法: Cron 構文に従って選択します。例: * はすべて、カンマ/範囲は複数の時点を表します。
repeatCrontabSet.hour string 繰り返し時にこのフィールドを文字列で送信します。時(0〜23)。5 つの段は直接連結され、実行可能な時点が存在するか検証されます。
null 許容: False
例: 9
取得または入力方法: Cron 構文に従って選択します。例: * はすべて、カンマ/範囲は複数の時点を表します。
repeatCrontabSet.min string 繰り返し時にこのフィールドを文字列で送信します。分(0〜59)。5 つの段は直接連結され、実行可能な時点が存在するか検証されます。
null 許容: False
例: 0
取得または入力方法: Cron 構文に従って選択します。例: * はすべて、カンマ/範囲は複数の時点を表します。
repeatCrontabSet.month string 繰り返し時にこのフィールドを文字列で送信します。月(1〜12 または *)。5 つの段は直接連結され、実行可能な時点が存在するか検証されます。
null 許容: False
例: *
取得または入力方法: Cron 構文に従って選択します。例: * はすべて、カンマ/範囲は複数の時点を表します。
repeatCrontabSet.week string 繰り返し時にこのフィールドを文字列で送信します。曜日。Cron の週フィールドまたは * に従います。5 つの段は直接連結され、実行可能な時点が存在するか検証されます。
null 許容: False
例: 1-5
取得または入力方法: Cron 構文に従って選択します。例: * はすべて、カンマ/範囲は複数の時点を表します。
repeatExpireTime string 繰り返しモードでは 0 または有効な期限日を明示的に指定する必要があります。省略または空文字列は永久繰り返しと同等ではありません。-1 は単発の内部マーカーです。繰り返しを作成する際に省略すると単発として処理される可能性があり、繰り返しを変更する際に省略すると内部エラーになる可能性があります。
空文字列許容: True
null 許容: False
例: 0
取得または入力方法: 永久周期には文字列 0 を指定します。有限周期には timezone における YYYY/MM/DD HH:MM:SS を指定し、開始時刻より後であることを確認してください。
repeatTimeSet int Y 必須の繰り返しモード。実際の保存は repeatExpire/crontab で表現され、レスポンスで repeatTimeSet が必ず返されるわけではありません。
null 許容: False
例: 0
取得または入力方法: 1 回のみは 0、周期繰り返しは 1 を指定します。この 2 つの規定値のみを使用してください。
startTime string 開始時刻(YYYY/MM/DD HH:MM:SS)。作成時に省略すると現在時刻を使用します。単発ルールの変更時に省略すると保持され、繰り返しに変更する場合は明示的に指定する必要があります。
null 許容: False
例: 2026/11/20 09:00:00
取得または入力方法: メンテナンスウィンドウの開始時刻と選択した timezone に従ってローカル時刻文字列を入力します。
tags json 任意のフィールド値条件。変更時に省略すると元の tags はクリアされます。空でない filterString は tags より優先されますが、muteRanges とは引き続き重ねて適用されます。
null 許容: False
例: {"env": ["production"]}
取得または入力方法: イベントの元のフィールド名と値(env、host、service など)から構成します。
timezone str Y 作成/変更時に必須のタイムゾーン。ローカル時刻の解析と Cron 実行を制御します。無効なタイムゾーンまたは時刻文字列は、一般的な内部エラーを返す可能性があります。
null 許容: False
例: Asia/Shanghai
取得または入力方法: IANA タイムゾーン(例: Asia/Shanghai、UTC)を使用します。時刻テキストはこのタイムゾーンで解釈されます。
type str Y 必須タイプ。custom はカスタムイベント範囲、checker はモニター/SLO、alertPolicy はアラートポリシー、tag はモニタータグです。履歴一覧には monitor が出現する可能性がありますが、現在の公開書き込みではこの列挙値を受け付けません。
null 許容: False
指定可能な値: ['checker', 'alertPolicy', 'tag', 'custom']
例: custom
取得または入力方法: ミュート範囲に応じて custom/checker/alertPolicy/tag を選択します。

パラメータ補足説明

データ説明.*

  • リクエストパラメータ説明
パラメータ名 type 説明
muteRanges list ミュート範囲。モニター、インテリジェントインスペクション、セルフホストインスペクション、SLO、アラートポリシーを含みます。
name str ルール名
description str 説明
tags dict タグ
filterString str イベント属性(式形式の入力)
notifyTargets list to: リストは通知先、type はその通知タイプ
repeatTimeSet int ミュートを繰り返すかどうか。1 は繰り返しミュートの有効化、0 は 1 回のみを表します。
repeatCrontabSet dict 繰り返しミュートルールの時刻設定
crontabDuration int このスケジュールタスク開始後のミュート継続時間を表します。
notifyTargets list to: リストは通知先、type はその通知タイプ
notifyTimeStr str 通知時刻、%Y/%m/%d %H:%M:%S
startTime str ミュート開始時刻 %Y/%m/%d %H:%M:%S
endTime str ミュート終了時刻 %Y/%m/%d %H:%M:%S
repeatExpireTime str 繰り返しミュートの有効期限 %Y/%m/%d %H:%M:%S
timezone str 対応するタスクのタイムゾーン。デフォルトは Asia/Shanghai
type str 対応するミュートルールタイプ checker:monitor:tag:custom
repeatExpire int 繰り返しミュートの有効期限(2023-08-24 廃止)
start int ミュート開始時刻(2023-08-24 廃止)
end int ミュート終了時刻(2023-08-24 廃止)
notifyTime int 通知時刻。時点に対応する秒単位のタイムスタンプ。-1 は即時通知を表します(2023-08-24 廃止)
declaration dict カスタム宣言情報

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/monitor/mute/mute_example/modify' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"生产维护静默","description":"生产服务维护窗口。","type":"custom","muteRanges":[],"tags":{},"filterString":"service:checkout-api","notifyTargets":[],"repeatTimeSet":0,"timezone":"Asia/Shanghai","startTime":"2026/11/20 09:00:00","endTime":"2026/11/20 10:00:00"}'

レスポンス

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

フィールド タイプ 説明
content object 保存後の完全なルールエンティティと整形された時刻。既存ルールの declaration があり、共通宣言は追加挿入されません。
content.id integer ルールレコード番号。操作には uuid を使用します。
content.uuid string mute_ ルール UUID。
content.workspaceUUID string 所属ワークスペース。
content.name string ルール名。
content.description string 説明。
content.type string custom/checker/alertPolicy/tag。履歴レコードでは monitor が出現する場合もあります。
content.tags object 保存されたフィールド値条件。
content.tags.フィールド JSON 対応するイベントフィールドのマッチング値。
content.filterString string イベント属性条件。空でない場合は tags より優先されます。
content.muteRanges array<object> 保存された範囲配列。各 UUID の意味はリクエストパラメータを参照してください。
content.muteRanges[].checkerUUID string または array モニター識別子。履歴レコードでは配列の場合があります。
content.muteRanges[].sloUUID string または array SLO 識別子。履歴レコードでは配列の場合があります。
content.muteRanges[].alertPolicyUUID string アラートポリシー UUID。
content.muteRanges[].tagUUID string または array モニタータグ UUID。
content.muteRanges[].name string 表示名。省略可能です。
content.muteRanges[].type string 表示タイプ。省略可能です。
content.notifyTargets array<object> ミュートルールの通知先。
content.notifyTargets[].type string mail/notifyObject/memberGroup。
content.notifyTargets[].to array<string> 対応するタイプの UUID 配列。
content.notifyTargets[].to[] string 単一の通知先 UUID。
content.notifyMessage string ミュートルールの通知本文。
content.notifyTime integer 通知時刻の Unix 秒。-1 は即時通知の意図を表し、実際に送信するかはタスクが判断します。
content.notifyTimeStr string timezone に従って整形された通知時刻。即時通知の意図の場合は空文字列です。
content.start integer 開始 Unix 秒。
content.end integer 単発の終了 Unix 秒。-1 は終了なしです。
content.startTime string timezone における YYYY/MM/DD HH:MM:SS。
content.endTime string 同じ形式の終了時刻。end=-1 の場合は空文字列です。
content.repeatExpire integer -1 は単発、0 は永久繰り返し、正の値は周期の期限 Unix 秒です。
content.repeatExpireTime string -1/0、または timezone における整形済み期限時刻。
content.crontab string 繰り返し時の 5 段 Cron 文字列。単発では通常空です。
content.crontabDuration integer 各繰り返しウィンドウの継続秒数。
content.cycleNotifyAt integer 直近の周期設定通知時刻の Unix 秒。未通知の場合は -1 です。
content.timezone string ルールのタイムゾーン。
content.declaration object ルールのカスタム宣言。このワークスペースの共通宣言ではありません。
content.declaration.カスタムフィールド JSON 呼び出し元が保存したカスタム値。
content.muteIncident boolean インシデント通知も同時にミュートするかどうか。現在の OpenAPI ではこの書き込みパラメータを宣言していません。作成時のデフォルトは false で、既存ルールではコンソール設定が反映される場合があります。alertPolicy 範囲ではこのインシデントマッチングをサポートしていません。
content.status integer 0 は有効、2 は無効、3 は削除。有効は現在の時間帯で既に適用されていることを意味しません。
content.creator string 作成者。
content.updator string 更新者。
content.createAt integer 作成時刻の Unix 秒。
content.updateAt integer 更新時刻の Unix 秒。初期値は -1。
content.deleteAt integer 削除時刻の Unix 秒。未削除の場合は -1。
{
  "code": 200,
  "content": {
    "id": 42,
    "uuid": "mute_example",
    "workspaceUUID": "wksp_example",
    "name": "生产维护静默",
    "description": "生产服务维护窗口。",
    "type": "custom",
    "tags": {},
    "filterString": "service:checkout-api",
    "muteRanges": [],
    "notifyTargets": [],
    "notifyMessage": "",
    "notifyTime": -1,
    "start": 1795136400,
    "end": 1795140000,
    "repeatExpire": -1,
    "cycleNotifyAt": -1,
    "crontab": "",
    "crontabDuration": 0,
    "declaration": {},
    "muteIncident": false,
    "timezone": "Asia/Shanghai",
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785430800,
    "updateAt": -1,
    "deleteAt": -1,
    "startTime": "2026/11/20 09:00:00",
    "endTime": "2026/11/20 10:00:00",
    "notifyTimeStr": "",
    "repeatExpireTime": "-1"
  },
  "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 オブジェクトを送信してください。
400 ft.muteStartEndError 単発の終了が開始より後でない、または繰り返しの crontabDuration が 0 以下です ミュート開始時刻はミュート終了時刻より前である必要があります 順序を調整し、繰り返しウィンドウには正の秒数を指定してください。
406 ft.InvalidCrontabFormat Cron を解析できない、実行可能な時点がない、またはタイムゾーンによりスケジュールチェックが失敗しました 無効な crontab 形式 5 つの Cron 文字列フィールドと正しい timezone を完全に送信してください。
400 ft.ErrorFilterString イベント属性条件を解析できません filterString の解析に失敗しました: {} コンソールで生成した有効な FilterString を使用するか、例に従って修正してください。
406 ft.ExceedTimestampLimit ミュート開始/終了/繰り返し期限の Unix 秒が 2147483647 を超えています 時刻が 2038-01-19 の制限を超えています これらの時刻を 2038-01-19 の上限より前に制限してください。ミリ秒を秒として扱わないでください。
500 ft.InternalServerError 繰り返しモードの必須フィールドが欠落している、時刻/タイムゾーン形式が誤っている、配列要素の形状が誤っている、または保存/タスク処理に失敗しました 内部エラー 単発/繰り返しの完全な条件を自己確認してください。まず保存済みルールを確認してから再試行を判断し、継続的に失敗する場合は traceId を提供してください。
404 ft.NotFound 指定されたルールが存在しない、削除済み、または現在のワークスペースに属していません 業務ルートが見つかりません 現在のワークスペースの一覧から有効な UUID を再選択してください。

フィードバック

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