Parameter Name

Name of a parameter. You can move the cursor to next to a parameter name to view its description.

Default Value

Default value of a parameter.

Value Range

Value range of a parameter.

Current Value

Current value of a parameter.

Updated

Time when a parameter was last updated. If the parameter has never been modified, this parameter is left blank.

Operation

Click Edit to change the value of Current Value.

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.

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_cpu_time 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 return 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.

apiclient_first_use_x_hw_id

Whether to preferentially use the X-HW-ID field to verify the ApiClient class of the custom backend.

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.

opentracing_options

Whether to enable the opentracing function. After the opentracing function is enabled, you can use the tracing tool of a specified type to view the entire link of an API request and the time consumed at each phase, and then optimize the link based on data analysis.

• Tracer indicates the type of the tracing tool.
• Trust Incoming Span indicates whether to allow each node to use a request transferred from the previous node as the parent request of the current request in the entire API request link. A complete link can be displayed in the tracing tool only if Trust Incoming Span is enabled.
• Tracer Endpoint indicates the tracing address of the tracing tool.
• Propagation indicates the information transmission format used by the tracing tool.
• Sampler Type indicates the type of the sampler of the tracing tool.
  • const: The sampler always makes the same decision for all trace tasks. If Sampler Parameter is set to 1, all trace tasks are sampled. If Sampler Parameter is set to 0, no trace tasks are not sampled.
  • probabilistic: The sampler makes a random sampling decision. The sampling probability is equal to the value of Sampler Parameter. For example, if Sampler Parameter is set to 0.1, one of every 10 trace tasks is sampled.
  • ratelimiting: The sampler uses the leaky bucket rate limiter to ensure that the sampling rate is constant. For example, if Sampler Parameter is set to 2.0, the request is sampled at the rate of two traces per second.
  • remote: The sampler consults the Jaeger agent for the appropriate sampling policy used in the current service. This method allows the sampling policy to be obtained from the central configuration control service at the Jaeger backend.
• Sampler Parameter indicates the sampler parameter. The unit is of the double type. This parameter is mandatory only if Sampler Type is set to const, probabilistic, or ratelimiting.

custom_log

Indicates whether to enable the custom log function. After the custom log function is enabled, the specified location (header, query, and cookie) and parameter values are printed in the calling logs of all APIs in the ROMA Connect instance.

After this function is enabled, click Add to add the parameters to be printed in the calling logs.

real_ip_header_getter

Whether to obtain the source IP address from the user-defined header.