コンテンツにスキップ

一覧取得



GET /api/v1/monitor/mute/list

概要

現在のワークスペースのミュートルールと、その範囲、時間、通知設定、派生ステータスを照会します。

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

まず type/isEnable とメンテナンス範囲で絞り込み、その後ページ単位で読み取ります。一覧は更新時間と作成時間の降順です。削除済みレコードは返されませんが、無効化済みおよび期限切れのルールも引き続き照会できます。

一覧の workStatus は派生表示です。単一ルールでは start <= 現在 < end の場合のみ active とマークされます。現在のアルゴリズムでは、end=-1 の終了なし単一ルールが誤って expired とマークされますが、実行側では引き続き使用できます。繰り返しルールの表示でも全体の start を先に制限していないため、将来開始するルールが早期に active と表示される可能性があります。status、完全な時間、実際の通知ミュートを併せて確認してください。

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

返される start/end/repeatExpire は Unix 秒です。startTime/endTime/repeatExpireTime は各ルールの timezone に従って表示されます。繰り返し設定は repeatCrontabSet から読み取れます。結果がない場合は data=[] が返されます。

リクエストヘッダー

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

Query リクエストパラメータ

パラメータ名 型 必須 説明
creator commaArray 作成者 ID の UUID(任意)。複数指定する場合はカンマで区切ります。
null を許可: False
例: wsak_example
取得・入力方法: 既存一覧の creator またはメンバーアカウント UUID から実際の ID を取得します。
isEnable commaArray 有効/無効フィルター(任意)。省略した場合は有効および無効のルールを含みます。
null を許可: False
例: 1
取得・入力方法: 1 は有効、0 は無効です。カンマ区切りで同時に指定できます。
pageIndex integer ページ番号(任意)。最小値は 1、デフォルトは 1 です。
null を許可: False
$minValue: 1
例: 1
取得・入力方法: 1 からページ単位で読み取ります。
pageSize integer 1 ページあたりの件数(任意)。デフォルトは 50 です。
null を許可: False
$maxValue: 100
$minValue: 1
例: 50
取得・入力方法: クライアントのページング容量に応じて 1~100 を選択します。
search string キーワード(任意)。省略した場合はキーワードで絞り込みません。
null を許可: False
例: 维护
取得・入力方法: ルール名に含まれる文字列で検索します。説明や UUID は検索対象外です。
type commaArray 型フィルター(任意)。複数指定する場合はカンマで区切ります。履歴上の型には monitor が含まれる場合があります。
null を許可: False
例: custom
取得・入力方法: ミュート範囲に応じて custom/checker/alertPolicy/tag を選択します。
updator commaArray 最終更新者 ID の UUID(任意)。複数指定する場合はカンマで区切ります。
null を許可: False
例: wsak_example
取得・入力方法: 既存一覧の updator またはメンバーアカウント UUID から実際の ID を取得します。
workStatus commaArray 派生ステータスフィルター(任意)。複数指定した場合は和集合となり、省略した場合はすべてを含みます。表示上の制限は使用手順を参照してください。
null を許可: False
例: pending_activation,active
取得・入力方法: pending_activation/active/expired から選択し、カンマで区切ります。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/monitor/mute/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=50 \
  --data-urlencode type=custom

レスポンス

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

フィールド 型 説明
content object ページングコンテンツ。pageInfo はレスポンスのトップレベルにあります。
content.data array<object> 条件に一致するミュートルール。結果が空の場合は [] です。
content.data[].id integer ルールレコード番号。操作には uuid を使用します。
content.data[].uuid string mute_ ルール UUID。
content.data[].workspaceUUID string 所属ワークスペース。
content.data[].name string ルール名。
content.data[].description string 説明。
content.data[].type string custom/checker/alertPolicy/tag。履歴レコードでは monitor が出現する場合があります。
content.data[].tags object 保存されたフィールド値条件。
content.data[].tags.字段 JSON 対応するイベントフィールドの一致値。
content.data[].filterString string イベント属性条件。空でない場合は tags より優先されます。
content.data[].muteRanges array<object> 保存された範囲配列。各 UUID の意味はリクエストパラメータを参照してください。
content.data[].muteRanges[].checkerUUID string または array モニター識別子。履歴レコードでは配列の場合があります。
content.data[].muteRanges[].sloUUID string または array SLO 識別子。履歴レコードでは配列の場合があります。
content.data[].muteRanges[].alertPolicyUUID string アラートポリシー UUID。
content.data[].muteRanges[].tagUUID string または array モニタータグ UUID。
content.data[].muteRanges[].name string 表示名。省略可能です。
content.data[].muteRanges[].type string 表示型。省略可能です。
content.data[].notifyTargets array<object> ミュートルールの通知先。
content.data[].notifyTargets[].type string mail/notifyObject/memberGroup。
content.data[].notifyTargets[].to array<string> 対応する型の UUID 配列。
content.data[].notifyTargets[].to[] string 単一の通知先 UUID。
content.data[].notifyMessage string ミュートルールの通知本文。
content.data[].notifyTime integer 通知時刻の Unix 秒。-1 は即時送信の意図を表し、実際に送信するかはタスクが判断します。
content.data[].notifyTimeStr string timezone に従って通知時刻をフォーマットしたもの。即時送信の意図の場合は空文字列です。
content.data[].start integer 開始 Unix 秒。
content.data[].end integer 単一実行の終了 Unix 秒。-1 は終了なし。
content.data[].startTime string timezone における YYYY/MM/DD HH:MM:SS。
content.data[].endTime string 同じ形式の終了時刻。end=-1 の場合は空文字列です。
content.data[].repeatExpire integer -1 は単一、0 は永久繰り返し、正の値は周期の期限 Unix 秒。
content.data[].repeatExpireTime string -1/0、または timezone におけるフォーマット済み期限時刻。
content.data[].crontab string 繰り返し時の 5 フィールドの Cron 文字列。単一の場合は通常空です。
content.data[].crontabDuration integer 各繰り返しウィンドウの継続秒数。
content.data[].cycleNotifyAt integer 直近の周期設定通知時刻の Unix 秒。まだ通知していない場合は -1。
content.data[].timezone string ルールのタイムゾーン。
content.data[].declaration object ルールのカスタム宣言。このワークスペースの共通宣言ではありません。
content.data[].declaration.自定义字段 JSON 呼び出し元が保存したカスタム値。
content.data[].muteIncident boolean インシデント通知も同時にミュートするかどうか。現在の OpenAPI ではこの書き込みパラメータは宣言されていません。作成時のデフォルトは false で、既存ルールはコンソール設定を反映する場合があります。alertPolicy 範囲ではこのインシデント一致はサポートされません。
content.data[].status integer 0 は有効、2 は無効、3 は削除。有効は現在の期間にすでに適用されていることを意味しません。
content.data[].creator string 作成者 ID。
content.data[].updator string 最終更新者 ID。
content.data[].createAt integer 作成時間 Unix 秒。
content.data[].updateAt integer 更新時間 Unix 秒。初期値は -1。
content.data[].deleteAt integer 削除時間 Unix 秒。未削除の場合は -1。
content.data[].repeatCrontabSet object 一覧および繰り返しルール作成時に提供される Cron 逆解析オブジェクト。変更レスポンスでは必ずしも提供されません。
content.data[].repeatCrontabSet.min string 対応する Cron セグメント。
content.data[].repeatCrontabSet.hour string 対応する Cron セグメント。
content.data[].repeatCrontabSet.day string 対応する Cron セグメント。
content.data[].repeatCrontabSet.month string 対応する Cron セグメント。
content.data[].repeatCrontabSet.week string 対応する Cron セグメント。
content.data[].workStatus string pending_activation/active/expired。派生表示であり、使用手順に記載の边界条件があります。
content.data[].creatorInfo object 固定の 5 つの表示キー。一致する ID がない場合、name/username は null、それ以外は空文字列です。
content.data[].creatorInfo.name string または null 表示名。
content.data[].creatorInfo.username string または null ログイン名。
content.data[].creatorInfo.acntWsNickname string または null ワークスペースのニックネーム。
content.data[].creatorInfo.email string または null メールアドレスまたはシステム ID。
content.data[].creatorInfo.iconUrl string または null アバター URL。
content.data[].updatorInfo object 固定の 5 つの表示キー。一致する ID がない場合、name/username は null、それ以外は空文字列です。
content.data[].updatorInfo.name string または null 表示名。
content.data[].updatorInfo.username string または null ログイン名。
content.data[].updatorInfo.acntWsNickname string または null ワークスペースのニックネーム。
content.data[].updatorInfo.email string または null メールアドレスまたはシステム ID。
content.data[].updatorInfo.iconUrl string または null アバター URL。
content.allCreatorInfo array<object> 全ワークスペースの未削除ルールに関連する ID 候補。現在のフィルターやページングによって縮小されません。
content.allCreatorInfo[].uuid string アカウント UUID。省略可能です。
content.allCreatorInfo[].status integer アカウントステータス。
content.allCreatorInfo[].wsAccountStatus integer ワークスペースアカウントステータス。
content.allCreatorInfo[].username string ログイン名。
content.allCreatorInfo[].name string 表示名。
content.allCreatorInfo[].iconUrl string アバター URL。省略可能です。
content.allCreatorInfo[].email string メールアドレスまたはシステム ID 名。
content.allCreatorInfo[].mobile string 携帯電話番号。空の場合があります。
content.allCreatorInfo[].countryCode string 国・地域コード。省略可能です。
content.allCreatorInfo[].acntWsNickname string ワークスペースのニックネーム。省略可能です。
content.allUpdatorInfo array<object> 全ワークスペースの未削除ルールに関連する ID 候補。現在のフィルターやページングによって縮小されません。
content.allUpdatorInfo[].uuid string アカウント UUID。省略可能です。
content.allUpdatorInfo[].status integer アカウントステータス。
content.allUpdatorInfo[].wsAccountStatus integer ワークスペースアカウントステータス。
content.allUpdatorInfo[].username string ログイン名。
content.allUpdatorInfo[].name string 表示名。
content.allUpdatorInfo[].iconUrl string アバター URL。省略可能です。
content.allUpdatorInfo[].email string メールアドレスまたはシステム ID 名。
content.allUpdatorInfo[].mobile string 携帯電話番号。空の場合があります。
content.allUpdatorInfo[].countryCode string 国・地域コード。省略可能です。
content.allUpdatorInfo[].acntWsNickname string ワークスペースのニックネーム。省略可能です。
content.declaration object ワークスペースの共通宣言。空のオブジェクトの場合があります。
pageInfo object ページング情報。
pageInfo.pageIndex integer 現在のページ番号。
pageInfo.pageSize integer 1 ページあたりの件数。
pageInfo.count integer 現在のページの実際の件数。
pageInfo.totalCount integer フィルター条件に一致する総件数。
{
  "code": 200,
  "content": {
    "data": [
      {
        "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",
        "workStatus": "pending_activation",
        "creatorInfo": {
          "name": null,
          "username": null,
          "acntWsNickname": "",
          "email": "",
          "iconUrl": ""
        },
        "updatorInfo": {
          "name": null,
          "username": null,
          "acntWsNickname": "",
          "email": "",
          "iconUrl": ""
        }
      }
    ],
    "allCreatorInfo": [],
    "allUpdatorInfo": [],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 50,
    "count": 1,
    "totalCount": 1
  }
}

エラーレスポンス

認証、レート制限、共通リクエストのエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 未宣言の Query パラメータを使用した、またはパラメータがルールに違反している パラメータ解析に失敗 Query パラメータ表および例を確認してください。
500 ft.InternalServerError 読み取り、時刻フォーマット、または ID 情報の処理に失敗 内部エラー フィルターを絞り込み、失敗が続く場合は traceId を提供してください。

フィードバック

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