检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
实例配置特性 功能介绍 为实例配置需要的特性。 支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/features
授权API 操作场景 API在创建后，通过指定授权给某些应用，让指定应用能够调用API。 仅在API发布到环境后，才支持被授权。 仅在API为APP认证时，才支持授权给应用。 前提条件 已创建API分组和分组内的API。 （可选）已创建环境。 已创建应用。 操作步骤 进入共享版控制台。
导入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 父主题： 附录
实例规格，对API请求的并发支持能力不同，具体请参考规格说明章节。 说明： 目前仅上海一、乌兰察布一、贵阳一、北京四、华东二、利雅得、香港区域支持选择更多铂金版规格。 可维护时间窗 指允许云服务技术支持对实例进行维护的时间段。如果有维护需要，技术支持会提前与您沟通确认。 建议选择业务量较少的时间段。
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个参数。 单击“新增映射信息”，可添加新的映射信息。 编排前的请求参数值 当“
应用场景 API网关支持http重定向到https功能。当用户的API采用http协议访问时，由于http没有传输安全与认证安全保障，可以使用API网关的重定向功能将API升级为安全的https协议访问，同时兼容已有的http协议。（2022年11月30日之后创建的实例支持http重定向到https）
与body体参数，调试API接口。 约束与限制 后端路径中含有环境变量的API，不支持调试。 如果API绑定了插件策略或传统策略，在调试API时，策略均不生效。 调试API时，后端超时时间最大支持60s。 前提条件 已创建API。 调试API 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
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黑白名单，拒绝恶意访问。
在API的安全认证方面，API网关提供IAM认证、APP认证等方式，帮助用户快速开放API，同时API网关也支持用户使用自己的认证方式（以下简称自定义认证），以便更好地兼容已有业务能力。 API网关支持的自定义认证需要借助函数工作流服务实现，用户在函数工作流中创建自定义认证函数，API网关调用该
true 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-cors 是 boolean 是否支持开启跨域请求的标识。 true：支持。 false：不支持。 开启跨域访问的API请求，响应会增加如下头域： 头域名称 头域值 描述 Access-Control-Max-Age
添加API的SSL证书 如果API分组中的API支持HTTPS请求协议，则在绑定独立域名后，还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书，支持单向认证和双向认证两种认证方式。 如果不配置SSL证书，将无法保障请求的链路安全，请谨慎配置。 单向认证：客
配置API的流量控制 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。支持按分/秒粒度级别的流量控制。为了提供持续稳定的服务，您可以通过配置流控策略，针对部分API进行流量控制。 约束与限制 API配置流控策略相当于流控策略同步绑定了API。同一
自定义APIG的客户端访问端口 API网关提供自定义实例入端口功能，支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时，一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容，请参考约束与限制。 自定义客户端访问端口
流量控制2.0策略可以限制单位时间内API的被调用次数，支持参数流控、基础流控和基于基础流控的特殊流控。 基础流控 可以对API、用户、凭据、源IP进行多维度流控，与已有的配置API的流量控制功能一致但不兼容。 参数流控 支持根据Header、Path、Method、Query以及系统变量中的参数值进行自定义流控。
查看APIG的带宽监控 API网关支持查看出入口带宽各项指标的监控数据，了解带宽的网络情况和使用率。 前提条件 已启用入口地址或出口地址。入口地址或出口地址可在实例信息中查看。 查看带宽监控 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析
查看APIG的API调用日志 APIG提供了API的可视化分析和统计能力，支持查看API的调用日志。 前提条件 已调用API。 查看API的调用日志 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 日志分析”。 单击“配置访问日
id字段必须传入 auth_opt 否 AuthOpt object 认证方式参数 cors 否 Boolean 是否支持跨域 TRUE：支持 FALSE：不支持 缺省值：false match_mode 否 String API的匹配方式 SWA：前缀匹配 NORMAL：正常匹配（绝对匹配）
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
