Returns the Model Monitoring alerts.
HTTP request
POST http://{service-endpoint}/v1beta1/{modelMonitor}:searchModelMonitoringAlerts
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
modelMonitor |
Required. ModelMonitor resource name. Format: |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"modelMonitoringJob": string,
"alertTimeInterval": {
object ( |
Fields | |
---|---|
modelMonitoringJob |
If non-empty, returns the alerts of this model monitoring job. |
alertTimeInterval |
If non-empty, returns the alerts in this time interval. |
statsName |
If non-empty, returns the alerts of this statsName. |
objectiveType |
If non-empty, returns the alerts of this objective type. Supported monitoring objectives: |
pageSize |
The standard list page size. |
pageToken |
A page token received from a previous |
Response body
Response message for ModelMonitoringService.SearchModelMonitoringAlerts
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"modelMonitoringAlerts": [
{
object ( |
Fields | |
---|---|
modelMonitoringAlerts[] |
Alerts retrieved for the requested objectives. Sorted by alert time descendingly. |
totalNumberAlerts |
The total number of alerts retrieved by the requested objectives. |
nextPageToken |
The page token that can be used by the next |
Authorization scopes
Requires the following OAuth scope:
http://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
ModelMonitoringAlert
Represents a single monitoring alert. This is currently used in the modelMonitors.searchModelMonitoringAlerts api, thus the alert wrapped in this message belongs to the resource asked in the request.
JSON representation |
---|
{
"statsName": string,
"objectiveType": string,
"alertTime": string,
"anomaly": {
object ( |
Fields | |
---|---|
statsName |
The stats name. |
objectiveType |
One of the supported monitoring objectives: |
alertTime |
Alert creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
anomaly |
Anomaly details. |
ModelMonitoringAnomaly
Represents a single model monitoring anomaly.
JSON representation |
---|
{ "modelMonitoringJob": string, "algorithm": string, // Union field |
Fields | |
---|---|
modelMonitoringJob |
Model monitoring job resource name. |
algorithm |
Algorithm used to calculated the metrics, eg: jensen_shannon_divergence, l_infinity. |
Union field
|
|
tabularAnomaly |
Tabular anomaly. |
TabularAnomaly
Tabular anomaly details.
JSON representation |
---|
{
"anomalyUri": string,
"summary": string,
"anomaly": value,
"triggerTime": string,
"condition": {
object ( |
Fields | |
---|---|
anomalyUri |
Additional anomaly information. e.g. Google Cloud Storage uri. |
summary |
Overview of this anomaly. |
anomaly |
Anomaly body. |
triggerTime |
The time the anomaly was triggered. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
condition |
The alert condition associated with this anomaly. |