Características admitidas

lts

Informes de registros de acceso de Shubao

Sí

{"name":"lts","enable":true,"config": "{\"group_id\": ",\"topic_id\":\"\",\"log_group\":\"\",\"log_stream\":\"\"}"}

group_id

ID de grupo de registro.

-

-

topic_id

ID de flujo de registro.

log_group

Nombre de un grupo de registro.

log_stream

Nombre de un flujo de registro.

gateway_responses

Respuestas de gateway personalizadas

No

-

-

-

-

-

ratelimit

Solicitar configuración de límite de regulación

Sí

{"name":"ratelimit","enable":true,"config": "{\"api_limits\": 500}"}

api_limits

Valor predeterminado de limitación de solicitud aplicado a todas las API. Establezca este parámetro correctamente para cumplir con los requisitos de servicio. Un pequeño valor puede acelerar constantemente sus servicios.

200 invocaciones por segundo

1–1,000,000 invocaciones por segundo

request_body_size

Configuración del tamaño máximo del cuerpo de la solicitud

Sí

{"name":"request_body_size","enable":true,"config": "104857600"}

request_body_size

Tamaño máximo del cuerpo permitido en una solicitud de API.

12 MB

1–9536 MB

backend_timeout

Configuración de tiempo de espera de backend máximo

Sí

{"name":"backend_timeout","enable":true,"config": "{"max_timeout": 500}"}

max_timeout

Tiempo de espera máximo para que APIG solicite un servicio de backend.

60,000 ms

1-600,000 ms

app_token

Autenticación de app_token

Sí

{"name":"app_token","enable":true,"config": "{\"enable\": \"on\", \"app_token_expire_time\": 3600, \"app_token_uri\": \"/v1/apigw/oauth2/token\", \"refresh_token_expire_time\": 7200}"}

enable

Si se debe habilitar esta característica.

Off

On/Off

app_token_expire_time

Período de validez del token de acceso.

3600s

1–72,000s

refresh_token_expire_time

Período de validez del token de actualización.

7200s

1–72,000s

app_token_uri

URI utilizado para obtener el token.

/v1/apigw/oauth2/token

-

app_token_key

Clave de encriptación de token.

-

-

app_api_key

Autenticación de app_api_key

Sí

{"name":"app_api_key","enable":true,"config": "on"}

-

-

Off

On/Off

app_basic

Autenticación de app_basic

Sí

{"name":"app_basic","enable":true,"config": "on"}

-

-

Off

On/Off

app_secret

Autenticación de app_secret

Sí

{"name":"app_secret","enable":true,"config": "on"}

-

-

Off

On/Off

app_jwt

Autenticación de app_jwt

Sí

{"name":"app_jwt","enable":true,"config": "{\"enable\": \"on\", \"auth_header\": \"Authorization\"}"}

enable

Si se debe habilitar la autenticación app_jwt.

Off

On/Off

auth_header

Encabezado de autenticación de app_jwt.

Authorization

-

public_key

Firmas de backend de public_key

Sí

{"name":"public_key","enable":true,"config": "{\"enable\": \"on\", \"public_key_uri_prefix\": \"/apigw/authadv/v2/public-key/\"}"}

enable

Si se debe habilitar la autenticación de public_key.

Off

On/Off

public_key_uri_prefix

Prefijo de URI utilizado para obtener la clave pública.

/apigw/authadv/v2/public-key/

-

backend_token_allow

Permitir que los tenants transmitan tokens de forma transparente al backend

Sí

{"name":"backend_token_allow","enable":true,"config": "{\"backend_token_allow_users\": [\"user_name\"]}"}

backend_token_allow_users

Expresión regular para transmitir de forma transparente el token a la lista blanca de tenant común del tenant para que coincida con el nombre de dominio del tenant común.

-

-

sign_basic

Claves de firma básicas

No

-

-

-

-

-

multi_auth

Autenticación de dos factores

No

-

-

-

-

-

backend_client_certificate

Autenticación bidireccional de backend

Sí

{"name":"backend_client_certificate","enable":true,"config": "{\"enable\": \"on\",\"ca\": \"\",\"content\": \"\",\"key\": \"\"}"}

enable

Si se debe habilitar esta característica.

Off

On/Off

ca

Archivo de CA de autenticación bidireccional.

-

-

content

Archivo de autenticación bidireccional.

-

-

key

Clave privada de autenticación bidireccional.

-

-

ssl_ciphers

Conjuntos de cifrado de HTTPS

Sí

{"name":"ssl_ciphers","enable":true,"config": "config": "{\"ssl_ciphers\": [\"ECDHE-ECDSA-AES256-GCM-SHA384\"]}"}

ssl_ciphers

Compatible con conjuntos de cifrado y descifrado. El parámetro ssl_ciphers no se puede dejar en blanco y solo puede contener las opciones del valor predeterminado.

-

ECDHE-ECDSA-AES256-GCM-SHA384,ECDHE-RSA-AES256-GCM-SHA384,ECDHE-ECDSA-AES128-GCM-SHA256,ECDHE-RSA-AES128-GCM-SHA256,ECDHE-ECDSA-AES256-SHA384,ECDHE-RSA-AES256-SHA384,ECDHE-ECDSA-AES128-SHA256,ECDHE-RSA-AES128-SHA256

route

Rutas personalizadas

No

-

-

-

-

-

cors

Complementos

No

-

-

-

-

-

real_ip_from_xff

Encabezado de X-Forwarded-For para identificar direcciones IP durante el control de acceso y la limitación de solicitudes

Sí

{"name": "real_ip_from_xff","enable": true,"config": {"enable": "on","xff_index": -1}}

enable

Si se debe habilitar esta característica.

Off

On/Off

xff_index

Número de secuencia de una dirección IP en el encabezado de X-Forwarded-For. El valor de este parámetro puede ser 0 o un número positivo o negativo. Si el valor es de 0 o un número positivo, la dirección IP del índice correspondiente se obtiene a partir del encabezado de X-Forwarded-For. Si el valor es un número negativo, la dirección IP en orden de índice inverso se obtiene del encabezado de X-Forwarded-For. Por ejemplo, supóngase que el encabezado X-Forwarded-For de una solicitud recibida por el gateway de API contiene tres direcciones IP: IP1, IP2 e IP3. Si el valor de xff_index es 0, se obtiene IP1. Si el valor de xff_index es 1, se obtiene IP2. Si el valor de xff_index es –1, se obtiene IP3.

-1

Valor de Int32 válido

app_route

IP address access

Sí

{"name":"app_route","enable":true,"config": "on"}

-

-

Off

On/Off

vpc_name_modifiable

Modificación del nombre del canal de balanceo de carga

Sí

{"name":"vpc_name_modifiable","enable":true,"config": "on"}

-

-

on

On/Off

default_group_host_trustlist

Acceso al grupo DEFAULT desde direcciones IP que no son direcciones de acceso entrantes del gateway actual

Sí

{"name":"default_group_host_trustlist","enable": true,"config": "{\"enable\":\"on\",\"hosts\":[\"123.2.2.2\",\"202.2.2.2\"]}"}

enable

Si se debe habilitar esta característica.

-

On/Off

hosts

Direcciones IP que no son direcciones de acceso entrante del gateway actual.

-

-

throttle_strategy

Limitación de solicitudes

Sí

{"name":"throttle_strategy","enable":true,"config": "{\"enable\": \"on\",\"strategy\": \"local\"}"}

enable

Si se debe habilitar esta característica.

Off

On/Off

strategy

Modo de limitación de solicitudes.

-

cluster/local

custom_log

Impresión de encabezados de solicitud personalizados, cadenas de consulta y cookies en registros

Sí

{"name":"custom_log","enable":true,"config": "{\"custom_logs\":[{\"location\":\"header\",\"name\":\"a1234\"}]}"}

custom_logs

Registros personalizados.

-

Máximo 10 artículos.

location

Ubicación.

header/query/cookie

name

Nombre.

-

real_ip_header_getter

Uso de un encabezado personalizado para obtener direcciones IP de origen

Sí

{"name":"real_ip_header_getter","enable":true,"config": "{\"enable\": \"on\",\"header_getter\": \"header:testIP\"}"}

enable

Si se debe habilitar esta característica.

Off

On/Off

header_getter

Encabezado personalizado para obtener direcciones IP de origen.

-

-

policy_cookie_param

Uso de cookies en las condiciones de la política de backend

Sí

{"name":"policy_cookie_param","enable":true,"config": "on"}

-

-

Off

On/Off

app_quota

Cuotas de cliente

No

-

-

-

-

-

app_acl

Políticas de limitación de solicitudes

No

-

-

-

-

-

set_resp_headers

Complementos de gestión de encabezados de respuesta

No

-

-

-

-

-

vpc_backup

Canales de VPC primarios/en espera

No

-

-

-

-

-

sign_aes

Claves de firma AES

No

-

-

-

-

-

kafka_log

Adición, eliminación, modificación y consulta de complementos de inserción de registros de Kafka

No

-

-

-

-

-

backend_retry_count

Configuración de reintentos de backend

No

-

-

-

-

-

policy_sys_param

Uso de parámetros del sistema en condiciones de política de backend

No

-

-

-

-

-

breaker

Interruptores

No

-

-

-

-

-

content_type_configurable

Devolver el tipo de parámetro de solicitud (Content-Type) al consultar las API

No

-

-

-

-

-

rate_limit_plugin

Complementos de limitación de solicitudes

No

-

-

-

-

-

breakerv2

Interruptores para degradar servicios en caso de sobrecarga

No

-

-

-

-

-

sm_cipher_type

Cifrado de datos sensibles locales con algoritmos criptográficos comerciales

No

-

-

-

-

-

rate_limit_algorithm

Conmutación de algoritmo de limitación de solicitudes

No

-

-

-

-

-

gzip

Compresión de respuesta usando gzip

Sí

{

"name" : "gzip",

"config" : {\"comp_level\":6},

"enable" : true

}

comp_level

Nivel de compresión de gzip (1 a 9). Cuanto más alto es el nivel, más comprimido, pero tarda más tiempo.

6

1–9

sse_strategy

Transmisión de SSE

Sí

{

"name": "sse_strategy",

"enable": true,

"config": "on"

}

-

-

Off

On/Off

authorizer_context_support_num_bool

Si el valor del par clave-valor en el contexto devuelto para la autenticación personalizada puede ser un número o un valor de Boolean.

No

-

-

-

-

-

custom_auth_header

Encabezados de autenticación personalizados para políticas de autenticación de aplicaciones y clave de firma.

Sí

1: {

"name": "custom_auth_header",

"enable": true,

"config": "{\"app_auth_header\":\"app-header\", \"backend_sign_header\":\"back-header\"}"

}

app_auth_header

Se utiliza para especificar la información de firma para la autenticación de aplicaciones en el encabezado de solicitud.

-

Deje este parámetro en blanco o introduzca de 3 a 64 letras, dígitos, guiones (-) y guiones bajos (_), y comience con una letra. No comience con x-apig- o x-sdk-, y no use x-stage o authorization. El valor no distingue entre mayúsculas y minúsculas.

backend_sign_header

Se utiliza para especificar la información de firma de las políticas de clave de firma (Basic, Auth, HMAC) para pasar al backend.

-

request_custom_config

Configuración de parámetros de solicitud de cliente

Sí

{

"name": "request_custom_config",

"enable": true,

"config": "{\"http2\":\"on\",\"client_body_timeout\":10}"

}

http2

Si se debe habilitar HTTP/2.

on

on/off

client_body_timeout

Tiempo de espera del cuerpo de solicitud del cliente.

8s

1-60s

gateway_responses_support_header

La respuesta de grupo personalizada admite encabezados personalizados.

No

-

-

-

-

-

api_uri_no_escape

Parámetros de solicitud de anulación de escape de la ruta de solicitud en la API.

Sí

{"name":"api_uri_no_escape","enable":true,"config":""}

enable

Si se debe habilitar esta característica.

false

true/false

ip_control

Control de acceso

Sí

{"enable": true,"name":"ip_control","config":"{\"control_type\":\"white\",\"white_ip_list\":\"\",\"black_ip_list\":\"\"}"}

control_type

Tipo de control.

black

black/white

white_ip_list

Lista blanca de direcciones IP.

-

-

black_ip_list

Lista negra de direcciones IP.

-

-