NotificationTemplate [notificationtemplates.ait.alauda.io/v1beta1]

描述
NotificationTemplate is the Schema for the templates API
类型
object
必填
spec

规格

属性类型描述
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds

metadataObjectMeta

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

specobject

NotificationTemplateSpec defines the desired state of NotificationTemplate

.spec

描述
NotificationTemplateSpec defines the desired state of NotificationTemplate
类型
object
属性类型描述
emailobject

NotificationTemplateEmail defines the desired state of email NotificationTemplate

smsobject

NotificationTemplateCommon defines the desired state of common NotificationTemplate

templatesarray
webhookobject

NotificationTemplateCommon defines the desired state of common NotificationTemplate

.spec.email

描述
NotificationTemplateEmail defines the desired state of email NotificationTemplate
类型
object
必填
content
属性类型描述
contentstring

Content template to render notification message

subjectstring

Subject template to render notification message

.spec.sms

描述
NotificationTemplateCommon defines the desired state of common NotificationTemplate
类型
object
必填
content
属性类型描述
contentstring

Content template to render notification message

.spec.templates

类型
array

.spec.templates[]

描述
NotificationTemplateDetail defines the desired state of common NotificationTemplateDetail
类型
object
必填
contenttype
属性类型描述
contentstring

Content template to render notification message

subjectstring
typestring

TemplateType defines template type

.spec.webhook

描述
NotificationTemplateCommon defines the desired state of common NotificationTemplate
类型
object
必填
content
属性类型描述
contentstring

Content template to render notification message

API 端点

可用的 API 端点如下:

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

/apis/ait.alauda.io/v1beta1/namespaces/{namespace}/notificationtemplates

HTTP 方法
DELETE
描述
delete collection of NotificationTemplate
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind NotificationTemplate
HTTP 响应
HTTP 状态码响应体
200 - OKNotificationTemplateList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new NotificationTemplate
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyNotificationTemplate schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKNotificationTemplate schema
201 - CreatedNotificationTemplate schema
202 - AcceptedNotificationTemplate schema
401 - UnauthorizedEmpty

/apis/ait.alauda.io/v1beta1/namespaces/{namespace}/notificationtemplates/{name}

HTTP 方法
DELETE
描述
delete the specified NotificationTemplate
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
read the specified NotificationTemplate
HTTP 响应
HTTP 状态码响应体
200 - OKNotificationTemplate schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified NotificationTemplate
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKNotificationTemplate schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified NotificationTemplate
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyNotificationTemplate schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKNotificationTemplate schema
201 - CreatedNotificationTemplate schema
401 - UnauthorizedEmpty