作成¶

POST /api/v1/monitor/mute/create

概要¶

ミュートルールを作成します。

Body リクエストパラメータ¶

パラメータ名	型	必須	説明
muteRanges	array		ミュート範囲空を許可: False
name	string		ルール名例: 名称 A 空を許可: False
description	string		説明例: 説明 A 空を許可: False 空文字列を許可: True
tags	json		タグセット空を許可: False
filterString	string		イベント属性空を許可: False 空文字列を許可: True 最大長: 2048
notifyTargets	array		通知先空を許可: False
notifyMessage	string		通知メッセージ空を許可: False 最大長: 3000
notifyTimeStr	string		通知時間, %Y/%m/%d %H:%M:%S 例: 2023/08/21 19:19:00 空を許可: False 空文字列を許可: True
startTime	string		開始時間 %Y/%m/%d %H:%M:%S 例: 2023/08/21 19:19:00 空を許可: False
endTime	string		終了時間 %Y/%m/%d %H:%M:%S 例: 2023/08/21 19:19:00 空を許可: False 空文字列を許可: True
repeatTimeSet	int	Y	繰り返し設定の場合は 1, 単発ミュートの場合は 0 例: 0 空を許可: False
repeatCrontabSet	None		繰り返しの crontab 設定空を許可: False
repeatCrontabSet.min	string		分例: 10 空を許可: False
repeatCrontabSet.hour	string		時例: 10 空を許可: False
repeatCrontabSet.day	string		日例: * 空を許可: False
repeatCrontabSet.month	string		月例: * 空を許可: False
repeatCrontabSet.week	string		週例: 1,3 空を許可: False
crontabDuration	int		終了時間から開始時間を引いた値, 正の整数, 単位は秒例: 3600 空を許可: False
repeatExpireTime	string		繰り返しの終了時間 %Y/%m/%d %H:%M:%S 例: 0 空を許可: False 空文字列を許可: True
timezone	str	Y	ミュートルールのタイムゾーン例: Asia/Shanghai 空を許可: False
type	str	Y	ミュートルールのタイプ例: custom 空を許可: False 選択可能な値: ['checker', 'alertPolicy', 'tag', 'custom']
declaration	json		カスタム宣言情報空を許可: False

パラメータ補足説明¶

データ説明.*

1. リクエストパラメータ説明

パラメータ名	type	説明
type	string	ミュートルールのタイプに対応: モニター:checker, アラートポリシー:monitor, モニタータグ:tag, カスタム:custom
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	0 は永久に繰り返し: 繰り返しミュートの有効期限 %Y/%m/%d %H:%M:%S
timezone	str	タスクのタイムゾーン, デフォルトは Asia/Shanghai
repeatExpire	int	繰り返しミュートの有効期限（2023-08-24 に廃止）
start	int	ミュート開始時間（2023-08-24 に廃止）
end	int	ミュート終了時間（2023-08-24 に廃止）｜
notifyTime	int	通知時間, 時間点に対応する秒単位のタイムスタンプ, -1 は即時通知（2023-08-24 に廃止）
declaration	dict	カスタム宣言情報
--------------

2. ミュート範囲説明

パラメータ名	type	必須	説明
type	string	Y	ミュートルールのタイプに対応: モニター:checker, アラートポリシー:monitor, モニタータグ:tag, カスタム:custom
muteRanges	list	Y	ミュート範囲, [] はすべてを選択
tags	dict	Y	詳細設定, イベント属性
filterString	str	イベント属性（式形式のパラメータ）

tags 設定は除外選択（反転選択）をサポートします。例:

{
    "tags": {
        "-host": [
            "cn-hangzhou"
        ]
    },
    "muteRanges": [],
    "type": "checker"
}

type が checker（モニタータイプ）の場合の例:

{
    "tags": {
        "host": [
            "cn-hangzhou"
        ]
    },
    "muteRanges": [
        {
            "name": "インフラストラクチャ死活監視 - タイプ ReplicaSet - {{Result}}",
            "checkerUUID": "rul_xxxx22",
        },
        {
            "name": "hhh",
            "checkerUUID": "rul_xxxx21",
        }
    ],
    "type": "checker"
}

type が alertPolicy（アラートポリシータイプ）の場合の例:

{
    "tags": {
        "host": [
            "cn-hangzhou"
        ]
    },
    "muteRanges": [
        {
            "name": "gary-test1234",
            "alertPolicyUUID": "altpl_xxxx26",
        }
    ],
    "type": "alertPolicy",
}

type が tag（モニタータグ）の場合の例:

{
    "tags": {
        "service": [
            "kodo.nsq.consumer"
        ]
    },
    "muteRanges": [
        {
            "name": "zyl_test",
            "tagUUID": "tag_xxxx23",
        },
        {
            "name": "0306",
            "tagUUID": "tag_xxxx28",
        }
    ],
    "type": "tag"
}

type が custom（カスタムタイプ）の場合の例:

name="__codelineno-4-1">{ "tags": { "service": [ "kodo.nsq.consumer" ] }, "muteRanges": [ { "name": "モニター最適化検証-更新2", "checkerUUID": "rul_xxxx22", }, { "name": "0306", "tagUUID": "tag_xxxx25", }, { "name": "slo_test", "sloUUID": "monitor_xxxx25", } ], "type": "custom", }

filterString は新しいバージョンのイベント属性であり、構文はビューアの構文に従います。現在のインターフェースは tags（旧バージョンのイベント属性）も互換しており、filterString の値が優先されます。例:

{
    "filterString": "df_status:ok OR host:web001",
    "muteRanges": [],
    "type": "checker"
}

3. ミュート時間説明

ミュート時間は、単発ミュートと繰り返しミュートに分けられます。

単発ミュートのパラメータ設定:

パラメータ名	type	説明
repeatTimeSet	int	繰り返しミュートの有無, 1 は繰り返しミュート有効, 0 は 1 回のみ
startTime	str	ミュート開始時間 %Y/%m/%d %H:%M:%S
endTime	str	ミュート終了時間 %Y/%m/%d %H:%M:%S
timezone	str	タスクのタイムゾーン, デフォルトは Asia/Shanghai

repeatTimeSet が 0（単発ミュート）の場合の例:

{
    "startTime": "2024/03/27 14:06:57",
    "endTime": "2024/03/27 15:06:57",
    "timezone": "Asia/Shanghai",
    "repeatTimeSet": 0
}

繰り返しミュートのパラメータ設定:

パラメータ名	type	説明
repeatTimeSet	int	繰り返しミュートの有無, 1 は繰り返しミュート有効, 0 は 1 回のみ
repeatCrontabSet	dict	繰り返しミュートルールの時間設定。開始 Crontab の設定に使用（Crontab 構文）
crontabDuration	int	このスケジュールタスク開始後のミュート持続時間、単位は秒
repeatExpireTime	str	0 は永久に繰り返し: 繰り返しミュートの有効期限 %Y/%m/%d %H:%M:%S
timezone	str	タスクのタイムゾーン, デフォルトは Asia/Shanghai

repeatTimeSet が 1（繰り返しミュート）の場合の例:

{
    "timezone": "Asia/Shanghai",
    "repeatTimeSet": 1,
    "repeatCrontabSet": {
        "min": "0",
        "hour": "0",
        "day": "*",
        "month": "*",
        "week": "1,2"
    },
    "crontabDuration": 18000,
    "repeatExpireTime": "0"
}

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/monitor/mute/create' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  --data-raw '{"name":"nameA","description":"descA","startTime":"2023/08/23 14:00:07","endTime":"2023/08/23 14:31:07","notifyTargets":[{"to":["acnt_xxxx32"],"type":"mail"}],"tags":{},"muteRanges":[{"name":"The Memory usage rate of the Aerospike cluster [{{cluster_name}}] space [{{ns}}] is too high","checkerUUID":"rul_xxxx32","type":"checker"}],"type":"checker","timezone":"Asia/Shanghai","notifyMessage":"cjkackcnkjcklasc","notifyTimeStr":"2023/08/23 13:45:07","repeatTimeSet":0}' \
  --compressed \
  --insecure

レスポンス¶

{
    "code": 200,
    "content": {
        "createAt": 1692771116,
        "creator": "acnt_xxxx32",
        "crontab": "",
        "crontabDuration": 0,
        "deleteAt": -1,
        "description": "descA",
        "end": 1692772267,
        "endTime": "2023/08/23 14:31:07",
        "id": 643,
        "muteRanges": [
            {
                "checkerUUID": "rul_xxxx32",
                "name": "The Memory usage rate of the Aerospike cluster [{{cluster_name}}] space [{{ns}}] is too high",
                "type": "checker"
            }
        ],
        "name": "nameA",
        "notifyMessage": "cjkackcnkjcklasc",
        "notifyTargets": [
            {
                "to": [
                    "acnt_xxxx32"
                ],
                "type": "mail"
            }
        ],
        "notifyTime": 1692769507,
        "notifyTimeStr": "2023/08/23 13:45:07",
        "repeatExpire": -1,
        "repeatExpireTime": "-1",
        "start": 1692770407,
        "startTime": "2023/08/23 14:00:07",
        "status": 0,
        "tags": {},
        "timezone": "Asia/Shanghai",
        "type": "checker",
        "updateAt": 1692771117,
        "updator": "acnt_xxxx32",
        "uuid": "mute_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-C5BE0235-BB41-437E-801E-F925E98F8616"
}

作成¶

概要¶

Body リクエストパラメータ¶

パラメータ補足説明¶

リクエスト例¶

レスポンス¶

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

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