描述
IngressGateway is the Schema for the ingressgateways API
类型
object

规格

属性类型描述
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

IngressGatewaySpec defines the desired state of IngressGateway

statusobject

IngressGatewayStatus defines the observed state of IngressGateway

.spec

描述
IngressGatewaySpec defines the desired state of IngressGateway
类型
object
必填
port
属性类型描述
corsPolicyobject

CORS configuration.

gatewayobject

GatewayDeploy

gatewayGroupsRefarray

The associated API group.

hoststring

Access mode.

httpRouteobject

HTTP route config.

patchesarray

List of patches to apply to root virtualservice.

portobject

Port info.

portsobject

Port details.

serviceRoutesarray

The associated service route.

tcpRouteobject

TCP route config

tcpRoutesarray

The associated TCP service route.

tlsDomainstring

TLSDomain which come out of TLS secret

.spec.corsPolicy

描述
CORS configuration.
类型
object
必填
configTypeenabled
属性类型描述
allowCredentialsboolean

Whether to allow the browser to read the contents of the response.

allowHeadersarray

The list of request headers that the server allows for cross-origin requests.

allowMethodsarray

The list of cross-origin request methods allowed by the server.

allowOriginsarray

The server allows cross-origin requests for the list of domains.

configTypestring

CORS type. The value range is simple or advance, which means "basic configuration" and "advanced configuration" respectively.

enabledboolean

Whether to enable CORS.

exposeHeadersarray

A list of headers that the server allows browsers with cross-origin requests to access.

maxAgestring

Cross-origin preflight request cache time.

.spec.corsPolicy.allowHeaders

描述
The list of request headers that the server allows for cross-origin requests.
类型
array

.spec.corsPolicy.allowHeaders[]

类型
string

.spec.corsPolicy.allowMethods

描述
The list of cross-origin request methods allowed by the server.
类型
array

.spec.corsPolicy.allowMethods[]

类型
string

.spec.corsPolicy.allowOrigins

描述
The server allows cross-origin requests for the list of domains.
类型
array

.spec.corsPolicy.allowOrigins[]

类型
object
属性类型描述
typestring

Match method.

valuestring

Value.

.spec.corsPolicy.exposeHeaders

描述
A list of headers that the server allows browsers with cross-origin requests to access.
类型
array

.spec.corsPolicy.exposeHeaders[]

类型
string

.spec.gateway

描述
GatewayDeploy
类型
object
必填
namenamespace
属性类型描述
namestring

The name of gateway.

namespacestring

The namespace of gateway.

.spec.gatewayGroupsRef

描述
The associated API group.
类型
array

.spec.gatewayGroupsRef[]

类型
object
必填
apiPrefixPathapiPrefixRulename
属性类型描述
apiPrefixPathstring

Access path.

apiPrefixRulestring

Access rule.

corsPolicyobject

CORS configuration.

namestring

Group name.

.spec.gatewayGroupsRef[].corsPolicy

描述
CORS configuration.
类型
object
必填
configTypeenabled
属性类型描述
allowCredentialsboolean

Whether to allow the browser to read the contents of the response.

allowHeadersarray

The list of request headers that the server allows for cross-origin requests.

allowMethodsarray

The list of cross-origin request methods allowed by the server.

allowOriginsarray

The server allows cross-origin requests for the list of domains.

configTypestring

CORS type. The value range is simple or advance, which means "basic configuration" and "advanced configuration" respectively.

enabledboolean

Whether to enable CORS.

exposeHeadersarray

A list of headers that the server allows browsers with cross-origin requests to access.

maxAgestring

Cross-origin preflight request cache time.

.spec.gatewayGroupsRef[].corsPolicy.allowHeaders

描述
The list of request headers that the server allows for cross-origin requests.
类型
array

.spec.gatewayGroupsRef[].corsPolicy.allowHeaders[]

类型
string

.spec.gatewayGroupsRef[].corsPolicy.allowMethods

描述
The list of cross-origin request methods allowed by the server.
类型
array

.spec.gatewayGroupsRef[].corsPolicy.allowMethods[]

类型
string

.spec.gatewayGroupsRef[].corsPolicy.allowOrigins

描述
The server allows cross-origin requests for the list of domains.
类型
array

.spec.gatewayGroupsRef[].corsPolicy.allowOrigins[]

类型
object
属性类型描述
typestring

Match method.

valuestring

Value.

.spec.gatewayGroupsRef[].corsPolicy.exposeHeaders

描述
A list of headers that the server allows browsers with cross-origin requests to access.
类型
array

.spec.gatewayGroupsRef[].corsPolicy.exposeHeaders[]

类型
string

.spec.httpRoute

描述
HTTP route config.
类型
object
必填
matchTypeuri
属性类型描述
corsPolicyobject

CORS configuration.

headersarray

Match headers.

matchTypestring

Match method.

namestring

Service name.

namespacestring

Service namespace.

portinteger

Service port.

redirectobject

Redirect configuration, new attribute in release3.14.

rewritestring

Request rewrite.

uristring

Request path.

.spec.httpRoute.corsPolicy

描述
CORS configuration.
类型
object
必填
configTypeenabled
属性类型描述
allowCredentialsboolean

Whether to allow the browser to read the contents of the response.

allowHeadersarray

The list of request headers that the server allows for cross-origin requests.

allowMethodsarray

The list of cross-origin request methods allowed by the server.

allowOriginsarray

The server allows cross-origin requests for the list of domains.

configTypestring

CORS type. The value range is simple or advance, which means "basic configuration" and "advanced configuration" respectively.

enabledboolean

Whether to enable CORS.

exposeHeadersarray

A list of headers that the server allows browsers with cross-origin requests to access.

maxAgestring

Cross-origin preflight request cache time.

.spec.httpRoute.corsPolicy.allowHeaders

描述
The list of request headers that the server allows for cross-origin requests.
类型
array

.spec.httpRoute.corsPolicy.allowHeaders[]

类型
string

.spec.httpRoute.corsPolicy.allowMethods

描述
The list of cross-origin request methods allowed by the server.
类型
array

.spec.httpRoute.corsPolicy.allowMethods[]

类型
string

.spec.httpRoute.corsPolicy.allowOrigins

描述
The server allows cross-origin requests for the list of domains.
类型
array

.spec.httpRoute.corsPolicy.allowOrigins[]

类型
object
属性类型描述
typestring

Match method.

valuestring

Value.

.spec.httpRoute.corsPolicy.exposeHeaders

描述
A list of headers that the server allows browsers with cross-origin requests to access.
类型
array

.spec.httpRoute.corsPolicy.exposeHeaders[]

类型
string

.spec.httpRoute.headers

描述
Match headers.
类型
array

.spec.httpRoute.headers[]

类型
object
属性类型描述
keystring

Key.

typestring

Match method.

valuestring

Value.

.spec.httpRoute.redirect

描述
Redirect configuration, new attribute in release3.14.
类型
object
属性类型描述
httpsRedirectboolean
locationstring
redirectCodeinteger

.spec.patches

描述
List of patches to apply to root virtualservice.
类型
array

.spec.patches[]

类型
object
属性类型描述
pathstring

Path of the form a.[key1:value1].b.[:value2] Where [key1:value1] is a selector for a key-value pair to identify a list element and [:value] is a value selector to identify a list element in a leaf list. All path intermediate nodes must exist.

value

Value to add, delete or replace. For add, the path should be a new leaf. For delete, value should be unset. For replace, path should reference an existing node. All values are strings but are converted into appropriate type based on schema.

.spec.port

描述
Port info.
类型
object
必填
name
属性类型描述
namestring

Port name, in the formatted of "protocol-port".

.spec.ports

描述
Port details.
类型
object
必填
group
属性类型描述
detailarray

Port details.

groupstring

Group name.

.spec.ports.detail

描述
Port details.
类型
array

.spec.ports.detail[]

类型
object
必填
portprotocoltargetPort
属性类型描述
nodePortinteger

Node port.

portinteger

Service port.

protocolstring

Protocal type.

targetPortinteger

Container port.

.spec.serviceRoutes

描述
The associated service route.
类型
array

.spec.serviceRoutes[]

类型
object
必填
matchTypemsNamemsNamespacemsPortpublishuri
属性类型描述
corsPolicyobject

CORS configuration.

headersarray

Header.

matchTypestring

Match method.

msNamestring

Service name.

msNamespacestring

Namespace where the service is located.

msPortinteger

Service port.

publishboolean

Whether to publish.

rewritestring

Request rewrite.

uristring

Request path.

.spec.serviceRoutes[].corsPolicy

描述
CORS configuration.
类型
object
必填
configTypeenabled
属性类型描述
allowCredentialsboolean

Whether to allow the browser to read the contents of the response.

allowHeadersarray

The list of request headers that the server allows for cross-origin requests.

allowMethodsarray

The list of cross-origin request methods allowed by the server.

allowOriginsarray

The server allows cross-origin requests for the list of domains.

configTypestring

CORS type. The value range is simple or advance, which means "basic configuration" and "advanced configuration" respectively.

enabledboolean

Whether to enable CORS.

exposeHeadersarray

A list of headers that the server allows browsers with cross-origin requests to access.

maxAgestring

Cross-origin preflight request cache time.

.spec.serviceRoutes[].corsPolicy.allowHeaders

描述
The list of request headers that the server allows for cross-origin requests.
类型
array

.spec.serviceRoutes[].corsPolicy.allowHeaders[]

类型
string

.spec.serviceRoutes[].corsPolicy.allowMethods

描述
The list of cross-origin request methods allowed by the server.
类型
array

.spec.serviceRoutes[].corsPolicy.allowMethods[]

类型
string

.spec.serviceRoutes[].corsPolicy.allowOrigins

描述
The server allows cross-origin requests for the list of domains.
类型
array

.spec.serviceRoutes[].corsPolicy.allowOrigins[]

类型
object
属性类型描述
typestring

Match method.

valuestring

Value.

.spec.serviceRoutes[].corsPolicy.exposeHeaders

描述
A list of headers that the server allows browsers with cross-origin requests to access.
类型
array

.spec.serviceRoutes[].corsPolicy.exposeHeaders[]

类型
string

.spec.serviceRoutes[].headers

描述
Header.
类型
array

.spec.serviceRoutes[].headers[]

类型
object
属性类型描述
keystring

Key.

typestring

Match method.

valuestring

Value.

.spec.tcpRoute

描述
TCP route config
类型
object
必填
namenamespaceport
属性类型描述
namestring

Service name.

namespacestring

Namespace where the service is located.

portinteger

Service port.

.spec.tcpRoutes

描述
The associated TCP service route.
类型
array

.spec.tcpRoutes[]

类型
object
必填
gwPortmsNamemsNamespacemsPort
属性类型描述
gwPortinteger

Gateway port.

msNamestring

Service name.

msNamespacestring

Namespace where the service is located.

msPortinteger

Service port.

.status

描述
IngressGatewayStatus defines the observed state of IngressGateway
类型
object
属性类型描述
upgradeobject

The status of upgration

.status.upgrade

描述
The status of upgration
类型
object
属性类型描述
failReasonstring

The reasone of failed upgration

phasestring

Phase of upgration

API 端点

可用的 API 端点如下:

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

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

HTTP 方法
DELETE
描述
delete collection of IngressGateway
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind IngressGateway
HTTP 响应
HTTP 状态码响应体
200 - OKIngressGatewayList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new IngressGateway
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyIngressGateway schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKIngressGateway schema
201 - CreatedIngressGateway schema
202 - AcceptedIngressGateway schema
401 - UnauthorizedEmpty

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

HTTP 方法
DELETE
描述
delete the specified IngressGateway
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
read the specified IngressGateway
HTTP 响应
HTTP 状态码响应体
200 - OKIngressGateway schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified IngressGateway
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKIngressGateway schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified IngressGateway
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyIngressGateway schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKIngressGateway schema
201 - CreatedIngressGateway schema
401 - UnauthorizedEmpty

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

HTTP 方法
GET
描述
read status of the specified IngressGateway
HTTP 响应
HTTP 状态码响应体
200 - OKIngressGateway schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update status of the specified IngressGateway
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKIngressGateway schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace status of the specified IngressGateway
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyIngressGateway schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKIngressGateway schema
201 - CreatedIngressGateway schema
401 - UnauthorizedEmpty