检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
已获取API的调用信息,具体参见认证前准备。 已安装IntelliJ IDEA 2018.3.5或以上版本,如果未安装,请至IntelliJ IDEA官方网站下载。 已安装PHP安装包8.0.3或以上版本,如果未安装,请至PHP官方下载页面下载。 将PHP安装目录中的“php.ini-prod
对API的修改是否需要重新发布? API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问如何处理? API发布到不同环境后,会调用不同的后端服务吗? 调试API的时候,如何指定环境?
当API的请求协议为GRPC类型时不支持配置。 result_failure_sample String 失败返回示例,描述API的异常返回信息。字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 当API的请求协议为GRPC类型时不支持配置。 authorizer_id
修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误
throttle_specials 字典数据类型 本次查询返回的特殊配置列表 total Integer 符合条件的特殊设置总数 size Integer 本次查询返回的列表长度 表4 throttle_specials参数说明 参数 类型 说明 id String 特殊配置的编号 strategy_id String
API网关的后端服务有3类部署形态: 后端服务部署在虚拟私有云(以下简称VPC)中,仅支持私有地址访问。 可在API网关创建VPC通道,利用VPC通道,打通API网关与虚拟私有云的网络路由。 后端服务部署在公网环境中,即可以直接通过公网地址访问。 后端服务部署在本地数据中心,且不能通过公网地址直接访问。
throttle_specials 字典数据类型 本次查询返回的特殊配置列表 total Integer 符合条件的特殊设置总数 size Integer 本次查询返回的列表长度 表4 throttle_specials参数说明 参数 类型 说明 id String 特殊配置的编号 strategy_id String
在函数工作流的控制台编写函数,自定义认证的代码编写指南参见创建用于前端自定义认证的函数。 根据下表参数说明,在函数工作流页面创建一个函数。 表1 函数信息配置 参数 配置说明 选择创建方式 默认“创建空白函数”。 函数类型 默认“事件函数”。 区域 与API网关相同区域。 项目 华为云的区域默认对应一
取SDK,参考API调用示例调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 安装openssl库。 apt-get install libssl-dev 安装curl库。 apt-get install libcurl4-openssl-dev 获取SDK
取SDK,参考API调用示例调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 安装openssl库。 apt-get install libssl-dev 安装curl库。 apt-get install libcurl4-openssl-dev 获取SDK
路由到微服务容器中,同时支持微服务的灰度发布。 函数工作流服务开放 API网关可以将无服务器服务(即函数工作流服务)作为后端服务开放给合作伙伴,与传统的服务相比,函数工作流服务具有易开发、易部署、易维护的特点。使用函数工作流服务,快速构建后端业务逻辑处理,将这些业务逻辑函数通过A
API网关将签名后的请求发送到后端服务,此时Authorization头中包含签名信息。后端服务通过不同的开发语言(例如Java、Go、Python、JavaScript、C#、PHP、C++、C、Android等)进行签名,比对签名结果和API网关传过来的Authorization头中签名是否一致来校验API的合法性。
流量控制支持从用户、应用(凭据)、源IP和时间段等不同的维度限制对API的调用次数,保护后端服务。 API网关支持按分/按秒粒度级别的流量控制。 访问控制 访问控制策略是API网关提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来允许/拒绝某个IP地址或账户访问API。
当您的API后端服务部署在公网时,除实例费用外需要另外收取API请求出公网带宽费用。 专享版实例部署在虚拟私有云中,如果您的后端服务也部署在相同虚拟私有云,可直接通过私有地址访问,无需购买带宽。 专享版实例的API如从公网调用,实例需绑定一个弹性公网IP,作为公网入口。弹性公网IP需要单独购买。
basic类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。 public_key类型开启实例配置public_key才可使用,实例特性配置详情请参考“附录 > 实例支持的APIG特性”,如确认实例不存在public_key配置可联系技术工程师开启。 aes类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。
code参数说明 名称 是否必选 参数类型 说明 description 否 String 响应描述信息 schema 否 Object 响应正文定义,参考表12 表12 schema参数说明 名称 是否必选 参数类型 说明 description 否 String BODY体描述 type
code参数说明 名称 是否必选 参数类型 说明 description 否 String 响应描述信息 schema 否 Object 响应正文定义,参考表13 表13 schema参数说明 名称 是否必选 参数类型 说明 description 否 String BODY体描述 type
code参数说明 名称 是否必选 参数类型 说明 description 否 String 响应描述信息 schema 否 Object 响应正文定义,参考表12 表12 schema参数说明 名称 是否必选 参数类型 说明 description 否 String BODY体描述 type
code参数说明 名称 是否必选 参数类型 说明 description 否 String 响应描述信息 schema 否 Object 响应正文定义,参考表13 表13 schema参数说明 名称 是否必选 参数类型 说明 description 否 String BODY体描述 type