Policy Attachment v1alpha1 API Reference

Blacklist is the list of IP addresses to be blacklisted

Whitelist is the list of IP addresses to be whitelisted

EnableXFF is the flag to enable X-Forwarded-For header

StatusCode is the response status code to be returned when the access control is exceeded

Message is the response message to be returned when the access control is exceeded

TargetRef is the reference to the target resource to which the policy is applied

Ports is the access control configuration for ports

Hostnames is the access control configuration for hostnames

HTTPAccessControls is the access control configuration for HTTP routes

GRPCAccessControls is the access control configuration for GRPC routes

DefaultConfig is the default access control for all ports, routes and hostnames

Conditions describe the current conditions of the AccessControlPolicy.

MinRequestAmount is the minimum number of requests in the StatTimeWindow

StatTimeWindow is the time window in seconds to collect statistics

SlowTimeThreshold is the threshold in seconds to determine a slow request

SlowAmountThreshold is the threshold of slow requests in the StatTimeWindow to trigger circuit breaking

SlowRatioThreshold is the threshold of slow requests ratio in the StatTimeWindow to trigger circuit breaking

ErrorAmountThreshold is the threshold of error requests in the StatTimeWindow to trigger circuit breaking

ErrorRatioThreshold is the threshold of error requests ratio in the StatTimeWindow to trigger circuit breaking

DegradedTimeWindow is the time window in seconds to degrade the service

DegradedStatusCode is the status code to return when the service is degraded

DegradedResponseContent is the response content to return when the service is degraded

TargetRef is the reference to the target resource to which the policy is applied

Ports is the circuit breaking configuration for ports

DefaultConfig is the default circuit breaking configuration for all ports

Conditions describe the current conditions of the CircuitBreakingPolicy.

Percent is the percentage of requests to abort

StatusCode is the HTTP status code to return for the aborted request

Message is the HTTP status message to return for the aborted request

Delay defines the delay configuration

Abort defines the abort configuration

Percent is the percentage of requests to delay

Fixed is the fixed delay duration, default Unit is ms

Range is the range of delay duration

Unit is the unit of delay duration, default Unit is ms

TargetRef is the reference to the target resource to which the policy is applied

Hostnames is the access control configuration for hostnames

HTTPFaultInjections is the access control configuration for HTTP routes

GRPCFaultInjections is the access control configuration for GRPC routes

DefaultConfig is the default access control for all ports, routes and hostnames

Unit is the unit of delay duration, default Unit is ms

Conditions describe the current conditions of the FaultInjectionPolicy.

Min is the minimum value of the range, default Unit is ms

Max is the maximum value of the range, default Unit is ms

Match is the match condition for the GRPC route

Config is the access control configuration for the GRPC route

Match is the match condition for the GRPC route

Config is the access control configuration for the GRPC route

Match is the match condition for the GRPC route

Config is the rate limit configuration for the GRPC route

MTLS defines if the gateway port should use mTLS or not

TargetRef is the reference to the target resource to which the policy is applied

Ports is the Gateway TLS configuration for ports

DefaultConfig is the default Gateway TLS configuration for all ports

Conditions describe the current conditions of the GatewayTLSPolicy.

Match is the match condition for the HTTP route

Config is the access control configuration for the HTTP route

Match is the match condition for the HTTP route

Config is the access control configuration for the HTTP route

Match is the match condition for the HTTP route

Config is the rate limit configuration for the HTTP route

Interval is the interval in seconds to check the health of the service

MaxFails is the maximum number of consecutive failed health checks before considering the service as unhealthy

FailTimeout is the time in seconds before considering the service as healthy if it’s marked as unhealthy, even if it’s already healthy

Path is the path to check the health of the HTTP service, if it’s not set, the health check will be TCP based

Matches is the list of health check match conditions of HTTP service

StatusCodes is the list of status codes to match

Body is the content of response body to match

Headers is the list of response headers to match

TargetRef is the reference to the target resource to which the policy is applied

Ports is the health check configuration for ports

DefaultConfig is the default health check configuration for all ports

Conditions describe the current conditions of the HealthCheckPolicy.

Hostname is the hostname for matching the access control

Config is the access control configuration for the hostname

Hostname is the hostname for matching the access control

Config is the access control configuration for the hostname

Hostname is the hostname for matching the rate limit

Config is the rate limit configuration for the hostname

Mode is the mode of the rate limit policy, Local or Global, default is Local

Backlog is the number of requests allowed to wait in the queue

Requests is the number of requests allowed per statTimeWindow

Burst is the number of requests allowed to be bursted, if not specified, it will be the same as Requests

StatTimeWindow is the time window in seconds

ResponseStatusCode is the response status code to be returned when the rate limit is exceeded

ResponseHeadersToAdd is the response headers to be added when the rate limit is exceeded

TargetRef is the reference to the target resource to which the policy is applied

Ports is the load balancer configuration for ports

DefaultType is the default type of the load balancer for all ports

Conditions describe the current conditions of the LoadBalancerPolicy.

"HashingLoadBalancer"

"LeastConnectionLoadBalancer"

"RoundRobinLoadBalancer"

Port is the port number for matching the access control

Config is the access control configuration for the port

Port is the port number of the target service

Config is the circuit breaking configuration for the port

Port is the port number of the target service

Config is the Gateway TLS configuration for the port

Port is the port number of the target service

Config is the health check configuration for the port

Port is the port number for matching the load balancer

Type is the type of the load balancer

Port is the port number for matching the rate limit

BPS is the rate limit in bytes per second for the port

Port is the port number of the target service

Config is the retry configuration for the port

Port is the port number of the target service

Config is the session sticky configuration for the port

Port is the port number of the target service

Config is the session sticky configuration for the port

"Global"

RateLimitPolicyModeGlobal is the global mode

"Local"

RateLimitPolicyModeLocal is the local mode

TargetRef is the reference to the target resource to which the policy is applied

Ports is the rate limit configuration for ports

DefaultBPS is the default rate limit for all ports

Hostnames is the rate limit configuration for hostnames

HTTPRateLimits is the rate limit configuration for HTTP routes

GRPCRateLimits is the rate limit configuration for GRPC routes

DefaultConfig is the default rate limit for all routes and hostnames

Conditions describe the current conditions of the RateLimitPolicy.

RetryOn is the list of retryable response codes, e.g. 5xx matches 500-599, or 500 matches just 500

NumRetries is the number of retries

BackoffBaseInterval is the base interval for computing backoff in seconds

TargetRef is the reference to the target resource to which the policy is applied

Ports is the retry configuration for ports

DefaultConfig is the default retry configuration for all ports

Conditions describe the current conditions of the RetryPolicy.

CookieName is the name of the cookie used for sticky session

Expires is the expiration time of the cookie in seconds

TargetRef is the reference to the target resource to which the policy is applied

Ports is the session sticky configuration for ports

DefaultConfig is the default session sticky configuration for all ports

Conditions describe the current conditions of the SessionStickyPolicy.

CertificateRef is the reference to the certificate used for TLS connection to upstream

MTLS is the flag to enable mutual TLS to upstream

TargetRef is the reference to the target resource to which the policy is applied

Ports is the session sticky configuration for ports

DefaultConfig is the default session sticky configuration for all ports

Conditions describe the current conditions of the UpstreamTLSPolicy.