实例支持的APIC特性

lts

是否支持SHUBAO访问日志上报功能。

是

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

group_id

日志组ID。

-

-

topic_id

日志流ID。

-

-

log_group

日志组名称。

-

-

log_stream

日志流名称。

-

-

gateway_responses

是否支持网关自定义响应。

否

-

-

-

-

-

ratelimit

是否支持自定义流控值。

是

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

api_limits

API全局默认流控值。注意：如果配置过小会导致业务持续被流控，请根据业务谨慎修改。

200 次/秒

1-1000000 次/秒

request_body_size

是否支持指定最大请求Body大小。

是

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

request_body_size

请求中允许携带的Body大小上限。

12 M

1-9536 M

backend_timeout

是否支持配置后端API超时时间。

是

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

max_timeout

APIC到后端服务的超时时间上限。

60000 ms

1-600000 ms

app_token

是否开启app_token认证方式。

是

{"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

是否开启。

off

on/off

app_token_expire_time

access token的有效时间。

3600 s

1-72000 s

refresh_token_expire_time

refresh token的有效时间。

7200 s

1-72000 s

app_token_uri

获取Token的uri。

/v1/apigw/oauth2/token

-

app_token_key

Token的加密Key。

-

-

app_basic

是否开启app_basic认证方式。

是

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

-

-

off

on/off

app_secret

是否支持app_secret认证方式。

是

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

-

-

off

on/off

backend_token_allow

是否支持普通租户透传Token到后端。

是

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

backend_token_allow_users

透传Token到后端普通租户白名单，匹配普通租户domain name正则表达式。

-

-

sign_basic

签名密钥是否支持Basic类型。

否

-

-

-

-

-

multi_auth

API是否支持双重认证方式。

否

-

-

-

-

-

backend_client_certificate

是否开启后端双向认证。

是

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

enable

是否开启。

off

on/off

ca

双向认证信任证书。

-

-

content

双向认证证书。

-

-

key

双向认证信任私钥。

-

-

ssl_ciphers

是否支持https加密套件。

是

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

ssl_ciphers

支持的加解密套件。ssl_ciphers数组中只允许出现默认值中的字符串，且数组不能为空。

-

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

app_config

是否支持应用配置。

否

-

-

-

-

-

green_tunnel

授权是否支持绿色通道。

否

-

-

-

-

-

app_route

是否支持IP访问。

是

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

-

-

off

on/off

default_group_hide

是否隐藏默认分组。注意：隐藏默认分组后不支持IP访问，如想使用IP访问，建议开启app_route配置。

是

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

-

-

off

on/off

cascade

是否开启级联功能。

是

{"name":"app_route","enable":true,"config": "{\"enable\": \"on\", \"cascade_auth_key\": \"abcdefabcdefabcdefabcdefabcdef11\", \"cascade_instance_ids\":\"104e4816-1e9c-4345-be3a-14528727d0e3\"}"}

enable

是否开启级联功能。

off

on/off

cascade_auth_key

用于生成级联认证token的加密key。

-

-

cascade_instance_ids

级联时允许作为上级的实例ID。

-

-

sandbox

是否支持LDA函数沙箱配置。

是

{"name":"sandbox","enable":true,"config": "{\"max_cpu_time\": 30000, \"max_memory\": 1073741824}"}

max_cpu_time

允许函数API中执行的CPU时间占用的最高时长。单位：毫秒。

60000 ms

1-1000000 ms

max_memory

允许函数API中执行的内存大小。单位：字节。

256 M

1-9536 M

livedata_config

是否支持后端服务自定义配置。同时存在sandbox和livedata_config时，优先使用livedata_config。

是

{"name":"sandbox","enable":true,"config": "{\"max_cpu_time\": 30000, \"max_memory\": 1073741824, \"max_memory\": 1073741824, \"dataapi_return_type\": \"no_string\", \"gw_address_protocol\": \"http\", \"livedata_env\": \"offline\",\"procedure_async\": \"off\"}"}

max_cpu_time

允许函数API中执行的CPU时间占用的最高时长。单位：毫秒。

60000 ms

1-1000000 ms

max_memory

允许函数API中执行的内存大小。单位：字节。

256 M

1-9536 M

livedata_env

自定义后端的运行模式，设置为online时，自定义后端API将会按照线上格式返回。

online

online/offline

gw_address_protocol

DICT:gw_rest_float_addr变量中使用的默认请求协议。

none

http/https/none

procedure_async

存储过程是否使用异步执行。

off

on/off

dataapi_return_type

数据API的返回格式。

no_string

string/no_string

real_ip_from_xff

是否使用X-Forwarded-For头中的IP作为ACL、流控的判断依据。

是

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

enable

是否开启。

off

on/off

xff_index

X-Forwarded-For头中IP的排序序号，值允许为正数、负数、0。

• 值为0或正数时，获取X-Forwarded-For头中对应索引的IP。
• 值为负数时，按倒序方式从X-Forwarded-For头中获取IP。

例如到达API网关的X-Forwarded-For头中依次有IP1，IP2，IP3三个IP地址，xff_index取0时获取IP1，xff_index取1时获取IP2，xff_index取-1时获取IP3，xff_index取-2时获取IP2。

-1

int32有效值

apiclient_first_use_x_hw_id

自定义后端的ApiClient类是否优先使用X-HW-ID字段进行校验。

是

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

-

-

off

on/off

custom_log

是否支持自定义日志功能。

是

{"name":"custom_log","enable":true,"config": "{\"custom_logs\":[{\"location\":\"header\",\"name\":\"test\"},{\"location\":\"query\",\"name\":\"x-query-test001\"}]}"}

custom_logs

自定义日志中要打印参数的集合，数量不超过10个。

-

-

location

参数位置。

-

header/query/cookie

name

参数名称。

-

-

real_ip_header_getter

是否开启用户自定义Header获取源IP地址，作为访问控制、流控策略的源IP生效依据。

是

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

enable

是否开启。

off

on/off

header_getter

获取用户源IP地址的自定义Header。

-

-

vpc_name_modifiable

负载通道名称是否支持修改。

是

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

-

-

on

on/off

default_group_host_trustlist

DEFAULT分组中的API是否支持非本实例IP访问。

是

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

enable

是否开启。

off

on/off

hosts

非本实例IP列表。

-

-

data_api_column_types_converted_to_string

数据后端是否支持数据列类型转换String类型。

是

{"name": "data_api_column_types_converted_to_string", "enable": true, "config": "{\"enable\":\"on\",\"column_types\":[\"nvarchar2\"]}"}

enable

是否开启。

off

on/off

column_types

数据列类型列表：勾选要转换String类型的数据列类型，当前仅支持nvarchar2类型。

-

-

sse_strategy

是否支持sse传输策略开关。

是

{

"name": "sse_strategy",

"enable": true,

"config": "on"

}

-

-

off

on/off

request_custom_config

支持自定义配置客户端请求相关参数。

是

{

"name": "request_custom_config",

"enable": true,

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

}

http2

HTTP/2协议的开关。

on

on/off

client_body_timeout

客户端请求体超时时间。

8 秒

1-60 秒

api_uri_no_escape

API中请求path的请求参数是否支持不转义

是

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

enable

是否开启

false

true/false