arrow-left

All pages
gitbookPowered by GitBook
1 of 3

Loading...

Loading...

Loading...

Get alarms

Get events

hashtag
Get alarms

get

Get the list of alerts generated in the cluster.

Query parameters
clusterIdsstringRequired
startstringOptional

Start time for the query (YYYYmmddHHMMss)

endstringOptional

end time for the query (YYYYmmddHHMMss)

statusstringOptional

alert type (Allowed values: firing, resolved, default: firing)

severitystringOptional

severity type (Allowed values: Warning, Critical, default: All)

pageintegerOptional

Paging parameters (default: 1)

limitintegerOptional

Paging - Number of items per page declaration(default: 50)(Up to 1000 records can be retrieved)

Responses
chevron-right
200

OK

*/*
get
/v1/monitoring/alerts
200

OK

GET /v1/monitoring/alerts?clusterIds=text HTTP/1.1
Accept: */*
{
  "metric": {
    "start": 1702277460,
    "end": 1702363860,
    "page": 1,
    "limit": 50,
    "total": 28,
    "count": 28
  },
  "data": [
    {
      "cluster_id": "thingcluster",
      "alarm_id": "950bf0892f701484",
      "alarm_key": "Cocktail-Rule-0024",
      "alarm_name": "KubeContainerWaiting",
      "namespace": "cocktail-system",
      "resource": "replicaset",
      "workload": "cocktail-monitoring-alarm-collector",
      "pod": "cocktail-monitoring-alarm-collector-7fd77b57c8-ctp6p",
      "container": "collector",
      "severity": "warning",
      "status": "resolved",
      "start": 1702355154,
      "end": 1702358994,
      "description": "{\"message_en\":\"Pod cocktail-monitoring-alarm-collector-7fd77b57c8-ctp6p in namespace cocktail-system on container collector has been in waiting state for longer than 1 hour.\",\"message_ja\":\"ใƒใƒƒใƒ‰cocktail-system/cocktail-monitoring-alarm-collector-7fd77b57c8-ctp6pใฎใ‚ณใƒณใƒ†ใƒŠcollectorใŒ1ๆ™‚้–“ไปฅไธŠๅพ…ๆฉŸใฎ็Šถๆ…‹ใซใ‚ใ‚Šใพใ—ใŸใ€‚\",\"message_ko\":\"ํŒŒ๋“œ cocktail-system/cocktail-monitoring-alarm-collector-7fd77b57c8-ctp6p์˜ ์ปจํ…Œ์ด๋„ˆ collector๊ฐ€ 1์‹œ๊ฐ„ ์ด์ƒ ๋Œ€๊ธฐ ์ƒํƒœ์— ์žˆ์Šต๋‹ˆ๋‹ค.\"}",
      "runbook_url": "https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubecontainerwaiting"
    }
  ]
}

hashtag
Get events

get

Get the list of events generated in the cluster.

Query parameters
clusterIdsstringRequired
startstringOptional

Start time for the query (YYYYmmddHHMMss)

endstringOptional

end time for the query (YYYYmmddHHMMss)

pageintegerOptional

Paging parameters (default: 1)

limitintegerOptional

Paging - Number of items per page declaration(default: 50)(Up to 1000 records can be retrieved)

Responses
chevron-right
200

OK

*/*
get
/v1/monitoring/events
200

OK

GET /v1/monitoring/events?clusterIds=text HTTP/1.1
Accept: */*
{
  "metric": {
    "start": 1702976820,
    "end": 1703142420,
    "page": 1,
    "limit": 1000,
    "total": 129,
    "count": 129
  },
  "data": [
    {
      "cluster_id": "thingcluster",
      "event_id": "d0597b0d-11ef-4b94-a5ca-0b2154f7960d",
      "event_name": "cocktail-api-server.17a2c60e1ec6f8da",
      "event_type": "Normal",
      "node": "",
      "namespace": "cocktail-system",
      "workload": "cocktail-api-server",
      "workload_type": "Deployment",
      "workload_version": "apps/v1",
      "timestamp": 1703141373,
      "first_seen": 1703141373,
      "last_seen": 1703141373,
      "reason": "ScalingReplicaSet",
      "message": "Scaled down replica set cocktail-api-server-684cc65fc8 to 0 from 1",
      "source": "deployment-controller",
      "count": 1
    }
  ]
}

Event

Get alarmschevron-right
Get eventschevron-right