Skip to content

Get Mute Rule List



GET /api/v1/monitor/mute/list

Overview

Retrieve a paginated list of mute rules

Query Request Parameters

Parameter Name Type Required Description
search string No Search rule name
Can be empty: False
workStatus commaArray No Filter parameter, status connected by commas (,), pending activation: pending_activation, active: active, expired: expired
Can be empty: False
isEnable commaArray No Filter parameter, 1 for enabled, 0 for disabled
Can be empty: False
type commaArray No Filter parameter, custom/checker/alertPolicy/tag, multiple parameters connected by commas (,)
Can be empty: False
updator commaArray No Filter parameter, UUID of the updater, connected by commas (,)
Can be empty: False
creator commaArray No Filter parameter, UUID of the creator, connected by commas (,)
Can be empty: False
pageIndex integer Yes Page number
Can be empty: False
Example: 1
$minValue: 1
pageSize integer Yes Number of items per page
Can be empty: False
Example: 10
$minValue: 1
$maxValue: 100

Additional Parameter Notes

Request Example

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

Response

{
    "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"
} 

Feedback

Is this page helpful? ×