Alauda Service Mesh
Description
ErrorCheck is the Schema for the errorchecks 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/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/api-conventions.md#types-kinds

metadataObjectMeta

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

specobject

ErrorCheckSpec defines the desired state of ErrorCheck

statusobject

ErrorCheckStatus defines the observed state of ErrorCheck

.spec

Description
ErrorCheckSpec defines the desired state of ErrorCheck
Type
object
Required
errlist
PropertyTypeDescription
errlistarray

.spec.errlist

Type
array

.spec.errlist[]

Type
object
PropertyTypeDescription
errorcodestring
errordescstring
errorlevelstring
relatenamestring
resourenamestring

.status

Description
ErrorCheckStatus defines the observed state of ErrorCheck
Type
object

API Endpoints

The following API endpoints are available:

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

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

HTTP method
DELETE
Description
delete collection of ErrorCheck
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind ErrorCheck
HTTP responses
HTTP codeResponse body
200 - OKErrorCheckList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new ErrorCheck
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
bodyErrorCheck schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKErrorCheck schema
201 - CreatedErrorCheck schema
202 - AcceptedErrorCheck schema
401 - UnauthorizedEmpty

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

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

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

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