更新时间:2022-12-05 GMT+08:00

实例配置参数说明

ROMA Connect的实例配置参数如下表所示。

表1 实例配置参数说明

参数名

参数说明

ratelimit_api_limits

API全局默认流控值。API未绑定流控策略时,执行此默认流控;API绑定流控策略时,则执行绑定的流控策略。

request_body_size

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

backend_timeout

ROMA Connect到后端服务的请求超时时间。

app_token

app_token认证方式开关。启用后,可在API请求中使用获取的access_token进行API的调用认证。

  • app_token_expire_time:access_token的有效时间,在access_token到期前,需要获取新的access_token。
  • refresh_token_expire_time:refresh_token的有效时间。refresh_token用于获取新的access_token。
  • app_token_uri:获取access_token的uri。
  • app_token_key:access_token的加密key。

app_basic

app_basic认证方式开关。启用后,可在API请求中添加“Authorization”参数,携带集成应用的Key和Secret(或客户端的AppKey和AppSecret)进行API的调用认证。

app_secret

app_secret认证方式开关。启用后,可在API请求中添加“X-HW-ID”和“X-HW-AppKey”参数,携带集成应用的Key和Secret(或客户端的AppKey和AppSecret)进行API的调用认证。

使用app_secret认证时,需同时关闭app_api_key认证方式。

app_route

支持IP访问开关。启用后,非DEFAULT分组下的API可以使用IP地址调用。

cascade

API级联功能开关。启用后,可以实现跨实例间的API调用。

  • cascade_auth_key:级联认证的加密密钥,用于级联API之间的调用认证。
  • cascade_instance_ids:级联实例的实例ID列表,仅允许的实例可级联到当前实例。

default_group_hide

DEFAULT分组隐藏开关。启用后,DEFAULT分组被隐藏。

livedata_config

自定义后端配置。

  • sandbox_max_memory:函数后端中执行脚本所允许使用的内存最大值。
  • sandbox_max_cpu_time:函数后端中执行脚本所允许占用的CPU时间最大值。
  • livedata_env:自定义后端的运行模式,设置为online时,自定义后端将会按照线上格式返回。
  • gw_address_protocol:函数脚本中,通过DICT:gw_rest_float_addr字段传递的默认请求协议。
  • procedure_async:存储过程是否使用异步方式执行。
  • dataapi_return_type:数据后端的返回格式。

backend_client_certificate

后端双向认证开关。启用后,创建API配置后端服务时,可配置后端双向认证。

ssl_ciphers

可支持配置的https加密套件,可根据需要选择开启的加密套件。

real_ip_from_xff

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

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

  • xff_index值为0或正数时,获取X-Forwarded-For头中对应索引的IP。
  • xff_index值为负数时,按倒序方式从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。