Get Alert Rule

GET 
/projects/:projectId/providers/Aruba.Insight/alertRules/:alertRulesId

Get Alert Rule

Request

Path Parameters

projectId stringrequired
alertRulesId stringrequired

Query Parameters

api-version string
The requested API version
Default value: 1.0

Responses

200

Success

text/plain

Schema

Schema

idstringnullable

alertModel

object

labels

object

nullable

property name*string

annotations

object

nullable

property name*string

startsAtstringnullable

endsAtstringnullable

generatorURLstringnullable

status

object

inhibitedByundefined[]nullable

silencedByundefined[]nullable

statestringnullable

fingerprintstringnullable

webhook

object

urlstringnullable

request

object

namestringnullable

tagsstring[]nullable

descriptionstringnullable

usernamestringnullable

tenantstringnullable

companystringnullable

serviceCategorystringnullable

serviceTypologystringnullable

clusterTypologystringnullable

clusterstringnullable

clusternamestringnullable

nodePoolstringnullable

serviceNumberint32nullable

resourceIdstring[]nullable

resourceNamestring[]nullable

resourceTypologystringnullable

vdcstringnullable

vmstring[]nullable

metricstringnullable

lastReceptiondate-timenullable

lastActivationdate-timenullable

creationDatetimedate-timenullable

lastEditdate-timenullable

deletionDatedate-timenullable

rulestringnullable

thesholdint64nullable

umstringnullable

durationstringnullable

statestringnullable

emailbooleannullable

emailValuestringnullable

smsbooleannullable

smsValuestringnullable

panelbooleannullable

hiddenbooleannullable

alertActions

object[]

nullable

Array [

actionTypeActionType (string)

Possible values: [NotificationPanel, SendEmail, SendSms, AutoscalingDbaas]

parameters

object

nullable

property name*string

]

resourceVersionstringnullable
resourceUidstringnullable

actions

object[]

nullable

Array [

keystringnullable

disabledbooleannullable

executablebooleannullable

]

lastReceptionstringnullable
lastActivationstringnullable
lastEditstringnullable

Example (from schema)

{
  "id": "string",
  "alertModel": {
    "labels": {},
    "annotations": {},
    "startsAt": "string",
    "endsAt": "string",
    "generatorURL": "string",
    "status": {
      "inhibitedBy": [
        null
      ],
      "silencedBy": [
        null
      ],
      "state": "string"
    },
    "fingerprint": "string",
    "webhook": {
      "url": "string"
    }
  },
  "request": {
    "name": "string",
    "tags": [
      "string"
    ],
    "description": "string",
    "username": "string",
    "tenant": "string",
    "company": "string",
    "serviceCategory": "string",
    "serviceTypology": "string",
    "clusterTypology": "string",
    "cluster": "string",
    "clustername": "string",
    "nodePool": "string",
    "serviceNumber": 0,
    "resourceId": [
      "string"
    ],
    "resourceName": [
      "string"
    ],
    "resourceTypology": "string",
    "vdc": "string",
    "vm": [
      "string"
    ],
    "metric": "string",
    "lastReception": "2024-07-29T15:51:28.071Z",
    "lastActivation": "2024-07-29T15:51:28.071Z",
    "creationDatetime": "2024-07-29T15:51:28.071Z",
    "lastEdit": "2024-07-29T15:51:28.071Z",
    "deletionDate": "2024-07-29T15:51:28.071Z",
    "rule": "string",
    "theshold": 0,
    "um": "string",
    "duration": "string",
    "state": "string",
    "email": true,
    "emailValue": "string",
    "sms": true,
    "smsValue": "string",
    "panel": true,
    "hidden": true,
    "alertActions": [
      {
        "actionType": "NotificationPanel",
        "parameters": {}
      }
    ]
  },
  "resourceVersion": "string",
  "resourceUid": "string",
  "actions": [
    {
      "key": "string",
      "disabled": true,
      "executable": true
    }
  ],
  "lastReception": "string",
  "lastActivation": "string",
  "lastEdit": "string"
}

application/json

Schema

Schema

idstringnullable

alertModel

object

labels

object

nullable

property name*string

annotations

object

nullable

property name*string

startsAtstringnullable

endsAtstringnullable

generatorURLstringnullable

status

object

inhibitedByundefined[]nullable

silencedByundefined[]nullable

statestringnullable

fingerprintstringnullable

webhook

object

urlstringnullable

request

object

namestringnullable

tagsstring[]nullable

descriptionstringnullable

usernamestringnullable

tenantstringnullable

companystringnullable

serviceCategorystringnullable

serviceTypologystringnullable

clusterTypologystringnullable

clusterstringnullable

clusternamestringnullable

nodePoolstringnullable

serviceNumberint32nullable

resourceIdstring[]nullable

resourceNamestring[]nullable

resourceTypologystringnullable

vdcstringnullable

vmstring[]nullable

metricstringnullable

lastReceptiondate-timenullable

lastActivationdate-timenullable

creationDatetimedate-timenullable

lastEditdate-timenullable

deletionDatedate-timenullable

rulestringnullable

thesholdint64nullable

umstringnullable

durationstringnullable

statestringnullable

emailbooleannullable

emailValuestringnullable

smsbooleannullable

smsValuestringnullable

panelbooleannullable

hiddenbooleannullable

alertActions

object[]

nullable

Array [

actionTypeActionType (string)

Possible values: [NotificationPanel, SendEmail, SendSms, AutoscalingDbaas]

parameters

object

nullable

property name*string

]

resourceVersionstringnullable
resourceUidstringnullable

actions

object[]

nullable

Array [

keystringnullable

disabledbooleannullable

executablebooleannullable

]

lastReceptionstringnullable
lastActivationstringnullable
lastEditstringnullable

Example (from schema)

{
  "id": "string",
  "alertModel": {
    "labels": {},
    "annotations": {},
    "startsAt": "string",
    "endsAt": "string",
    "generatorURL": "string",
    "status": {
      "inhibitedBy": [
        null
      ],
      "silencedBy": [
        null
      ],
      "state": "string"
    },
    "fingerprint": "string",
    "webhook": {
      "url": "string"
    }
  },
  "request": {
    "name": "string",
    "tags": [
      "string"
    ],
    "description": "string",
    "username": "string",
    "tenant": "string",
    "company": "string",
    "serviceCategory": "string",
    "serviceTypology": "string",
    "clusterTypology": "string",
    "cluster": "string",
    "clustername": "string",
    "nodePool": "string",
    "serviceNumber": 0,
    "resourceId": [
      "string"
    ],
    "resourceName": [
      "string"
    ],
    "resourceTypology": "string",
    "vdc": "string",
    "vm": [
      "string"
    ],
    "metric": "string",
    "lastReception": "2024-07-29T15:51:28.071Z",
    "lastActivation": "2024-07-29T15:51:28.071Z",
    "creationDatetime": "2024-07-29T15:51:28.071Z",
    "lastEdit": "2024-07-29T15:51:28.071Z",
    "deletionDate": "2024-07-29T15:51:28.071Z",
    "rule": "string",
    "theshold": 0,
    "um": "string",
    "duration": "string",
    "state": "string",
    "email": true,
    "emailValue": "string",
    "sms": true,
    "smsValue": "string",
    "panel": true,
    "hidden": true,
    "alertActions": [
      {
        "actionType": "NotificationPanel",
        "parameters": {}
      }
    ]
  },
  "resourceVersion": "string",
  "resourceUid": "string",
  "actions": [
    {
      "key": "string",
      "disabled": true,
      "executable": true
    }
  ],
  "lastReception": "string",
  "lastActivation": "string",
  "lastEdit": "string"
}

text/json

Schema

Schema

idstringnullable

alertModel

object

labels

object

nullable

property name*string

annotations

object

nullable

property name*string

startsAtstringnullable

endsAtstringnullable

generatorURLstringnullable

status

object

inhibitedByundefined[]nullable

silencedByundefined[]nullable

statestringnullable

fingerprintstringnullable

webhook

object

urlstringnullable

request

object

namestringnullable

tagsstring[]nullable

descriptionstringnullable

usernamestringnullable

tenantstringnullable

companystringnullable

serviceCategorystringnullable

serviceTypologystringnullable

clusterTypologystringnullable

clusterstringnullable

clusternamestringnullable

nodePoolstringnullable

serviceNumberint32nullable

resourceIdstring[]nullable

resourceNamestring[]nullable

resourceTypologystringnullable

vdcstringnullable

vmstring[]nullable

metricstringnullable

lastReceptiondate-timenullable

lastActivationdate-timenullable

creationDatetimedate-timenullable

lastEditdate-timenullable

deletionDatedate-timenullable

rulestringnullable

thesholdint64nullable

umstringnullable

durationstringnullable

statestringnullable

emailbooleannullable

emailValuestringnullable

smsbooleannullable

smsValuestringnullable

panelbooleannullable

hiddenbooleannullable

alertActions

object[]

nullable

Array [

actionTypeActionType (string)

Possible values: [NotificationPanel, SendEmail, SendSms, AutoscalingDbaas]

parameters

object

nullable

property name*string

]

resourceVersionstringnullable
resourceUidstringnullable

actions

object[]

nullable

Array [

keystringnullable

disabledbooleannullable

executablebooleannullable

]

lastReceptionstringnullable
lastActivationstringnullable
lastEditstringnullable

Example (from schema)

{
  "id": "string",
  "alertModel": {
    "labels": {},
    "annotations": {},
    "startsAt": "string",
    "endsAt": "string",
    "generatorURL": "string",
    "status": {
      "inhibitedBy": [
        null
      ],
      "silencedBy": [
        null
      ],
      "state": "string"
    },
    "fingerprint": "string",
    "webhook": {
      "url": "string"
    }
  },
  "request": {
    "name": "string",
    "tags": [
      "string"
    ],
    "description": "string",
    "username": "string",
    "tenant": "string",
    "company": "string",
    "serviceCategory": "string",
    "serviceTypology": "string",
    "clusterTypology": "string",
    "cluster": "string",
    "clustername": "string",
    "nodePool": "string",
    "serviceNumber": 0,
    "resourceId": [
      "string"
    ],
    "resourceName": [
      "string"
    ],
    "resourceTypology": "string",
    "vdc": "string",
    "vm": [
      "string"
    ],
    "metric": "string",
    "lastReception": "2024-07-29T15:51:28.071Z",
    "lastActivation": "2024-07-29T15:51:28.071Z",
    "creationDatetime": "2024-07-29T15:51:28.071Z",
    "lastEdit": "2024-07-29T15:51:28.071Z",
    "deletionDate": "2024-07-29T15:51:28.071Z",
    "rule": "string",
    "theshold": 0,
    "um": "string",
    "duration": "string",
    "state": "string",
    "email": true,
    "emailValue": "string",
    "sms": true,
    "smsValue": "string",
    "panel": true,
    "hidden": true,
    "alertActions": [
      {
        "actionType": "NotificationPanel",
        "parameters": {}
      }
    ]
  },
  "resourceVersion": "string",
  "resourceUid": "string",
  "actions": [
    {
      "key": "string",
      "disabled": true,
      "executable": true
    }
  ],
  "lastReception": "string",
  "lastActivation": "string",
  "lastEdit": "string"
}

400

Bad Request

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

401

Unauthorized

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Not Found

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}