​

ves-io-schema-shape-brmalerts-alert_gen_policy-API-Get

Published April 5, 2023 | Last modified March 20, 2025

Examples of getting alert_gen_policy

Usecase:

Get the alert that was created in previous example

Request using vesctl:

vesctl configuration get alert_gen_policy analysis --namespace system

vesctl yaml response:

deletedReferredObjects: []
disabledReferredObjects: []
metadata:
  annotations: {}
  labels: {}
  name: analysis
  namespace: system
referringObjects: []
resourceVersion: "2662"
spec:
  details:
    alertMessage: Traffic Alert Message
    alertMessageDetails: Traffic Alert Message details
    alertName: Traffic Alert
    severity: MAJOR
status: []
systemMetadata:
  creationTimestamp: "2025-03-11T00:56:45.573498Z"
  creatorClass: examplesvc
  creatorId: examplesvc
  finalizers: []
  labels: {}
  tenant: acmecorp
  uid: 9ce6d21a-3088-471f-b88b-f294a8373e91
Copied!

Request using curl:

curl -X 'GET' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build436303540_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/shape/alerts/namespaces/system/alert_gen_policys/analysis?response_format=0'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 1040
Content-Type: application/json
Date: Tue, 11 Mar 2025 00:56:45 GMT
Vary: Accept-Encoding

{
  "create_form": null,
  "replace_form": null,
  "resource_version": "2662",
  "metadata": {
    "name": "analysis",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "9ce6d21a-3088-471f-b88b-f294a8373e91",
    "creation_timestamp": "2025-03-11T00:56:45.573498Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "alert_status": "ALERT_ACTIVE",
    "details": {
      "severity": "MAJOR",
      "alert_name": "Traffic Alert",
      "alert_message": "Traffic Alert Message",
      "alert_message_details": "Traffic Alert Message details"
    }
  },
  "status": [
  ],
  "referring_objects": [
  ],
  "deleted_referred_objects": [
  ],
  "disabled_referred_objects": [
  ]
}
Copied!
On this page: