コンテンツにスキップ

一覧¶

GET /api/v1/monitor/mute/list

概要¶

ミュートルール一覧をページネーションで取得します。

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

パラメータ名	型	必須	説明
search	string	いいえ	ルール名で検索空の値を許可: False
workStatus	commaArray	いいえ	フィルタパラメータ。ステータスはカンマ（,）で連結します。保留中: pending_activation, 実行中: active, 期限切れ: expired 空の値を許可: False
isEnable	commaArray	いいえ	フィルタパラメータ。1 は有効の表示、0 は無効の表示を意味します。空の値を許可: False
type	commaArray	いいえ	フィルタパラメータ。custom/checker/alertPolicy/tag。複数のパラメータはカンマ（,）で連結します。空の値を許可: False
updator	commaArray	いいえ	フィルタパラメータ。更新者の UUID。カンマ（,）で連結します。空の値を許可: False
creator	commaArray	いいえ	フィルタパラメータ。作成者の UUID。カンマ（,）で連結します。空の値を許可: False
pageIndex	integer	いいえ	ページ番号空の値を許可: False 例: 1 $minValue: 1
pageSize	integer	いいえ	1ページあたりの返却件数空の値を許可: False 例: 10 $minValue: 1 $maxValue: 100

パラメータ補足説明¶

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/monitor/mute/list?pageIndex=1&pageSize=2' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": [
        {
            "createAt": 1642572752,
            "creator": "wsak_xxxxx",
            "creatorInfo": {
                "uuid": "xx",
                "status": 0,
                "username": "xx",
                "name": "xx",
                "iconUrl": "",
                "email": "xx",
                "acntWsNickname": "xx"
            },
            "deleteAt": -1,
            "end": 1642576351,
            "id": 383,
            "notifyMessage": "",
            "notifyTargets": [],
            "notifyTime": -1,
            "start": 1642572751,
            "status": 0,
            "tags": [
                {
                    "host": "testname"
                }
            ],
            "type": "host",
            "updateAt": 1642572752,
            "updator": "wsak_xxxxx",
            "updatorInfo": {
                "uuid": "xx",
                "status": 0,
                "username": "xx",
                "name": "xx",
                "iconUrl": "",
                "email": "xx",
                "acntWsNickname": "xx"
            },
            "uuid": "mute_xxx890",
            "workspaceUUID": "wksp_xxx4af"
        }
    ],
    "errorCode": "",
    "message": "",
    "pageInfo": {
        "count": 1,
        "pageIndex": 1,
        "pageSize": 2,
        "totalCount": 1
    },
    "success": true,
    "traceId": "TRACE-AB73EEDD-3873-4EBD-A424-722022770AD5"
}