一覧¶
GET /api/v1/checker/list
概要¶
モニターの一覧をページネーションで取得します。
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| type | string | モニターを一覧表示します。インテリジェントモニタリングを一覧表示する場合は smartMonitor を指定します。空を許可: False 空文字列を許可: False 有効な値: ['smartMonitor'] |
|
| alertPolicyUUID | commaArray | アラートポリシーの UUID 空を許可: False |
|
| checkerStatus | commaArray | モニターのステータス。0 は有効、2 は無効を表します（デフォルトでは有効/無効 0,2 を検索します）。 例: 0 空を許可: False |
|
| tagsUUID | commaArray | タグの UUID 空を許可: False |
|
| checkerUUID | commaArray | チェック項目の UUID リスト 空を許可: False |
|
| sloUUID | string | SLO の UUID 空を許可: False |
|
| search | string | ルール名で検索します。 空を許可: False |
|
| pageIndex | integer | ページ番号 空を許可: False 例: 1 $minValue: 1 |
|
| pageSize | integer | 1ページあたりの返却数 空を許可: False 例: 10 $minValue: 1 $maxValue: 100 |
パラメータ補足説明¶
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/checker/list?pageIndex=1&pageSize=2' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed
レスポンス¶
{
"code": 200,
"content": [
{
"createAt": 1642412816,
"creator": "acnt_xxxx32",
"crontabInfo": {
"crontab": "*/1 * * * *",
"id": "cron-h0vvCCHAQMij"
},
"deleteAt": -1,
"extend": {
"funcName": "",
"noDataInterval": null,
"querylist": [
{
"datasource": "dataflux",
"qtype": "dql",
"query": {
"alias": "",
"code": "Result",
"dataSource": "aliyun_acs_rds_dashboard",
"field": "DiskUsage_Average",
"fieldFunc": "last",
"fieldType": "float",
"funcList": [],
"groupBy": [
"instanceId"
],
"groupByTime": "",
"namespace": "metric",
"q": "M::`aliyun_acs_rds_dashboard`:(LAST(`DiskUsage_Average`)) BY `instanceId`",
"type": "simple"
},
"uuid": "4bea6e00-317f-4cb8-9c3b-64bc3fd70d73"
}
],
"recoverNeedPeriodCount": 1,
"rules": [
{
"conditionLogic": "and",
"conditions": [
{
"alias": "Result",
"operands": [
"90"
],
"operator": ">="
}
],
"status": "critical"
},
{
"conditionLogic": "and",
"conditions": [
{
"alias": "Result",
"operands": [
"80",
"90"
],
"operator": "between"
}
],
"status": "error"
},
{
"conditionLogic": "and",
"conditions": [
{
"alias": "Result",
"operands": [],
"operator": ">="
}
],
"status": "warning"
}
]
},
"id": 4216,
"isSLI": false,
"jsonScript": {
"checkerOpt": {
"rules": [
{
"conditionLogic": "and",
"conditions": [
{
"alias": "Result",
"operands": [
"90"
],
"operator": ">="
}
],
"status": "critical"
},
{
"conditionLogic": "and",
"conditions": [
{
"alias": "Result",
"operands": [
"80",
"90"
],
"operator": "between"
}
],
"status": "error"
}
]
},
"every": "1m",
"groupBy": [
"instanceId"
],
"interval": 300,
"message": ">Level：{{df_status}} \n>Instance：{{instanceId}} \n>Content：RDS Mysql Disk Usage Is {{ Result | to_fixed(2) }}% \n>Suggestion：Log in to Alibaba Cloud Console to View RDS Has Exception",
"name": "Alibaba Cloud RDS Mysql Disk Usage Too High",
"noDataInterval": 0,
"recoverNeedPeriodCount": 1,
"targets": [
{
"alias": "Result",
"dql": "M::`aliyun_acs_rds_dashboard`:(LAST(`DiskUsage_Average`)) BY `instanceId`"
}
],
"title": "The disk usage rate of the Aliyun RDS Mysql instance ID is too high, which is {{instanceId}}",
"type": "simpleCheck"
},
"monitorName": "Aliyun RDS Mysql Detection Library",
"monitorUUID": "monitor_xxxx32",
"status": 0,
"type": "trigger",
"updateAt": 1642412816,
"updator": "",
"uuid": "rul_xxxx32",
"workspaceUUID": "wksp_xxxx32"
}
],
"errorCode": "",
"message": "",
"pageInfo": {
"count": 1,
"pageIndex": 2,
"pageSize": 1,
"totalCount": 42
},
"success": true,
"traceId": "TRACE-F9E5478C-D157-4CD0-883D-2B2E7AE5A50F"
}