检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
导入API 操作场景 API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
过滤查询结果 查询资源列表时(例如,查询API列表),系统支持按照查询对象的属性过滤查询结果。 示例: GET /v1.0/apigw/apis?id=xxxx 父主题: 附录
enable_adaptive_control 否 String 是否开启动态流控: TRUE FALSE 暂不支持 user_call_limits 否 Integer 用户流量限制是指一个API在时长之内每一个用户能访问的次数上限,该数值不超过API流量限制值。输入的值不超过2147483647。正整数。
DEFAULT分组 enable_fullstack_ipv6 Boolean 实例是否支持全量IPv6 true:支持,实例入口和实例出口都支持IPV6 false:不支持,仅实例入口支持IPV6 is_releasable Boolean 实例是否可释放 true:可释放 false:不可释放
x-apigateway-match-mode 含义:API网关定义的API请求URL的匹配模式,支持NORMAL和SWA。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get:
nge”、“none_value”、“default”时需要配置。 填写参数映射信息。支持英文、数字、下划线、中划线,且只能以英文开头,长度为1~128个字符。多个参数值用英文逗号分隔,最多支持3000个参数。 单击“新增映射信息”,可添加新的映射信息。 编排前的请求参数值 当“
enable_adaptive_control 否 String 是否开启动态流控: TRUE FALSE 暂不支持 user_call_limits 否 Integer 用户流量限制是指一个API在时长之内每一个用户能访问的次数上限,该数值不超过API流量限制值。输入的值不超过2147483647。正整数。
实例更新或绑定EIP 功能介绍 实例更新或绑定EIP(仅当实例为LVS类型时支持) 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/eip 表1 路径参数 参数 是否必选 参数类型 描述
应用场景 API网关支持http重定向到https功能。当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以使用API网关的重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。(2022年11月30日之后创建的实例支持http重定向到https)
的通信。 如果使用VPC通道,检查VPC通道业务端口、健康检查端口、后端服务器添加是否均正常。 如果VPC通道类型为微服务,检查APIG实例是否添加路由。详细操作请参见负载通道章节。共享版APIG后端不支持配置内网ELB。 父主题: 调用API
说明 协议 仅在“请求协议”为“HTTP&HTTPS”时,支持修改。 方法 仅在“Method”为“ANY”时,支持修改。 路径 仅在“匹配模式”为“前缀模式”时,支持自定义路径。 路径参数 仅在“Path”中存在“{}”时,支持修改。 请求头 HTTP Headers的参数与参数值。
x-apigateway-auth-type 是 String API网关认证方式,支持AppSigv1、IAM。 type 是 String 认证类型,仅支持apiKey。 name 是 String 用于认证的参数名称。 in 是 String 仅支持header。 description 否 String
自定义认证:APIG支持用户以函数自定义API认证方式,丰富鉴权逻辑。 证书校验:APIG支持对后端服务进行证书校验。 身份认证:APIG提供签名密钥进行后端访问身份认证。 访问控制 流量控制:APIG通过凭据、API、IP、用户等多维度的流控策略保护系统。 黑白名单:APIG支持系统级和API级别的IP黑白名单,拒绝恶意访问。
服务名称标签非必填,必须以APIG-SN-开头 其它标签非必填,且不能以APIG-SN-开头 cors 否 Bool 是否支持跨域 TRUE:支持 FALSE:不支持 默认:FALSE body_remark 否 String API请求体描述,可以是请求体示例、媒体类型、参数等信息
域名解绑SSL证书 功能介绍 域名解绑SSL证书。目前暂时仅支持单个解绑,请求体当中的certificate_ids里面有且只能有一个证书ID。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。 调用方法 请参见如何调用API。 URI POST /v2/{project
服务名称标签非必填,必须以APIG-SN-开头 其它标签非必填,且不能以APIG-SN-开头 cors 否 Bool 是否支持跨域 TRUE:支持 FALSE:不支持 默认:FALSE body_remark 否 String API请求体描述,可以是请求体示例、媒体类型、参数等信息
true 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-cors 是 boolean 是否支持开启跨域请求的标识。 true:支持。 false:不支持。 开启跨域访问的API请求,响应会增加如下头域: 头域名称 头域值 描述 Access-Control-Max-Age
1,如果未安装,请至IDEA官方网站下载。 已安装Java Development Kit 1.8.111或以上版本,如果未安装,请至Oracle官方下载页面下载。暂不支持Java Development Kit 17或以上版本。 获取SDK 请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。
自定义APIG的客户端访问端口 API网关提供自定义实例入端口功能,支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时,一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容,请参考约束与限制。 自定义客户端访问端口
请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时