检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
默认值“80”,HTTP协议的默认端口。您可以自定义入端口,相关操作请参考自定义APIG的客户端访问端口。不使用HTTP端口,选择“禁止”即可。 HTTPS端口 默认值“443”,HTTPS协议的默认端口。您可以自定义入端口,相关操作请参考自定义APIG的客户端访问端口。不使用HTTPS端口,选择“禁止”即可。
Key)和API网关提供的SDK,对API请求进行签名处理。 自定义认证的函数开发:使用自定义认证时,在函数服务中编写一个函数,将其作为认证服务。 创建用于前端自定义认证的函数:API网关利用函数对收到的API请求进行安全认证。 创建用于后端自定义认证的函数:API后端服务利用函数对来自API网关转发的API请求进行安全认证。
String API的认证方式 NONE:无认证 APP:APP认证 IAM:IAM认证 AUTHORIZER:自定义认证 CRU 是 authorizer_id String 前端自定义认证对象的ID CRU 否 match_mode String API的路由匹配方式: SWA:前缀匹配
说明 选择续费时长 计划自动续费的时长。 自动续费次数 勾选“预设自动续费次数”,可以选择“不限次数”或者“自定义次数”。 “不限次数”:每次实例到期前自动续费。 “自定义次数”:完成设置的自动续费次数后,结束自动续费。例如设置为2,则在2次续费后会结束自动续费。 不勾选“预设自动续费次数”,每次实例到期前自动续费。
log_group 日志组名称。 log_stream 日志流名称。 gateway_responses 是否支持网关自定义响应。 否 - - - - - ratelimit 是否支持自定义流控值。 是 {"name":"ratelimit","enable":true,"config": "{\"api_limits\":
自定义APIG的客户端访问端口 API网关提供自定义实例入端口功能,支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时,一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容,请参考约束与限制。 操作步骤 进入API网关控制台页面。
x-apigateway-cors 含义:API网关定义的API请求是否支持跨域,boolean类型。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-cors:
云容器引擎微服务的服务器分组配置 参数 说明 服务器分组名称 默认为服务标识值,用户也可根据业务需求修改。 权重分配 默认:1,范围0 ~ 100。 说明: 分发算法选择哈希算法时,权重默认为1,且不支持修改。 后端服务端口 后端服务器的访问端口号。不指定端口号或端口号为0时,默认使用负载通道的端口号。
参数 是否必选 类型 说明 x-apigateway-ratelimit 否 String 流控策略 父主题: APIG的API设计文件扩展定义
指定名称的流控策略。 要使用该策略,将x-apigateway-ratelimit属性值引用为该策略名称。 父主题: APIG的API设计文件扩展定义
x-apigateway-match-mode 含义:API网关定义的API请求URL的匹配模式,支持NORMAL和SWA。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get:
x-apigateway-any-method 含义:API网关定义的API请求方法,用以匹配未指定定义的HTTP方法。 作用域:Path Item Object(2.0)/Path Item Object(3.0) 示例: paths: '/path': get:
x-apigateway-ratelimits.policy 含义:流控策略定义。 作用域:x-apigateway-ratelimits 示例: x-apigateway-ratelimits: customRatelimitName: api-limit: 200
x-apigateway-plugins 含义:API网关定义的API插件服务。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-plugins:
专享版-实例自定义入方向端口管理 查询实例指定的自定义入方向端口绑定的域名信息 查询实例的自定义入方向端口列表 新增实例的自定义入方向端口 删除实例指定的自定义入方向端口 父主题: 专享版API(V2)
String API的认证方式 NONE:无认证 APP:APP认证 IAM:IAM认证 AUTHORIZER:自定义认证 CRU 是 authorizer_id String 前端自定义认证对象的ID CRU 否 match_mode String API的路由匹配方式: SWA:前缀匹配
x-apigateway-request-type 含义:API网关定义的API请求类型,支持public和private。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get:
使用独立域名从公网访问的场景 需要将原来的自定义域名的cname记录从共享版分组子域名更改为专享版实例的实例域名{instance-id}.apic.{region-id}.huaweicloudapis.com。 同VPC内使用独立域名从内网访问的场景 需要将原来的自定义域名的cname记录从共享
x-apigateway-auth-type 含义:基于Swagger的apiKey认证格式,定义API网关支持的特有认证方式。 作用域:Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger: securityDefinitions:
functionEndpoints FUNCTION类型后端服务定义 mockEndpoints 否 x-apigateway-backend.mockEndpoints MOCK类型后端服务定义 父主题: APIG的API设计文件扩展定义