API网关 APIGAPI网关 APIG

文档首页> API网关 APIG> API参考> 附录> 实例支持的APIG特性
更新时间:2021/06/18 GMT+08:00
分享

实例支持的APIG特性

实例支持的专享版APIG特性。

若当前实例中无相关特性,可提交工单申请升级实例解决。

特性名称

特性描述

特性是否可配置

特性配置示例

特性配置参数

参数描述

参数默认值

参数范围

lts

是否支持shubao访问日志上报功能。

{"name":"lts","enable":true,"config": "{\"group_id\": ",\"topic_id\":\"\",\"log_group\":\"\",\"log_stream\":\"\"}"}

group_id

日志组ID

-

-

topic_id

日志流ID

-

-

log_group

日志组名称

-

-

log_stream

日志流名称

-

-

gateway_responses

是否支持网关自定义响应。

-

-

-

-

-

ratelimit

是否支持自定义流控值。

{"name":"ratelimit","enable":true,"config": "{\"api_limits\": 500}"}

api_limits

API全局默认流控值。注意:如果配置过小会导致业务持续被流控,请根据业务谨慎修改。

200 次/秒

1-1000000 次/秒

request_body_size

是否支持指定最大请求Body大小。

{"name":"request_body_size","enable":true,"config": "104857600"}

request_body_size

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

12 M

1-9536 M

backend_timeout

是否支持配置后端API超时时间。

{"name":"backend_timeout","enable":true,"config": "{"max_timeout": 500}"}

max_timeout

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

60000 ms

1-600000 ms

app_token

是否开启app_token认证方式。

{"name":"app_token","enable":true,"config": "{\"enable\": \"on\", \"app_token_expire_time\": 3600, \"app_token_uri\": \"/v1/apigw/oauth2/token\", \"refresh_token_expire_time\": 7200}"}

enable

是否开启

off

on/off

app_token_expire_time

access token的有效时间

3600 s

1-72000 s

refresh_token_expire_time

refresh token的有效时间

7200 s

1-72000 s

app_token_uri

获取token的uri

/v1/apigw/oauth2/token

-

app_token_key

token的加密key

-

-

app_api_key

是否开启app_api_key认证方式。

{"name":"app_api_key","enable":true,"config": "on"}

-

-

off

on/off

app_basic

是否开启app_basic认证方式。

{"name":"app_basic","enable":true,"config": "on"}

-

-

off

on/off

app_secret

是否支持app_secret认证方式。

{"name":"app_secret","enable":true,"config": "on"}

-

-

off

on/off

app_jwt

是否支持app_jwt认证方式。

{"name":"app_jwt","enable":true,"config": "{\"enable\": \"on\", \"auth_header\": \"Authorization\"}"}

enable

是否开启app_jwt认证方式。

off

on/off

auth_header

app_jwt认证头

Authorization

-

public_key

是否支持public_key类型的后端签名。

{"name":"public_key","enable":true,"config": "{\"enable\": \"on\", \"public_key_uri_prefix\": \"/apigw/authadv/v2/public-key/\"}"}

enable

是否开启app_jwt认证方式。

off

on/off

public_key_uri_prefix

获取public key的uri前缀

/apigw/authadv/v2/public-key/

-

backend_token_allow

是否支持普通租户透传token到后端。

{"name":"backend_token_allow","enable":true,"config": "{\"backend_token_allow_users\": [\"paas_apig_wwx548366_01\"]}"}

backend_token_allow_users

透传token到后端普通租户白名单,匹配普通租户domain name正则表达式

-

-

sign_basic

签名秘钥是否支持basic类型。

-

-

-

-

-

multi_auth

API是否支持双重认证方式。

-

-

-

-

-

backend_client_certificate

是否开启后端双向认证。

{"name":"backend_client_certificate","enable":true,"config": "{\"enable\": \"on\",\"ca\": \"\",\"content\": \"\",\"key\": \"\"}"}

enable

是否开启

off

on/off

ca

双向认证信任证书

-

-

content

双向认证证书

-

-

key

双向认证信任私钥

-

-

ssl_ciphers

是否支持https加密套件。

{"name":"ssl_ciphers","enable":true,"config": "config": "{\"ssl_ciphers\": [\"ECDHE-ECDSA-AES256-GCM-SHA384\"]}"}

ssl_ciphers

支持的加解密套件。ssl_ciphers数组中只允许出现默认值中的字符串,且数组不能为空。

-

ECDHE-ECDSA-AES256-GCM-SHA384,ECDHE-RSA-AES256-GCM-SHA384,ECDHE-ECDSA-AES128-GCM-SHA256,ECDHE-RSA-AES128-GCM-SHA256,ECDHE-ECDSA-AES256-SHA384,ECDHE-RSA-AES256-SHA384,ECDHE-ECDSA-AES128-SHA256,ECDHE-RSA-AES128-SHA256

real_ip_from_xff

是否开启使用X-Forwarded-For头中的ip作为ACL、流控的判断依据

{"name": "real_ip_from_xff","enable": true,"config": {"enable": "on","xff_index": -1}}

enable

是否开启

off

on/off

xff_index

X-Forwarded-For头中IP的排序序号;值允许取正数、负数、0;取0或正数时,获取X-Forwarded-For头中对应索引的IP;取负数时,按倒序方式从X-Forwarded-For头中获取IP。例如到达API网关的X-Forwarded-For头中依次有IP1,IP2,IP3 三个IP地址,xff_index取0时获取IP1,xff_index取1时获取IP2,xff_index取-1时获取IP3

-1

int32有效值

分享:

    相关文档

    相关产品