[{"label":"Latest (v1)","version":"latest"}]

vmware-aria-operations-for-logs

Get Alert Instance

Description

Gets an alert instance

Request

URL

get

https://{api_host}/vrlic/api/v1/alert/instances/{id}

Copy

Path Parameters

string

id Required

Alert Id

Authentication

This operation uses the following authentication methods.

bearerAuth

Response

Response Body

200 OK

Returns AlertInstance of type */*

{
	"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"
	]
}

string

alertConfigurationLink Optional

Reference to the alert configuration that triggered the alert

string

alertDefinitionLink Optional

Reference to the alert definition

string

alertDescription Optional

Long description of the alert definition

string

alertName Optional

Short name describing the alert definition

string

alertSeverity Optional

Alert severity, which includes: CRITICAL, IMMEDIATE, WARNING, INFO

integer as int64

alertTriggerTimeMillis Optional

Time when the alert was triggered (in milliseconds)

string

alertType Optional

Alert type associated with the alert instance, which includes: per-event, windowed

string

logRcaInvestigationId Optional

(Optional) Log Root Cause Analysis (RCA) Investigation ID if automatic Log RCA was enabled for this alert instance

map of InlineAlertInstanceMetadataMap

metadata Optional

Map of the metadata associated with the alert instance

string

namespace Optional

Namespace associated with the alert instance

string

selfLink Optional

Self link associated with the alert instance

array of string

tagIds Optional

Set of tag IDs associated with the alert instance

array of string

tags Optional

Set of tags associated with the alert instance

array of string

tenantLinks Optional

Set of tenant links associated with the alert instance

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl https://{api_host}/vrlic/api/v1/alert/instances/{id}

[{"label":"Latest (v1)","version":"latest"}]

vmware-aria-operations-for-logs

Alert And Notification Operations

post

Create Alert

post

Create Webhook Payload Parameter

delete

Delete Alert By ID

get

Get Alert By ID

get

Get Alert Instance

get

Get Alerts

post

Get All Alert Instances

put

Update Alert By Put

Get Alert Instance

Request

URL

Path Parameters

Authentication

bearerAuth

Response

Response Body

200 OK

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

On This Page

Alert And Notification Operations

Was this page helpful?