类型
object

规格

属性类型描述
specobject

Configuration affecting edge load balancer. See more details at: https://istio.io/docs/reference/config/networking/gateway.html

statusobject

.spec

描述
Configuration affecting edge load balancer. See more details at: https://istio.io/docs/reference/config/networking/gateway.html
类型
object
属性类型描述
selectorobject
serversarray

A list of server specifications.

.spec.selector

类型
object

.spec.servers

描述
A list of server specifications.
类型
array

.spec.servers[]

类型
object
属性类型描述
bindstring
defaultEndpointstring
hostsarray

One or more hosts exposed by this gateway.

namestring

An optional name of the server, when set must be unique across all servers.

portobject
tlsobject

Set of TLS related options that govern the server's behavior.

.spec.servers[].hosts

描述
One or more hosts exposed by this gateway.
类型
array

.spec.servers[].hosts[]

类型
string

.spec.servers[].port

类型
object
属性类型描述
namestring

Label assigned to the port.

numberinteger

A valid non-negative integer port number.

protocolstring

The protocol exposed on the port.

targetPortinteger

.spec.servers[].tls

描述
Set of TLS related options that govern the server's behavior.
类型
object
属性类型描述
caCertificatesstring

REQUIRED if mode is MUTUAL.

cipherSuitesarray

Optional: If specified, only support the specified cipher list.

credentialNamestring
httpsRedirectboolean
maxProtocolVersionstring

Optional: Maximum TLS protocol version.

minProtocolVersionstring

Optional: Minimum TLS protocol version.

modestring
privateKeystring

REQUIRED if mode is SIMPLE or MUTUAL.

serverCertificatestring

REQUIRED if mode is SIMPLE or MUTUAL.

subjectAltNamesarray
verifyCertificateHasharray
verifyCertificateSpkiarray

.spec.servers[].tls.cipherSuites

描述
Optional: If specified, only support the specified cipher list.
类型
array

.spec.servers[].tls.cipherSuites[]

类型
string

.spec.servers[].tls.subjectAltNames

类型
array

.spec.servers[].tls.subjectAltNames[]

类型
string

.spec.servers[].tls.verifyCertificateHash

类型
array

.spec.servers[].tls.verifyCertificateHash[]

类型
string

.spec.servers[].tls.verifyCertificateSpki

类型
array

.spec.servers[].tls.verifyCertificateSpki[]

类型
string

.status

类型
object

API 端点

可用的 API 端点如下:

  • /apis/networking.istio.io/v1beta1/namespaces/{namespace}/gateways
    • DELETE: delete collection of Gateway
    • GET: list objects of kind Gateway
    • POST: create a new Gateway
  • /apis/networking.istio.io/v1beta1/namespaces/{namespace}/gateways/{name}
    • DELETE: delete the specified Gateway
    • GET: read the specified Gateway
    • PATCH: partially update the specified Gateway
    • PUT: replace the specified Gateway
  • /apis/networking.istio.io/v1beta1/namespaces/{namespace}/gateways/{name}/status
    • GET: read status of the specified Gateway
    • PATCH: partially update status of the specified Gateway
    • PUT: replace status of the specified Gateway

/apis/networking.istio.io/v1beta1/namespaces/{namespace}/gateways

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

/apis/networking.istio.io/v1beta1/namespaces/{namespace}/gateways/{name}

HTTP 方法
DELETE
描述
delete the specified Gateway
查询参数
参数类型描述
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 Gateway
HTTP 响应
HTTP 状态码响应体
200 - OKGateway schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified Gateway
查询参数
参数类型描述
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 - OKGateway schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified Gateway
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyGateway schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKGateway schema
201 - CreatedGateway schema
401 - UnauthorizedEmpty

/apis/networking.istio.io/v1beta1/namespaces/{namespace}/gateways/{name}/status

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