修正¶
POST /api/v1/monitor/mute/{obj_uuid}/modify
概要¶
ミュートルールを修正します。
ルートパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| obj_uuid | string | Y | ミュート設定の ID |
Body リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | ルール名 例: 名称 A 空の許可: False |
|
| description | string | 説明 例: 説明 A 空の許可: False 空文字列の許可: True |
|
| tags | json | タグセット 空の許可: False |
|
| filterString | string | イベント属性 空の許可: False 空文字列の許可: True 最大長: 2048 |
|
| muteRanges | array | ミュート範囲 例: モニター A 空の許可: False |
|
| 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、ミュート時間が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 例: 空の許可: False 空文字列の許可: True |
|
| timezone | str | Y | ミュートルールのタイムゾーン 例: Asia/Shanghai 空の許可: False |
| type | str | Y | ミュートルールのタイプ 例: custom 空の許可: False 選択可能な値: ['checker', 'alertPolicy', 'tag', 'custom'] |
| declaration | json | カスタム宣言情報 空の許可: False |
パラメータ補足説明¶
データ説明.*
- リクエストパラメータ説明
| パラメータ名 | 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 'https://openapi.guance.com/api/v1/monitor/mute/<obj_uuid>/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"nameA","description":"descA","startTime":"2023/08/22 16:27:27","notifyTargets":[{"to":["notify_xxxx32"],"type":"notifyObject"}],"tags":{},"muteRanges":[{"name":"multi{{version}}","checkerUUID":"rul_xxxx32","type":"checker"}],"type":"checker","timezone":"Asia/Shanghai","repeatTimeSet":1,"repeatCrontabSet":{"min":"0","hour":"1","day":"*","month":"*","week":"0,5,6,4"},"crontabDuration":10800,"repeatExpireTime":"2023/09/09 00:00:00","notifyTimeStr":"","notifyMessage":"nofity message"}' \
--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": "nofity message",
"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"
}