检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
适用于API后端服务部署在公网。 共享版API网关 共享版API网关按调用量费用+公网流量费用计费,调用量指API调用次数,流量指API调用的下行网络流量。计费模式详情请参考表3。 共享版APIG已下线,当前仅存量用户可以使用。关于计费模式详情请参考价格详情,下文不再具体描述。 表3 共享版API网关计费模式 计费模式
配置APIG的终端节点信息 终端节点用于在VPC和终端节点服务之间建立便捷、安全、私密的连接通道。 在同一区域中,可实现云内跨VPC访问/开放API。 图1 同一区域跨VPC访问 约束与限制 目前除墨西哥城一、北京一区域外,其他区域都支持终端节点管理功能。 配置终端节点信息 进入API网关控制台页面。
配置APIG的监控告警 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。
x-apigateway-request-type 含义:API网关定义的API请求类型,支持public和private。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get:
x-apigateway-cors 含义:API网关定义的API请求是否支持跨域。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-cors:
配置APIG专享版与客户端间的单向认证或双向认证 应用场景 API前端定义中的请求协议支持HTTPS时,API所属分组在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,当SSL证书带有CA证书时,默认开启客户端认证即双向认证;反之,开启单向认证。
默认值“80”,HTTP协议的默认端口。您可以自定义入端口,相关操作请参考自定义APIG的客户端访问端口。不使用HTTP端口,选择“禁止”即可。 HTTPS端口 默认值“443”,HTTPS协议的默认端口。您可以自定义入端口,相关操作请参考自定义APIG的客户端访问端口。不使用HTTPS端口,选择“禁止”即可。
APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps 请求消息 表2
x-apigateway-plugins 含义:API网关定义的API插件服务。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-plugins:
绑定域名 ApiGroup AssociateDomain 绑定域名证书 ApiGroup AssociateCertificate 修改域名 ApiGroup UpdateDomain 解绑域名 ApiGroup DisassociateDomain 删除域名证书 ApiGroup
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:
可以通过创建VPC对等连接,将两个VPC的网络打通,实现跨VPC访问实例。 关于创建和使用VPC对等连接,请参考VPC对等连接说明或API网关跨VPC开放后端服务。 公网调用API失败时,可能的原因如下: API没有绑定弹性公网IP(EIP),导致API缺少公网访问的有效地址,公网调用API失败。
注册时间 status Integer 状态 1: 有效 app_type String APP的类型: apig:存量apig应用,不推荐使用 roma:roma集成应用 默认apig,暂不支持其他类型 roma_app_type String ROMA_APP的类型: subscription:订阅应用
APIG共享版迁移到专享版 应用场景 APIG共享版即将退市,为了避免影响用户的业务,需要将共享版上已有资源迁移到专享版上继续使用。 约束与限制 基于APIG共享版使用了云商店功能暂不支持迁移。 基于APIG共享版使用了跨用户授权功能暂不支持迁移。 基于APIG共享版使用了ELB通道类型的VPC通道暂不支持迁移。
无法创建API是什么原因? API免费创建。如果被限制操作,可能原因为用户欠费,请及时充值。 计费相关的详细指导,请参考计费说明。 父主题: 开放API
为什么跨域调用API失败? 可能原因 API的跨域共享配置不正确。 解决方法 检查是否开启CORS。 进入API详情,单击“编辑”,查看是否开启CORS。如果没开启CORS,请开启。 检查是否创建OPTIONS方式的API,每个分组只需创建一个OPTIONS方式的API。 参数配置如下:
配置API的插件策略 配置API的跨域资源共享 配置API的响应缓存 配置API的HTTP响应头 配置API的流量控制2.0 配置API的Kafka日志推送 配置API的断路器 配置API的第三方认证 配置API的流量镜像 父主题: 配置API策略
install libcurl4-openssl-dev 获取SDK 请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载SDK的最新版本,获取“ApiGateway-c-sdk.zip”压缩包,解压后目录结构如下: 名称 说明 signer_common
install libcurl4-openssl-dev 获取SDK 请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载SDK的最新版本,获取“ApiGateway-cpp-sdk.zip”压缩包,解压后目录结构如下: 名称 说明