API网关专享版实例的部分基本信息以及配置参数,可以从控制台修改。
修改基本信息
专享版实例创建后,您可能需要调整实例的一些配置,比如调大出公网的带宽,以便 支撑更高的API请求流量。
步骤1 登录管理控制台。
步骤2 在管理控制台左上角单击 ,选择区域。
步骤3 单击管理控制台左上角 ,然后单击“API网关 APIG”。
步骤4 在左侧导航单击“专享版”,进入专享版实例列表页,单击“查看控制台”,进入API 开发与调用管理页面。
步骤5 在实例基本信息页签,找到您需要调整的基本信息项并进行修改。
表2-2 专享版实例基本信息修改
可修改项 说明
实例名称 填写实例的名称,根据规划自定义。
描述 填写实例的描述信息。
时间窗 指允许云服务技术支持对实例进行维护的时间段。如有维护 需要,技术支持会提前与您沟通确认。
建议选择业务量较少的时间段。
安全组 安全组用于设置端口访问规则,定义哪些端口允许被外部访 问,以及允许访问外部哪些地址与端口。
例如,后端服务部署在外部网络,则需要设置相应的安全组 规则,允许访问后端服务地址与API调用监听端口。
说明
● 更换安全组时,新的安全组须满足专享版实例的前端API调用以 及访问后端服务所需出入规则。
● 如果开启公网入口,安全组入方向需要放开80(HTTP)和443
(HTTPS)端口的访问权限。
弹性IP地址 指允许外部服务通过弹性IP地址,调用专享版实例创建的 API。开启“公网入口”,需要绑定一个“弹性IP地址”,
弹性IP地址另行收费。
您需要使用独立域名/子域名访问,使用子域名访问时存在 单日访问次数限制。
可在创建API分组后,为分组绑定独立域名,独立域名需要 解析到专享版实例的弹性IP。
出口地址 指允许专享版实例API的后端服务部署在外部网络,API网关 为实例开启公网出口。公网出口可随时关闭或开启。
出公网带宽 出公网带宽可配置范围为1~2000Mbit/s,费用按小时计 算,以弹性公网IP服务的价格为准。
可修改项 说明
路由 如果本地数据中心的子网不在以下三个大子网段内,暂时不 支持配置本地路由:10.0.0.0/8-24、172.16.0.0/12-24、
192.168.0.0/16-24。
----结束
配置参数修改
步骤1 登录管理控制台。
步骤2 在管理控制台左上角单击 ,选择区域。
步骤3 单击管理控制台左上角 ,然后单击“API网关 APIG”。
步骤4 在左侧导航单击“专享版”,进入专享版实例列表页,单击“查看控制台”,进入API 开发与调用管理页面。
步骤5 单击“配置参数”页签,找到您需要调整的配置项并进行修改。
表2-3 实例配置参数说明
参数名 参数说明
ratelimit_api_limits API全局默认流控值。API未绑定流控策略时,执行此默 认流控;API绑定流控策略时,则执行绑定的流控策 略。
request_body_size API请求中允许携带的Body大小上限。
backend_timeout 后端响应超时时间上限,可修改范围为1-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请求中添加
“Authorization”参数,携带应用的Key和Secret(或 客户端的AppKey和AppSecret)进行API的调用认证。
参数名 参数说明
app_secret app_secret认证方式开关。启用后,可在API请求中添 加“X-HW-ID”和“X-HW-AppKey”参数,携带应用 的Key和Secret(或客户端的AppKey和AppSecret)进 行API的调用认证。
使用app_secret认证时,需同时关闭app_api_key认证 方式。
app_route 支持IP访问开关。启用后,非DEFAULT分组下的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 负载通道名称是否可修改。
须知
负载通道名称可修改时,当前实例的负载通道无法通过项目级 负载通道管理接口操作。
----结束