[{"label":"Latest (v1)","version":"latest"}]
vmware-aria-operations-for-logs

Get All Alert Instances

Description

Gets all alert instances. You can view the alerts that have been triggered in the last hour, day, or week. You can also view details for the last 100 alerts triggered

Request

Request

URL

URL


post
https://{api_host}/vrlic/api/v1/alert/instances/query
Copy

Request Body

Request Body

AlertInstanceQueryState of mimetype application/json Required
{
	"endTime": 0,
	"namespace": "string",
	"resultLimit": 0,
	"startTime": 0
}
integer as int64
endTime Required

Returns alert instances that were created/updated before this time in milliseconds


integer as int64
startTime Required

Returns alert instances that were created/updated after this time in milliseconds


integer as int32
resultLimit Required

Maximum number of results to be returned per page.


string
namespace Required

Namespace of the alert instance query state, e.g., com.vmware.li


string
alertConfigurationLink Optional

Configuration link associated with the alert instance query state


string
metadataKey Optional

Metadata key associated with the alert instance query state


string
metadataValue Optional

Metadata value associated with the alert instance query state


string
alertType Optional

Type of alert

Possible values are: per-event/windowed


string
nextPageLink Optional

Query responses are returned in several pages and you can fetch one page at a time. This field represents the link to the next page.


queryCriteria Optional

Criteria used to filter the alert instances.


array of AlertInstance
alertInstanceColl Optional

Collection of alert instances.


array of object
alertGroupColl Optional

Collection of alert histogram instances.


array of string
tenantLinks Optional

Set of tenant links

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns AlertInstanceQueryState of type */*
{
	"alertConfigurationLink": "string",
	"alertGroupColl": {},
	"alertInstanceColl": [
		{
			"alertConfigurationLink": "string",
			"alertDefinitionLink": "string",
			"alertDescription": "string",
			"alertName": "string",
			"alertSeverity": "string",
			"alertTriggerTimeMillis": 0,
			"alertType": "string",
			"logRcaInvestigationId": "string",
			"metadata": {
				"key": {}
			},
			"namespace": "string",
			"selfLink": "string",
			"tagIds": [
				"string"
			],
			"tags": [
				"string"
			],
			"tenantLinks": [
				"string"
			]
		}
	],
	"alertType": "per-event/windowed",
	"endTime": 0,
	"metadataKey": "string",
	"metadataValue": "string",
	"namespace": "string",
	"nextPageLink": "string",
	"queryCriteria": {
		"constraints": {
			"constraints": "QueryConstraint Object",
			"fieldName": "string",
			"operator": "AND",
			"tags": [
				"string"
			],
			"value": "string"
		},
		"groupByTerms": [
			{
				"fieldName": "string",
				"groupByType": "EACH_VALUE"
			}
		]
	},
	"resultLimit": 0,
	"startTime": 0,
	"tenantLinks": [
		"string"
	]
}
integer as int64
endTime Required

Returns alert instances that were created/updated before this time in milliseconds


integer as int64
startTime Required

Returns alert instances that were created/updated after this time in milliseconds


integer as int32
resultLimit Required

Maximum number of results to be returned per page.


string
namespace Required

Namespace of the alert instance query state, e.g., com.vmware.li


string
alertConfigurationLink Optional

Configuration link associated with the alert instance query state


string
metadataKey Optional

Metadata key associated with the alert instance query state


string
metadataValue Optional

Metadata value associated with the alert instance query state


string
alertType Optional

Type of alert

Possible values are: per-event/windowed


string
nextPageLink Optional

Query responses are returned in several pages and you can fetch one page at a time. This field represents the link to the next page.


queryCriteria Optional

Criteria used to filter the alert instances.


array of AlertInstance
alertInstanceColl Optional

Collection of alert instances.


array of object
alertGroupColl Optional

Collection of alert histogram instances.


array of string
tenantLinks Optional

Set of tenant links

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"alertConfigurationLink":"string","alertGroupColl":{},"alertInstanceColl":[{"alertConfigurationLink":"string","alertDefinitionLink":"string","alertDescription":"string","alertName":"string","alertSeverity":"string","alertTriggerTimeMillis":0,"alertType":"string","logRcaInvestigationId":"string","metadata":{"key":{}},"namespace":"string","selfLink":"string","tagIds":["string"],"tags":["string"],"tenantLinks":["string"]}],"alertType":"per-event/windowed","endTime":0,"metadataKey":"string","metadataValue":"string","namespace":"string","nextPageLink":"string","queryCriteria":{"constraints":{"constraints":"QueryConstraint Object","fieldName":"string","operator":"AND","tags":["string"],"value":"string"},"groupByTerms":[{"fieldName":"string","groupByType":"EACH_VALUE"}]},"resultLimit":0,"startTime":0,"tenantLinks":["string"]}' https://{api_host}/vrlic/api/v1/alert/instances/query


[{"label":"Latest (v1)","version":"latest"}]
vmware-aria-operations-for-logs
Feedback

Was this page helpful?