API-referens
Alla HTTP-slutpunkter i modulen monitoring: autentisering, IAM-åtgärd, parametrar, innehåll och statuskoder.
Genererad från modulens kod när dess image byggdes — redigera inte. Sökvägarna är relativa till https://api.example.com.
Docs
GET /docs/monitoring/manifest.json
- Autentisering: krävs
- Operationsnamn:
DocsManifest_monitoring
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
GET /docs/monitoring/{path}
- Autentisering: krävs
- Operationsnamn:
DocsFile_monitoring
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
path |
sökväg | string |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
Monitoring & Alerts
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/monitoring/{resourceType}/{resourceName}
- Autentisering: krävs
- IAM-åtgärd:
monitoring/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
resourceType |
sökväg | string |
Ja |
resourceName |
sökväg | string |
Ja |
aggregation |
frågesträng | string |
Ja |
container |
frågesträng | string |
Nej |
from |
frågesträng | date-time |
Ja |
metric |
frågesträng | string |
Ja |
to |
frågesträng | date-time |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte monitoring/read på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/monitoring/{resourceType}/{resourceName}/alerts
- Autentisering: krävs
- IAM-åtgärd:
monitoring/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
resourceType |
sökväg | string |
Ja |
resourceName |
sökväg | string |
Ja |
includeResolved |
frågesträng | boolean |
Nej |
limit |
frågesträng | integer |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte monitoring/read på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/monitoring/{resourceType}/{resourceName}/requests
- Autentisering: krävs
- IAM-åtgärd:
monitoring/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
resourceType |
sökväg | string |
Ja |
resourceName |
sökväg | string |
Ja |
from |
frågesträng | date-time |
Ja |
to |
frågesträng | date-time |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte monitoring/read på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/monitoring/{resourceType}/{resourceName}/utilization
- Autentisering: krävs
- IAM-åtgärd:
monitoring/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
resourceType |
sökväg | string |
Ja |
resourceName |
sökväg | string |
Ja |
from |
frågesträng | date-time |
Ja |
metric |
frågesträng | string |
Ja |
to |
frågesträng | date-time |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte monitoring/read på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resources/monitoring/alerts
- Autentisering: krävs
- IAM-åtgärd:
monitoring/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte monitoring/read på det utvärderade omfånget |
Platform Monitoring
GET /admin/monitoring/alerts
- Autentisering: krävs
- IAM-åtgärd:
monitoring/platform/read— utvärderas på plattformens rot - Operationsnamn:
GetPlatformAlerts
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
includeResolved |
frågesträng | boolean |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte monitoring/platform/read på det utvärderade omfånget |
POST /admin/monitoring/alerts
- Autentisering: krävs
- IAM-åtgärd:
monitoring/platform/alerts/write— utvärderas på plattformens rot - Operationsnamn:
IngestPlatformAlert
Begärans innehåll: AlertIngestRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte monitoring/platform/alerts/write på det utvärderade omfånget |
GET /admin/monitoring/metrics
- Autentisering: krävs
- IAM-åtgärd:
monitoring/platform/read— utvärderas på plattformens rot - Operationsnamn:
GetPlatformMetric
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
aggregation |
frågesträng | string |
Ja |
from |
frågesträng | date-time |
Ja |
metric |
frågesträng | string |
Ja |
resourceType |
frågesträng | string |
Nej |
to |
frågesträng | date-time |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte monitoring/platform/read på det utvärderade omfånget |
GET /admin/monitoring/nodes
- Autentisering: krävs
- IAM-åtgärd:
monitoring/platform/read— utvärderas på plattformens rot - Operationsnamn:
GetPlatformNodeHealth
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte monitoring/platform/read på det utvärderade omfånget |
GET /admin/monitoring/storage/claims
- Autentisering: krävs
- IAM-åtgärd:
monitoring/platform/read— utvärderas på plattformens rot - Operationsnamn:
GetPlatformClaimStorage
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
claim |
frågesträng | string [] |
Nej |
lookbackMinutes |
frågesträng | integer |
Nej |
namespace |
frågesträng | string |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte monitoring/platform/read på det utvärderade omfånget |
GET /admin/monitoring/storage/volumes
- Autentisering: krävs
- IAM-åtgärd:
monitoring/platform/read— utvärderas på plattformens rot - Operationsnamn:
GetPlatformUnhealthyVolumes
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte monitoring/platform/read på det utvärderade omfånget |
Övriga slutpunkter
GET /readyz
- Autentisering: ingen — anonyma anrop accepteras
- Operationsnamn:
StackshipReadiness
Svar
| Status | Betydelse | Innehåll |
|---|
Scheman
AlertIngestRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
alertId |
string |
Nej |
detail |
string |
Nej |
level |
AlertLevel |
Nej |
metadata |
map (string) |
Nej |
resourceName |
string |
Nej |
resourceType |
string |
Nej |
status |
AlertIngestStatus |
Ja |
subject |
string |
Nej |
title |
string |
Nej |
AlertIngestStatus
Ett av: Firing, Resolved.
AlertLevel
Ett av: 0 = Recommendation, 1 = Information, 2 = Warning, 3 = Error, 4 = Critical, 5 = Insight.