Alauda Container Platform
  • Русский

    • Notification [notifications.ait.alauda.io/v1beta1]

    Description
    Notification is the Schema for the notifications API
    Type
    object
    Required
    spec

    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/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

    NotificationSpec defines the desired state of Notification

    .spec

    Description
    NotificationSpec defines the desired state of Notification
    Type
    object
    Required
    default
    PropertyTypeDescription
    defaultobject

    Default subscriptions for this notification

    .spec.default

    Description
    Default subscriptions for this notification
    Type
    object
    Required
    methodstemplate
    PropertyTypeDescription
    groupsarray

    Groups for this subscription

    methodsarray

    Methods for this subscription

    templatestring

    Template to render notification message

    usersarray

    Users for this subscription

    .spec.default.groups

    Description
    Groups for this subscription
    Type
    array

    .spec.default.groups[]

    Type
    string

    .spec.default.methods

    Description
    Methods for this subscription
    Type
    array

    .spec.default.methods[]

    Type
    string

    .spec.default.users

    Description
    Users for this subscription
    Type
    array

    .spec.default.users[]

    Type
    string

    API Endpoints

    The following API endpoints are available:

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

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

    HTTP method
    DELETE
    Description
    delete collection of Notification
    HTTP responses
    HTTP codeResponse body
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    list objects of kind Notification
    HTTP responses
    HTTP codeResponse body
    200 - OKNotificationList schema
    401 - UnauthorizedEmpty
    HTTP method
    POST
    Description
    create a new Notification
    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
    bodyNotification schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKNotification schema
    201 - CreatedNotification schema
    202 - AcceptedNotification schema
    401 - UnauthorizedEmpty

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

    HTTP method
    DELETE
    Description
    delete the specified Notification
    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 Notification
    HTTP responses
    HTTP codeResponse body
    200 - OKNotification schema
    401 - UnauthorizedEmpty
    HTTP method
    PATCH
    Description
    partially update the specified Notification
    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 - OKNotification schema
    401 - UnauthorizedEmpty
    HTTP method
    PUT
    Description
    replace the specified Notification
    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
    bodyNotification schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKNotification schema
    201 - CreatedNotification schema
    401 - UnauthorizedEmpty