Alauda Container Platform

简体中文

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

类型: object

规格

属性	类型	描述
`apiVersion`	`string`	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
`kind`	`string`	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
`metadata`	`ObjectMeta`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	spec contains specification parameters for a template resource

.spec

描述: spec contains specification parameters for a template resource
类型: object

属性	类型	描述
`templates`	`array`	templates is a list of alert template

.spec.templates

描述: templates is a list of alert template
类型: array

.spec.templates[]

描述: template item
类型: object
必填: comparemetricnamethresholdwait

属性	类型	描述
`annotations`	`object`	rule annotations
`compare`	`string`	compare of a template
`expr`	`string`	query expression
`labels`	`object`	rule labels
`metric`	`object`	metric info for this alert
`name`	`string`	alert range
`metric_name`	`string`	metric name
`notifications`	`array`	notifcations triggered by this alert
`threshold`	`number`	alert threshold
`unit`	`string`	unit for metric
`wait`	`integer`	time of duration

.spec.templates[].annotations

描述: rule annotations
类型: object

.spec.templates[].labels

描述: rule labels
类型: object

.spec.templates[].metric

描述: metric info for this alert
类型: object

属性	类型	描述
`queries`	`array`	queries array for this metric

.spec.templates[].metric.queries

描述: queries array for this metric
类型: array

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

类型: object

属性	类型	描述
`aggregator`	`string`	aggregator functions
`labels`	`array`	labels for alert object
`range`	`integer`	aggregate range

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

描述: labels for alert object
类型: array

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

类型: object

属性	类型	描述
`name`	`string`	label name
`value`	`string`	label value

.spec.templates[].notifications

描述: notifcations triggered by this alert
类型: array

.spec.templates[].notifications[]

类型: object

属性	类型	描述
`name`	`string`	notification name
`namespace`	`string`	notification namespace
`uuid`	`string`	notification uuid

API 端点

可用的 API 端点如下：

/apis/aiops.alauda.io/v1beta1/alerttemplates
- DELETE: delete collection of AlertTemplate
- GET: list objects of kind AlertTemplate
- POST: create a new AlertTemplate
/apis/aiops.alauda.io/v1beta1/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/alerttemplates

HTTP 方法: DELETE
描述: delete collection of AlertTemplate
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: list objects of kind AlertTemplate
HTTP 响应

HTTP 状态码	响应体
200 - OK	`AlertTemplateList` schema
401 - Unauthorized	Empty

HTTP 方法: POST
描述: create a new AlertTemplate

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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`	`AlertTemplate` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`AlertTemplate` schema
201 - Created	`AlertTemplate` schema
202 - Accepted	`AlertTemplate` schema
401 - Unauthorized	Empty

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

HTTP 方法: DELETE
描述: delete the specified AlertTemplate

查询参数

参数	类型	描述
`dryRun`	`string`	When 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 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: read the specified AlertTemplate
HTTP 响应

HTTP 状态码	响应体
200 - OK	`AlertTemplate` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update the specified AlertTemplate

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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 响应

HTTP 状态码	响应体
200 - OK	`AlertTemplate` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace the specified AlertTemplate

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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`	`AlertTemplate` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`AlertTemplate` schema
201 - Created	`AlertTemplate` schema
401 - Unauthorized	Empty