ROMA Connect的实例配置参数如下表所示。
表2-13 实例配置参数说明
参数名 参数说明
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_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加密套件,可根据需要选择开启的 加密套件。
apiclient_first_use_x_hw_i
d 自定义后端的ApiClient类是否优先使用X-HW-ID字段 进行校验。
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。
参数名 参数说明
opentracing_options opentracing功能开关。开启opentracing功能后,可以 通过指定类型的调用链工具,对API请求的全链路和各 阶段耗时实现可视化查看,然后通过数据分析对链路进 行优化。
● Tracer:使用的调用链工具类型。
● Trust Incoming Span:在API请求全链路中,是否 允许各节点使用上一节点传入的请求作为当前请求 的父级。仅Trust Incoming Span开启后,才能在调 用链工具中输出完整的调用链路。
● Tracer Endpoint:调用链工具的跟踪地址。
● Propagation:调用链工具使用的信息传输格式。
● Sampler Type:调用链工具的采样器类型。
– const:采样器始终对所有跟踪做出相同的决 定。“Sampler Parameter”为“1”时表示采 样所有跟踪,“Sampler Parameter”为“0”
时表示不采样所有跟踪。
– probabilistic:采样器做出随机采样决策,采样 概率等于“Sampler Parameter”的值。例如,
“Sampler Parameter”为“0.1”时,每10个跟 踪中将采集1个。
– ratelimiting:采样器使用泄漏桶速率限制器来确 保以恒定速率采样。例如,当“Sampler
Parameter”为“2.0”时,它将以每秒2个跟踪 的速率对请求进行采样。
– remote:采样器咨询Jaeger代理,以了解在当前 服务中使用的适当采样策略。该方式允许从 Jaeger后端的中央配置控制服务中获取采样策 略。
● Sampler Parameter:采样器参数,单位为double 类型。仅“Sampler Type”为“const”、
“probabilistic”、“ratelimiting”时需要填写。
说明Tracer类型为jaeger时,用户需要独立部署jaeger-collector服 务,并配置Tracer Endpoint到jaeger-collector服务所在的地 址,默认端口为14250。
custom_log 自定义日志功能开关。开启自定义日志功能后,ROMA Connect实例下所有API的调用日志中会打印指定位置
(header、query和cookie)和指定名称的参数值。
启用后,需单击“添加”,添加需在调用日志中打印的 参数。
real_ip_header_getter 是否开启用户自定义Header获取源ip地址,作为访问 控制、流控策略的源ip生效依据。
vpc_name_modifiable 负载通道名称支持修改开关。开启后可修改负载通道名 称,但当前实例的负载通道无法通过“VPC通道管理-项目级”API接口操作。
2.3.3 创建数据字典
概述
数据字典可以将系统数据库的关键值开放给用户使用。数据字典中的DEVICE_TYPE为 默认数据字典,用户也可自定义创建数据字典。
操作步骤
1. 在实例控制台的“实例信息”页面选择“数据字典”页签。
2. 单击“创建字典”。
3. 在创建字典弹窗中配置数据字典相关信息,完成后单击“确认”。
表2-14 数据字典配置
参数 配置说明
字典编码 填写字典类唯一标识。
字典名称 填写字典类名称。
扩展字段1 作为字典类默认值,预留字段,可不填。
扩展字段2
描述 填写数据字典的描述信息。
4. 数据字典创建完成后,单击字典名称前的“ ”展开字典项列表。
5. 单击“创建字典项”。
6. 在创建字典项弹窗中配置字典项相关信息,完成后单击“确认”。
表2-15 字典项配置
参数 配置说明
项编码 填写字典项唯一标识。
项名称 填写字典项名称。
扩展字段1 作为字典项默认值,预留字段,可不填。
扩展字段2
描述 填写字典项的描述信息。
2.3.4 导入导出资产
概述
ROMA Connect支持把实例的应用和任务资产以文件形式导出到本地,也可以把本地 的资产文件导入ROMA Connect,实现资产的批量迁移。
前提条件
● 资产导入时,需要保证资产导入和导出的实例配置相同,否则会导致资产导入失 败。例如:app_route开启后不允许API之间存在路径冲突,若导出的实例未开启 app_route,导入的实例开启了app_route,如果导入资产包中存在路径冲突的 API,则资产无法导入。
● 不支持导入导出API的流量控制策略、访问控制策略和签名密钥。