Alauda Service Mesh

Alauda Service Mesh

简体中文

描述: CanaryEvent is the Schema for the CanaryEvent API
类型: object

规格

属性	类型	描述
`apiVersion`	`string`	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
`kind`	`string`	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
`metadata`	`ObjectMeta`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	CanaryDeliverySpec defines the desired state of CanaryDelivery

.spec

描述: CanaryDeliverySpec defines the desired state of CanaryDelivery
类型: object

属性	类型	描述
`currentRecordId`	`integer`	current max record id
`records`	`object`	CanaryRecord list for canary

.spec.records

描述: CanaryRecord list for canary
类型: object
必填: namespacestartTime

属性	类型	描述
`currentWeight`	`integer`
`endTime`	`string`
`canarydeploy`	`string`
`configtracks`	`array`
`primarydeploy`	`string`
`events`	`array`
`id`	`integer`	Id for this record
`name`	`string`
`namespace`	`string`
`startTime`	`string`
`status`	`string`

.spec.records.configtracks

类型: array

.spec.records.configtracks[]

类型: object
必填: configtypename

属性	类型	描述
`canaryyaml`	`string`
`configtype`	`string`	config type configmap or secret
`name`	`string`	ConfigTracks
`primaryyaml`	`string`

.spec.records.events

类型: array

.spec.records.events[]

描述: CanaryEvent is used for events of canary
类型: object

属性	类型	描述
`eventName`	`string`	name for the event
`eventType`	`string`	event type like canary ab bluegreen
`message`	`string`	the message flagger report
`phase`	`string`	Phase
`timestamp`	`string`	the event generate time
`weight`	`integer`	current weight

API 端点

可用的 API 端点如下：

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

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

HTTP 方法: DELETE
描述: delete collection of CanaryEvent
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: list objects of kind CanaryEvent
HTTP 响应

HTTP 状态码	响应体
200 - OK	`CanaryEventList` schema
401 - Unauthorized	Empty

HTTP 方法: POST
描述: create a new CanaryEvent

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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`	`CanaryEvent` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`CanaryEvent` schema
201 - Created	`CanaryEvent` schema
202 - Accepted	`CanaryEvent` schema
401 - Unauthorized	Empty

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

HTTP 方法: DELETE
描述: delete the specified CanaryEvent

查询参数

参数	类型	描述
`dryRun`	`string`	When 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 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: read the specified CanaryEvent
HTTP 响应

HTTP 状态码	响应体
200 - OK	`CanaryEvent` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update the specified CanaryEvent

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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 - OK	`CanaryEvent` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace the specified CanaryEvent

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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`	`CanaryEvent` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`CanaryEvent` schema
201 - Created	`CanaryEvent` schema
401 - Unauthorized	Empty