Alauda Service Mesh
  • Русский
    • Description
    GatewayGroup is the Schema for the gatewaygroups API
    Type
    object

    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

    GatewayGroupSpec defines the desired state of GatewayGroup

    statusobject

    GatewayGroupStatus defines the observed state of GatewayGroup

    .spec

    Description
    GatewayGroupSpec defines the desired state of GatewayGroup
    Type
    object
    Required
    namepublish
    PropertyTypeDescription
    apiPrefixPathstring

    Access path to the API group.

    apiPrefixRulestring

    Access rules for the API group.

    apiRoutearray

    API group.

    gatewaystring
    hoststring

    Access method (domain or non-domain).

    namestring

    Group name.

    publishboolean

    Whether to publish.

    .spec.apiRoute

    Description
    API group.
    Type
    array

    .spec.apiRoute[]

    Type
    object
    Required
    methodmsnamenamespaceoperationidpathport
    PropertyTypeDescription
    methodstring

    Http Request method.

    msnamestring

    Service name.

    namespacestring

    namespace.

    operationidstring

    operation id。

    pathstring

    Request path.

    portinteger

    Service port.

    statusstring

    Status of group.

    .status

    Description
    GatewayGroupStatus defines the observed state of GatewayGroup
    Type
    object

    API Endpoints

    The following API endpoints are available:

    • /apis/asm.alauda.io/v1alpha1/namespaces/{namespace}/gatewaygroups
      • DELETE: delete collection of GatewayGroup
      • GET: list objects of kind GatewayGroup
      • POST: create a new GatewayGroup
    • /apis/asm.alauda.io/v1alpha1/namespaces/{namespace}/gatewaygroups/{name}
      • DELETE: delete the specified GatewayGroup
      • GET: read the specified GatewayGroup
      • PATCH: partially update the specified GatewayGroup
      • PUT: replace the specified GatewayGroup
    • /apis/asm.alauda.io/v1alpha1/namespaces/{namespace}/gatewaygroups/{name}/status
      • GET: read status of the specified GatewayGroup
      • PATCH: partially update status of the specified GatewayGroup
      • PUT: replace status of the specified GatewayGroup

    /apis/asm.alauda.io/v1alpha1/namespaces/{namespace}/gatewaygroups

    HTTP method
    DELETE
    Description
    delete collection of GatewayGroup
    HTTP responses
    HTTP codeResponse body
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    list objects of kind GatewayGroup
    HTTP responses
    HTTP codeResponse body
    200 - OKGatewayGroupList schema
    401 - UnauthorizedEmpty
    HTTP method
    POST
    Description
    create a new GatewayGroup
    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
    bodyGatewayGroup schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKGatewayGroup schema
    201 - CreatedGatewayGroup schema
    202 - AcceptedGatewayGroup schema
    401 - UnauthorizedEmpty

    /apis/asm.alauda.io/v1alpha1/namespaces/{namespace}/gatewaygroups/{name}

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

    /apis/asm.alauda.io/v1alpha1/namespaces/{namespace}/gatewaygroups/{name}/status

    HTTP method
    GET
    Description
    read status of the specified GatewayGroup
    HTTP responses
    HTTP codeResponse body
    200 - OKGatewayGroup schema
    401 - UnauthorizedEmpty
    HTTP method
    PATCH
    Description
    partially update status of the specified GatewayGroup
    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 - OKGatewayGroup schema
    401 - UnauthorizedEmpty
    HTTP method
    PUT
    Description
    replace status of the specified GatewayGroup
    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
    bodyGatewayGroup schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKGatewayGroup schema
    201 - CreatedGatewayGroup schema
    401 - UnauthorizedEmpty