Instance Configuration Parameters

ratelimit_api_limits

Default request throttling value applied to all APIs. If no request throttling policy is bound to an API, the total number of times the API can be called is determined by this parameter value. If a request throttling policy has been bound to an API, the total number of times the API can be called is determined by the bound policy.

request_body_size

Maximum size of the body allowed in an API request.

backend_timeout

Maximum timeout duration for ROMA Connect to send a request to a backend service.

app_token

Whether to enable app_token authentication. After this function is enabled, the obtained access token can be used in API requests for authentication during API calling.

• app_token_expire_time indicates the validity period of the access token. Before the access token expires, you must obtain a new access token.
• refresh_token_expire_time indicates the validity period of the refresh token. A refresh token is used to obtain a new access token.
• app_token_uri indicates the URI used for obtaining an access token.
• app_token_key indicates the encryption key of the access token.

app_basic

Whether to enable app_basic authentication. After this function is enabled, you can add the Authorization parameter to an API request to carry the key and secret of an integration application (or the AppKey and AppSecret of a client) for authentication during API calling.

app_secret

Whether to enable app_secret authentication. After this function is enabled, you can add the X-HW-ID and X-HW-AppKey parameters to an API request to carry the key and secret of an integration application (or the AppKey and AppSecret of a client) for authentication during API calling.

If the app_secret authentication mode is used, the app_api_key authentication mode must be disabled.

app_route

Whether to support IP address access. After this function is enabled, APIs in non-DEFAULT groups can be called by using IP addresses.

cascade

Whether to enable the API cascading function. After this function is enabled, APIs can be called across instances.

• cascade_auth_key indicates the encryption key used for authentication between APIs in the cascading relationship.
• cascade_instance_ids indicates the ID list of cascading instances. Only instances specified by this parameter can establish the cascading relationship with the current instance.

default_group_hide

Whether to hide the DEFAULT group. After this function is enabled, the DEFAULT group is hidden.

livedata_config

Custom backend configuration.

• sandbox_max_memory indicates the maximum memory required for executing a script of a function backend.
• sandbox_max_memory indicates the maximum CPU time required for executing a script of a function backend.
• livedata_env indicates the running mode of a custom backend. If this parameter is set to online, the custom backend will return responses in the online format.
• gw_address_protocol indicates the default request protocol transferred through the DICT:gw_rest_float_addr field in a function script.
• procedure_async indicates whether the stored procedure is executed in asynchronous mode.
• dataapi_return_type indicates the response format of a data backend.

backend_client_certificate

Whether to enable two-way authentication for a backend. After this function is enabled, you can configure the two-way authentication for a backend when configuring the backend information during API creation.

ssl_ciphers

HTTPS cipher suite that can be configured. You can select the cipher suites as required.

real_ip_from_xff

Whether to use the IP addresses in the X-Forwarded-For header as the criterion for access control and request throttling.

xff_index: Sequence number of an IP address in the X-Forwarded-For header. The value can be positive, negative, or 0.

• If the value is 0 or positive, obtain the IP address of the corresponding index in the X-Forwarded-For header.
• If the value is negative, obtain the IP address of the indicated reverse sequence in the X-Forwarded-For header.

For example, assume that the X-Forwarded-For header of a request received by API gateway contains three IP addresses: IP1, IP2, and IP3. If the value of xff_index is 0, IP1 is obtained. If the value of xff_index is 1, IP2 is obtained. If the value of xff_index is –1, IP3 is obtained. If the value of xff_index is –2, IP2 is obtained.