修改实例配置参数

参数

参数的名称。把光标移到参数名称前的“”，可查看参数的具体功能说明。

参数默认值

参数的系统默认值。

参数范围

参数的取值范围。

参数运行值

参数当前的设置值。

更新时间

参数的最近一次更新时间。若参数从未修改过，该更新时间为空。

操作

单击“编辑”，可修改“参数运行值”。

ratelimit_api_limits

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

request_body_size

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

backend_timeout

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

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_api_key

app_api_key认证方式开关。启用后，可在API请求中添加“apikey”参数，携带集成应用的Key（或客户端的AppKey）进行API的调用认证。

app_basic

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

app_jwt

app_jwt认证方式开关。启用后，可在API请求中添加“Authorization”和“Timestamp”参数，携带集成应用的Key和Secret（或客户端的AppKey和AppSecret）以及时间戳进行API的调用认证。

app_jwt_auth_header：app_jwt认证头，即API请求中携带app_jwt认证信息的Header参数，默认为Authorization。

app_secret

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

public_key

public_key类型后端签名开关。启用后，可在后端签名认证中使用public_key类型签名。

public_key_uri_prefix：获取public_key对应secret的uri前缀。具体uri格式为：https://{服务集成APIC 连接地址}{public_key_uri_prefix}{public_key签名密钥名称}。

app_route

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

使用app_router方式进行调用的API，其所属应用以及授权应用下不能有路径相同的API，如果有相同路径的API，在使用app_router前需要删除所有路径相同的API，并重新创建。

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_id

自定义后端的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。

custom_log

自定义日志功能开关。开启自定义日志功能后，ROMA Connect实例下所有API的调用日志中会打印指定位置（header、query和cookie）和指定名称的参数值。

启用后，需单击“添加”，添加需在调用日志中打印的参数。

• 自定义日志只支持打印客户端发起的请求中携带的信息，不支持打印APIC中定义的常量参数和系统参数信息。
• 自定义日志最多支持添加10个参数，且所有参数字段总大小不超过2KB。
• 自定义日志打印的参数值中部分特殊字符会进行编码，例如：加号（+）会被编码为空格，双引号（"）会被编码为“\x22”，反斜杠（\）会被编码为“\x5C”。

real_ip_header_getter

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

vpc_name_modifiable

负载通道名称支持修改开关。开启后可修改负载通道名称，但当前实例的负载通道无法通过“VPC通道管理-项目级”API接口操作。

default_group_host_trustlist

DEFAULT分组中的API是否支持非本实例IP访问。开启后，IP列表中配置的地址可访问DEFAULT分组中的API，请根据业务需要谨慎添加。

• 缺省分组是否支持配置非本实例IP：DEFAULT分组中的API是否支持非本实例IP访问开关。
• 非本实例IP列表：填写允许访问DEFAULT分组中API的非本实例主机地址，多个IP地址间使用英文分号（;）分隔。

data_api_column_types_converted_to_string

数据后端是否支持数据列类型转换String类型。开启后，勾选的数据列类型允许转换为String类型数据。

• 是否支持配置数据列类型：数据后端的数据列类型转换String类型开关。
• 数据列类型列表：勾选要转换String类型的数据列类型，当前仅支持nvarchar2类型。

kafka_log_plugin_options

Kafka日志推送插件可推送的请求体和响应体大小配置。

• request_body_size：Kafka日志推送插件可推送的请求体大小上限。
• response_body_size：Kafka日志推送插件可推送的响应体大小上限。

sse_strategy

SSE传输策略开关，默认关闭。启用后，支持通过使用Server-Sent Events (SSE)按照流式输出后端API的响应内容，可以实现逐字符渲染。

sse_strategy配置完成后，如需修改，至少需要1分钟后。

request_custom_config

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

• HTTP/2：HTTP/2协议的开关，默认为开启状态。
• request_body_timeout：客户端请求体超时时间的修改，默认为8秒。网络状况差或请求体过大的情况下可适当调整该参数。

客户端请求自定义配置修改完成后，如需再次修改，至少需要1分钟后。

gzip

对响应请求使用gzip压缩，用于减少公网流量。默认未配置gzip压缩，配置后1分钟生效，请谨慎修改。

启用后，可配置comp_level参数，comp_level表示压缩级别，值越大表示性能消耗越大，一般默认为6。

• 响应请求体大于1KB时，您可以使用gzip压缩文件（即1KB以下的文件不做压缩）。
• gzip压缩支持的文件类型有text/xml、text/plain、text/css、application/javascript、application/x-javascript、application/rss+xml、text/javascript、image/tiff、image/svg+xml、application/json、application/xml
• 启用gzip压缩后，须在请求中添加请求头“Accept-Encoding: gzip”。
• gzip配置完成后，如需修改，至少需要1分钟后。

custom_auth_header

认证头域自定义配置开关，默认关闭。启用后，参数“app_auth_header”和“backend_sign_header”的初始值为空，与不启用效果一致。

如果配置“app_auth_header”的“参数运行值”，那么对于APP认证的API，请求header中携带APP认证信息的参数为此处“app_auth_header”的值；如果配置“backend_sign_header”的“参数运行值”，那么对于绑定HMAC或者Basic Auth类型签名密钥策略的API，APIC到后端服务的请求header中携带签名信息的参数为此处“backend_sign_header”的值。

配置后会影响当前实例下所有APP认证或签名密钥策略（HMAC/Basic Auth类型），请谨慎配置。

api_uri_no_escape

API的URL中的Path转义处理开关。默认关闭，表示URL中的Path会进行转义处理。

开启“api_uri_no_escape”开关后，使用Path不转义的功能请参见表3。

op_trusted_ips

API认证方式为华为IAM认证时可配置。

控制 API 的调用来源 IP 。新建实例的“op_trusted_ips”默认禁止所有源IP访问，需要在“配置参数”页面的“op_trusted_ips”中添加源IP网段才可以访问。

访问控制策略中的IP地址控制属于API级别控制IP，此处的IP控制属于实例级别控制IP。

API定义

APIC进行匹配路由的Path

/{path}

/aa%2Faa

/aa/aa

/aa%2Faa

参数编排

后端服务参数使用的Path

-

-

/aa/aa

/aa%2Faa

http到https重定向

重定向使用的Path

-

-

/aa/aa

/aa%2Faa

策略后端

策略条件为请求入参的Path

-

-

/aa/aa

/aa%2Faa

第三方认证策略

API绑定第三方认证策略后，传递到第三方的Path

-

-

/aa/aa

/aa%2Faa

kafka日志推送策略

API绑定kafka日志推送策略后，使用的请求Path

-

-

/aa/aa

/aa%2Faa

负载通道

使用URI哈希分发算法的负载通道时，APIC用来转发的Path

-

-

/aa/aa

/aa%2Faa

FunctionGraph后端

API的后端类型为FunctionGraph时，发送到函数请求Path

-

-

/aa/aa

/aa%2Faa

自定义认证

API认证方式选择自定义认证时，发送到函数请求Path

-

-

/aa/aa

/aa%2Faa