实例支持的APIG特性
专享版实例支持的APIG特性。
![](https://support.huaweicloud.com/intl/zh-cn/my-kualalumpur-1-api-apig/public_sys-resources/note_3.0-zh-cn.png)
若当前实例中无相关特性,可联系技术支持申请升级实例解决。
特性名称 |
特性描述 |
特性是否可配置 |
特性配置示例 |
特性配置参数 |
参数描述 |
参数默认值 |
参数范围 |
---|---|---|---|---|---|---|---|
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 |
是否支持设置请求体大小上限。 |
是 |
{"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 |
API网关到后端服务的超时时间上限。 |
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的有效时间。 |
3600s |
1-72000s |
||||
refresh_token_expire_time |
refresh token的有效时间。 |
7200s |
1-72000s |
||||
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 |
是否开启public_key认证方式。 |
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\": [\"user_name\"]}"} |
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 |
route |
是否支持自定义路由。 |
否 |
- |
- |
- |
- |
- |
cors |
是否支持API使用插件功能。 |
否 |
- |
- |
- |
- |
- |
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有效值 |
||||
app_route |
是否支持ip访问。 |
是 |
{"name":"app_route","enable":true,"config": "on"} |
- |
- |
off |
on/off |
vpc_name_modifiable |
是否支持修改负载通道名称。 |
是 |
{"name":"vpc_name_modifiable","enable":true,"config": "on"} |
- |
- |
on |
on/off |
default_group_host_trustlist |
DEFAULT分组是否支持配置非本实例IP访问。 |
是 |
{"name":"default_group_host_trustlist","enable": true,"config": "{\"enable\":\"on\",\"hosts\":[\"123.2.2.2\",\"202.2.2.2\"]}"} |
enable |
是否开启。 |
- |
on/off |
hosts |
非本实例IP列表。 |
- |
- |
||||
throttle_strategy |
是否启用流控模式。 |
是 |
{"name":"throttle_strategy","enable":true,"config": "{\"enable\": \"on\",\"strategy\": \"local\"}"} |
enable |
是否开启。 |
off |
on/off |
strategy |
流控模式。 |
- |
cluster/local |
||||
custom_log |
是否支持用户自定义API请求中的HEADER、QUERY、COOKIE参数值打印到日志。 |
是 |
{"name":"custom_log","enable":true,"config": "{\"custom_logs\":[{\"location\":\"header\",\"name\":\"a1234\"}]}"} |
custom_logs |
自定义日志。 |
- |
数量不超过10个 |
location |
位置。 |
header/query/cookie |
|||||
name |
名称。 |
- |
|||||
real_ip_header_getter |
是否开启通过用户自定义的Header获取用户源IP地址。 |
是 |
{"name":"real_ip_header_getter","enable":true,"config": "{\"enable\": \"on\",\"header_getter\": \"header:testIP\"}"} |
enable |
是否开启。 |
off |
on/off |
header_getter |
获取用户源IP地址的自定义Header。 |
- |
- |
||||
policy_cookie_param |
是否开启策略后端条件支持cookie类型。 |
是 |
{"name":"policy_cookie_param","enable":true,"config": "on"} |
- |
- |
off |
on/off |
app_quota |
是否支持客户端配额策略。 |
否 |
- |
- |
- |
- |
- |
app_acl |
是否支持流控策略。 |
否 |
- |
- |
- |
- |
- |
set_resp_headers |
是否支持响应header插件。 |
否 |
- |
- |
- |
- |
- |
vpc_backup |
是否支持VPC通道的主备配置。 |
否 |
- |
- |
- |
- |
- |
sign_aes |
签名密钥是否支持AES加密方式。 |
否 |
- |
- |
- |
- |
- |
kafka_log |
是否支持增删改查kafka日志插件。 |
否 |
- |
- |
- |
- |
- |
backend_retry_count |
是否支持API配置重试次数。 |
否 |
- |
- |
- |
- |
- |
policy_sys_param |
策略后端条件来源是否支持系统参数。 |
否 |
- |
- |
- |
- |
- |
breaker |
是否支持断路器。 |
否 |
- |
- |
- |
- |
- |
content_type_configurable |
获取API列表的接口返回信息中是否存在API的请求参数类型信息(Content-Type)。 |
否 |
- |
- |
- |
- |
- |
rate_limit_plugin |
是否支持流控插件。 |
否 |
- |
- |
- |
- |
- |
breakerv2 |
是否支持断路器,能够实现过载情况下服务能力降级。 |
否 |
- |
- |
- |
- |
- |
rate_limit_algorithm |
是否支持切换流控算法。 |
否 |
- |
- |
- |
- |
- |
gzip |
是否对响应请求使用gzip压缩。 |
是 |
{ "name" : "gzip", "config" : {\"comp_level\":6}, "enable" : true } |
comp_level |
gzip压缩级别或压缩水平。值为介于1到9之间的整数,表示压缩的程度,数字越大表示压缩得越好但耗费的时间也越多。 |
6 |
1-9 |
sse_strategy |
是否支持sse传输策略开关。 |
是 |
{ "name": "sse_strategy", "enable": true, "config": "on" } |
- |
- |
off |
on/off |
authorizer_context_support_num_bool |
自定认证返回的context里键值对的值是否支持number类型和boolean类型。 |
否 |
- |
- |
- |
- |
- |
custom_auth_header |
APP认证和签名密钥策略是否支持认证头域自定义配置。 |
是 |
1:{ "name": "custom_auth_header", "enable": true, "config": "{\"app_auth_header\":\"app-header\", \"backend_sign_header\":\"back-header\"}" } |
app_auth_header |
请求头中的APP认证的签名信息的头域可以由此处的配置项承载。 |
- |
支持英文、数字、中划线、下划线,以英文开头,3-64个字符,可以为空,不能以x-apig、x-sdk开头,不区分大小写,不能是x-stage、authorization,不区分大小写 |
backend_sign_header |
签名密钥策略(BASIC、AUTH和HMAC)传到后端的签名信息的头域可以由此处的配置项承载。 |
- |
|||||
request_custom_config |
支持自定义配置客户端请求相关参数。 |
是 |
{ "name": "request_custom_config", "enable": true, "config": "{\"http2\":\"on\",\"client_body_timeout\":10}" } |
http2 |
HTTP/2协议的开关。 |
on |
on/off |
client_body_timeout |
客户端请求体超时时间。 |
8s |
1-60s |
||||
gateway_responses_support_header |
分组自定义响应支持自定义响应头。 |
否 |
- |
- |
- |
- |
- |
api_uri_no_escape |
API中请求path的请求参数是否支持不转义。 |
是 |
{"name":"api_uri_no_escape","enable":true,"config":""} |
enable |
是否开启。 |
false |
true/false |