Alauda Container Platform
  • Русский

    • NotificationGroup [notificationgroups.ait.alauda.io/v1beta1]

    Description
    NoticationGroup is the Schema for the templates 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

    NotificationGroupSpec defines the desired state of NotificationGroup

    .spec

    Description
    NotificationGroupSpec defines the desired state of NotificationGroup
    Type
    object
    PropertyTypeDescription
    addressesarray

    Addresses for notification group

    mailstring

    Mail for notification group

    usersarray

    Users for notification group

    webhookTypestring

    WebhookType for notification group

    webhookUrlstring

    WebhookUrl for notification group

    .spec.addresses

    Description
    Addresses for notification group
    Type
    array

    .spec.addresses[]

    Description
    NotificationGroupAddress defines the desired state of NotificationGroup
    Type
    object
    Required
    type
    PropertyTypeDescription
    typestring

    AddressType defines template type

    urlstring

    Url for notification group

    .spec.users

    Description
    Users for notification group
    Type
    array

    .spec.users[]

    Type
    string

    API Endpoints

    The following API endpoints are available:

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

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

    HTTP method
    DELETE
    Description
    delete collection of NotificationGroup
    HTTP responses
    HTTP codeResponse body
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    list objects of kind NotificationGroup
    HTTP responses
    HTTP codeResponse body
    200 - OKNotificationGroupList schema
    401 - UnauthorizedEmpty
    HTTP method
    POST
    Description
    create a new NotificationGroup
    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
    bodyNotificationGroup schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKNotificationGroup schema
    201 - CreatedNotificationGroup schema
    202 - AcceptedNotificationGroup schema
    401 - UnauthorizedEmpty

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

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