Alauda Container Platform

AlertTemplate [alerttemplates.aiops.alauda.io/v1beta1]

Type
object

Specification

PropertyTypeDescription
apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

spec contains specification parameters for a template resource

.spec

Description
spec contains specification parameters for a template resource
Type
object
PropertyTypeDescription
templatesarray

templates is a list of alert template

.spec.templates

Description
templates is a list of alert template
Type
array

.spec.templates[]

Description
template item
Type
object
Required
comparemetricnamethresholdwait
PropertyTypeDescription
annotationsobject

rule annotations

comparestring

compare of a template

exprstring

query expression

labelsobject

rule labels

metricobject

metric info for this alert

namestring

alert range

metric_namestring

metric name

notificationsarray

notifcations triggered by this alert

thresholdnumber

alert threshold

unitstring

unit for metric

waitinteger

time of duration

.spec.templates[].annotations

Description
rule annotations
Type
object

.spec.templates[].labels

Description
rule labels
Type
object

.spec.templates[].metric

Description
metric info for this alert
Type
object
PropertyTypeDescription
queriesarray

queries array for this metric

.spec.templates[].metric.queries

Description
queries array for this metric
Type
array

.spec.templates[].metric.queries[]

Type
object
PropertyTypeDescription
aggregatorstring

aggregator functions

labelsarray

labels for alert object

rangeinteger

aggregate range

.spec.templates[].metric.queries[].labels

Description
labels for alert object
Type
array

.spec.templates[].metric.queries[].labels[]

Type
object
PropertyTypeDescription
namestring

label name

valuestring

label value

.spec.templates[].notifications

Description
notifcations triggered by this alert
Type
array

.spec.templates[].notifications[]

Type
object
PropertyTypeDescription
namestring

notification name

namespacestring

notification namespace

uuidstring

notification uuid

API Endpoints

The following API endpoints are available:

  • /apis/aiops.alauda.io/v1beta1/namespaces/{namespace}/alerttemplates
    • DELETE: delete collection of AlertTemplate
    • GET: list objects of kind AlertTemplate
    • POST: create a new AlertTemplate
  • /apis/aiops.alauda.io/v1beta1/namespaces/{namespace}/alerttemplates/{name}
    • DELETE: delete the specified AlertTemplate
    • GET: read the specified AlertTemplate
    • PATCH: partially update the specified AlertTemplate
    • PUT: replace the specified AlertTemplate

/apis/aiops.alauda.io/v1beta1/namespaces/{namespace}/alerttemplates

HTTP method
DELETE
Description
delete collection of AlertTemplate
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind AlertTemplate
HTTP responses
HTTP codeResponse body
200 - OKAlertTemplateList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new AlertTemplate
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyAlertTemplate schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKAlertTemplate schema
201 - CreatedAlertTemplate schema
202 - AcceptedAlertTemplate schema
401 - UnauthorizedEmpty

/apis/aiops.alauda.io/v1beta1/namespaces/{namespace}/alerttemplates/{name}

HTTP method
DELETE
Description
delete the specified AlertTemplate
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified AlertTemplate
HTTP responses
HTTP codeResponse body
200 - OKAlertTemplate schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified AlertTemplate
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKAlertTemplate schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified AlertTemplate
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyAlertTemplate schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKAlertTemplate schema
201 - CreatedAlertTemplate schema
401 - UnauthorizedEmpty