检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
导出API 导出JSON、YAML或YML格式的API。API网关支持单个API导出和批量API导出。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。单击分组名称然后单击“导出”。 或在左侧导航栏选择“API管理
编排规则管理 API网关支持对API进行参数编排,根据请求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“编排规则管理”页签。 单击“创建编排规则”,配置编排规则。
TP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。 前提条件 已搭建完成后端服务。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
x-apigateway-auth-type 是 String API网关认证方式,支持AppSigv1、IAM type 是 String 认证类型,仅支持apiKey name 是 String 用于认证的参数名称 in 是 String 仅支持header description 否 String 描述信息
I网关可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。 API网关支持专享版和共享版(存量用户)功能。专享版功能操作指导请参考API管理~云审计服务支持的关键操作章节;共享版功能已下线,当前仅存量用户可以使用,共享版功能操作指导请参考共享版操作指导(仅存量用户使用)。
自定义认证:APIG支持用户以函数自定义API认证方式,丰富鉴权逻辑。 证书校验:APIG支持对后端服务进行证书校验。 身份认证:APIG提供签名密钥进行后端访问身份认证。 访问控制 流量控制:APIG通过凭据、API、IP、用户等多维度的流控策略保护系统。 黑白名单:APIG支持系统级和API级别的IP黑白名单,拒绝恶意访问。
不使用VPC通道(负载通道)时,后端服务地址可以是什么? 可以是公网域名或者公网IP(支持云服务器的弹性IP地址)。前提需要开启公网出口, 可以是内网的IP,不可以是内网域名。 父主题: API创建
自定义入方向端口 API网关提供自定义实例入端口功能,支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时,一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容,请参考约束与限制。 操作步骤 进入API网关控制台页面。
在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。 API网关支持的自定义认证需要借助函数工作流服务实现,用户在函数工作流中创建自定义认证函数,API网关调用该
对某个凭据或租户进行特定的流控。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 使用限制 已了解前提条件。 如果一个API绑定流量控制策略后,继续绑定流量控制2.0策略,流量控制策略会失效。 参数流控的参数支持1-32个字符;参数流控的规则最多可定义100个。 策略内容最大长度65535。
true 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-cors 是 boolean 是否支持开启跨域请求的标识。 true:支持 false:不支持 开启跨域访问的API请求,响应会增加如下头域: 头域名称 头域值 描述 Access-Control-Max-Age
TTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 使用限制 已了解前提条件。 无法修改API网关增加的系统响应头(x-apig-*,x-request-id等
如果系统预置的API网关权限,不满足您的授权要求,可以创建自定义策略。自定义策略中可以添加的授权项(Action)请参考细粒度策略支持的授权项。 目前华为云支持以下两种方式创建自定义策略: 可视化视图创建自定义策略:无需了解策略语法,按可视化视图导航栏选择云服务、操作、资源、条件等策略内容,可自动生成策略。
为API的访问进行认证。API网关先调用用户的鉴权服务,收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 第三方认证原理图如下,第三方认证策略绑定API后,您可以参考调用API调用。 前提条件 使用前,请先了解前提条件。
API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后,断路器关闭,请求恢复正常。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 前提条件 使用前,请先了解前提条件。 配置参数说明 表1 配置参数 参数 配置说明 策略生效范围 单个API生效
SSL证书管理 如果API分组中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,支持单向认证和双向认证两种认证方式。 单向认证:客户端与服务端连接时,客户端需要验证所连接的服务端是否正确。 双向认证:
绑定凭据配额策略 凭据配额策略用于限制客户端(API调用者)在某个时间周期内的API调用次数,支持自定义重置时间。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“凭据配额策略”区域,单击“绑定”。
分页显示查询结果 查询资源列表时(例如,查询API列表),系统支持分页显示查询结果。 在url后面拼接如下参数: page_size:每页查询多少条数据,如果不指定,默认20,最大值500。 page_no:需要查询的页码。 示例: GET /v1.0/apigw/apis?pa
使用限制 专享版API(V1)的接口,只有上海二,广州,北京四,北京一,墨西哥和圣保罗局点支持注册,且仅用于存量用户使用。 请新用户在使用API时参考专享版API(V2)接口文档。 父主题: 专享版API(V1)(待下线)
流量控制策略说明 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务,您可以通过创建流控策略,针对部分API进行流量控制。 使用限制 已了解前提条件。 API添加流控策略相当于流控策略同步绑定