更新时间:2024-08-07 GMT+08:00

配置参数

配置参数提供了实例内组件的公共参数配置,通过修改配置参数,可以调整组件的相关功能。

约束与限制

修改实例配置参数会引起APIG业务中断,建议在无业务运行或业务低峰时修改配置参数。

操作步骤

  1. 进入API网关控制台页面。
  1. 在左侧导航栏选择“实例管理”。
  2. 在待配置参数的实例上,单击“查看控制台”或实例名称
  3. 单击“配置参数”页签,找到您需要调整的配置项并进行修改。不同的实例规格展示的配置参数会存在不同,具体以界面为准。

    表1 实例配置参数说明

    参数

    说明

    ratelimit_api_limits

    API全局默认流控值,默认值为200次/秒。API未绑定流控策略时,执行此默认流控;API绑定流控策略时,则执行绑定的流控策略。流控策略的API流量限制值不能超过API全局默认流控值。

    request_body_size

    API请求中允许携带的Body大小上限,默认值为12MB,可修改范围为1MB~9536MB。

    backend_timeout

    后端响应超时时间上限,默认值为60000ms,可修改范围为1ms~600000ms。

    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请求中添加Header参数“Authorization”,参数值为"Basic"+base64(appkey:appsecret),其中appkey和appsecret分别为凭据的Key和Secret。

    app_secret

    app_secret认证方式开关,默认关闭。启用后,可在API请求中添加“X-HW-ID”和“X-HW-AppKey”参数,携带凭据的Key和Secret进行API的调用认证。

    app_route

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

    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。

    vpc_name_modifiable

    负载通道名称是否可修改,默认可修改。

    须知:

    负载通道名称可修改时,当前实例的负载通道无法通过项目级负载通道管理接口操作。

    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,API网关到后端服务的请求header中携带签名信息的参数为此处“backend_sign_header”的值。

    须知:

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

    custom_log

    自定义日志功能开关,默认关闭。开启自定义日志功能后,实例下所有API的调用日志中会在指定位置打印指定参数的值。

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

    须知:
    • 自定义日志只支持打印由客户端发起的请求信息,不支持打印在APIG中定义的常量参数和系统参数。
    • 自定义日志最多可配置10个字段,且字段大小总和不得超过2KB。
    • 参数值中的部分特殊字符会进行编码,例如:加号(+)会被编码为空格“ ”,双引号(")会被编码为“\x22”,反斜杠(\)会被编码为“\x5C”。