Alauda Container Platform

简体中文

AlertRule [ait.alauda.io/v1]

描述: AlertRule defines alerting rules for a Prometheus instance AlertRule is a copy of PrometheusRule, just different kind/group/version.
类型: object
必填: spec

规格

属性	类型	描述
`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/sig-architecture/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/sig-architecture/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`	Specification of desired alerting rule definitions for Prometheus.

.spec

描述: Specification of desired alerting rule definitions for Prometheus.
类型: object

属性	类型	描述
`groups`	`array`	Content of Prometheus rule file

.spec.groups

描述: Content of Prometheus rule file
类型: array

.spec.groups[]

描述: RuleGroup is a list of sequentially evaluated recording and alerting rules. Note: PartialResponseStrategy is only used by ThanosRuler and will be ignored by Prometheus instances. Valid values for this field are 'warn' or 'abort'. More info: https://github.com/thanos-io/thanos/blob/master/docs/components/rule.md#partial-response
类型: object
必填: namerules

属性	类型	描述
`interval`	`string`
`name`	`string`
`partial_response_strategy`	`string`
`rules`	`array`

.spec.groups[].rules

类型: array

.spec.groups[].rules[]

描述: Rule describes an alerting or recording rule.
类型: object
必填: expr

属性	类型	描述
`alert`	`string`
`annotations`	`object`
`expr`	`integer\|string`
`for`	`string`
`labels`	`object`
`record`	`string`

.spec.groups[].rules[].annotations

类型: object

.spec.groups[].rules[].labels

类型: object

API 端点

可用的 API 端点如下：

/apis/ait.alauda.io/v1/namespaces/{namespace}/alertrules
- DELETE: delete collection of AlertRule
- GET: list objects of kind AlertRule
- POST: create a new AlertRule
/apis/ait.alauda.io/v1/namespaces/{namespace}/alertrules/{name}
- DELETE: delete the specified AlertRule
- GET: read the specified AlertRule
- PATCH: partially update the specified AlertRule
- PUT: replace the specified AlertRule

/apis/ait.alauda.io/v1/namespaces/{namespace}/alertrules

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

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

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

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

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

查询参数

参数	类型	描述
`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`	`AlertRule` schema	`application/json` formatted

HTTP 响应

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

/apis/ait.alauda.io/v1/namespaces/{namespace}/alertrules/{name}

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

查询参数

参数	类型	描述
`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 AlertRule
HTTP 响应

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

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

查询参数

参数	类型	描述
`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	`AlertRule` schema
401 - Unauthorized	Empty

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

查询参数

参数	类型	描述
`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`	`AlertRule` schema	`application/json` formatted

HTTP 响应

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