计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive
本文导读

展开导读

文档首页/ API网关 APIG/ API参考/ 附录/ 实例支持的APIG特性

实例支持的APIG特性

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

专享版实例支持的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

是否支持设置请求体大小上限。

{"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

是否支持断路器,能够实现过载情况下服务能力降级。

-

-

-

-

-

sm_cipher_type

加密本地敏感数据时,是否支持应用商密加密算法。

-

-

-

-

-

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

ip_control

是否开启访问控制。

{"enable": true,"name":"ip_control","config":"{\"control_type\":\"white\",\"white_ip_list\":\"\",\"black_ip_list\":\"\"}"}

control_type

控制类型。

black

black/white

white_ip_list

白名单IP列表。

-

-

black_ip_list

黑名单IP列表。

-

-

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容