Alauda Service Mesh

描述: ApiAttribute is the Schema for the apiattributes 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`	ApiAttributeSpec defines the desired state of ApiAttribute
`status`	`object`	ApiAttributeStatus defines the observed state of ApiAttribute

.spec

描述: ApiAttributeSpec defines the desired state of ApiAttribute
类型: object

属性	类型	描述
`apis`	`array`	api 列表
`exacts`	`array`	精确匹配
`prefixs`	`array`	前缀匹配
`regmatches`	`array`	正则匹配，已废弃
`swaggerImport`	`object`	Swagger Import info

.spec.apis

描述: api 列表
类型: array

.spec.apis[]

描述: api
类型: object
必填: methodoperationidpathport

属性	类型	描述
`gatewayGroupReferences`	`array`	api被服务分组引用列表
`method`	`string`	请求方法
`operationid`	`string`	API名称，对标 swaggger 的 OperationId
`path`	`string`	请求路径，支持 restful api 路径参数
`port`	`integer`	api流量统计不需要，服务网关分组需要，此处仅记录

.spec.apis[].gatewayGroupReferences

描述: api被服务分组引用列表
类型: array

.spec.apis[].gatewayGroupReferences[]

类型: string

.spec.exacts

描述: 精确匹配
类型: array

.spec.exacts[]

类型: object
必填: matchpathmethodoperationid

属性	类型	描述
`envoypatternpath`	`string`
`matchpath`	`string`
`method`	`string`
`operationid`	`string`
`sourcetype`	`string`

.spec.prefixs

描述: 前缀匹配
类型: array

.spec.prefixs[]

类型: object
必填: matchpathmethodoperationid

属性	类型	描述
`envoypatternpath`	`string`
`matchpath`	`string`
`method`	`string`
`operationid`	`string`
`sourcetype`	`string`

.spec.regmatches

描述: 正则匹配，已废弃
类型: array

.spec.regmatches[]

类型: object
必填: matchpathmethodoperationid

属性	类型	描述
`envoypatternpath`	`string`
`matchpath`	`string`
`method`	`string`
`operationid`	`string`
`sourcetype`	`string`

.spec.swaggerImport

描述: Swagger Import info
类型: object

属性	类型	描述
`errorCode`	`integer`
`format`	`string`
`opId`	`string`
`port`	`integer`
`sourceType`	`string`
`totalApi`	`integer`
`version`	`string`

.status

描述: ApiAttributeStatus defines the observed state of ApiAttribute
类型: object

API 端点

可用的 API 端点如下：

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

/apis/asm.alauda.io/v1alpha2/namespaces/{namespace}/apiattributes

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

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

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

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

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

查询参数

参数	类型	描述
`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`	`ApiAttribute` schema	`application/json` formatted

HTTP 响应

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

/apis/asm.alauda.io/v1alpha2/namespaces/{namespace}/apiattributes/{name}

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

查询参数

参数	类型	描述
`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 ApiAttribute
HTTP 响应

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

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

查询参数

参数	类型	描述
`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	`ApiAttribute` schema
401 - Unauthorized	Empty

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

查询参数

参数	类型	描述
`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`	`ApiAttribute` schema	`application/json` formatted

HTTP 响应

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

#规格

#.spec

#.spec.apis

#.spec.apis[]

#.spec.apis[].gatewayGroupReferences

#.spec.apis[].gatewayGroupReferences[]

#.spec.exacts

#.spec.exacts[]

#.spec.prefixs

#.spec.prefixs[]

#.spec.regmatches

#.spec.regmatches[]

#.spec.swaggerImport

#.status

API 端点#

/apis/asm.alauda.io/v1alpha2/namespaces/{namespace}/apiattributes#

/apis/asm.alauda.io/v1alpha2/namespaces/{namespace}/apiattributes/{name}#

规格

.spec

.spec.apis

.spec.apis[]

.spec.apis[].gatewayGroupReferences

.spec.apis[].gatewayGroupReferences[]

.spec.exacts

.spec.exacts[]

.spec.prefixs

.spec.prefixs[]

.spec.regmatches

.spec.regmatches[]

.spec.swaggerImport

.status

API 端点

/apis/asm.alauda.io/v1alpha2/namespaces/{namespace}/apiattributes

/apis/asm.alauda.io/v1alpha2/namespaces/{namespace}/apiattributes/{name}