检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
专享版-环境管理 创建环境 修改环境 删除环境 查询环境列表 父主题: 专享版API(V2)
APP管理(待下线) 对象模型 创建APP 修改APP 重置密钥 删除APP 校验APP 查看APP详情 查询APP列表 父主题: 专享版API(V1)(待下线)
专享版-VPC通道管理 创建VPC通道 更新VPC通道 删除VPC通道 查看VPC通道详情 查询VPC通道列表 添加或更新后端实例 查看后端实例列表 更新后端实例 删除后端实例 批量修改后端服务器状态可用 批量修改后端服务器状态不可用 修改VPC通道健康检查 添加或更新VPC通道后端服务器组
发布API 功能介绍 将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
下线API 功能介绍 将API从某个已发布的环境上下线,下线后,API将无法再被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/apis/publish/{api_id}[
查看API详情 功能介绍 查看指定的API的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
删除APP 功能介绍 删除指定的APP。 APP删除后,将无法再调用任何API;其中,云商店自动创建的APP无法被删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/apps/{id}
查看APP详情 功能介绍 查看指定APP的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
对象模型 本节介绍APP与API之间的授权关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 APP授权关系对象模型 参数
解除授权 功能介绍 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/app-auths/{id}
修改环境 功能介绍 修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/envs/{id} URI中的参数说明如下表所示。
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
对象模型 管理系统的默认配置,管理租户可以根据系统的实际运行情况对这些配置的值进行修改。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 系统配置对象模型
自定义认证管理 创建自定义认证 修改自定义认证 删除自定义认证 查看自定义认证详情 查询自定义认证列表 父主题: 共享版API(仅存量用户使用)
API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。 API的真实后端服务目前支持三种类型:传统的HTTP/HTTPS形式的web后端、函数工作流、MOCK。 URI
使用APIG的APP认证和自定义认证实现API的双重认证 方案概述 操作流程 实施步骤 父主题: API认证
使用WAF对APIG进行安全防护 企业为了保护APIG及后端服务器免受恶意攻击,可在APIG和外部网络之间部署WAF。 图1 后端服务器访问原理 方案一(推荐):WAF侧注册对外访问域名并配置证书,通过APIG实例的分组调试域名访问后端服务 推荐原因:API分组通过域名方式对外提供服务,具备更强的可扩展性。
无需认证信息。 获取应用的AppKey和AppSecret: 在API网关共享版控制台选择“调用API > 应用管理”,在应用列表中单击API所授权应用的名称,进入应用详情页面,获取应用的AppKey和AppSecret。 获取认证签名所使用SDK: 在API网关共享版控制台选择“帮助中心”
填写策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 固定为“Kafka日志推送”。 描述 填写策略的描述信息。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 策略基本信息 Broker地址 填写目标Kafka的连接地址,建立连接关系。多个地址间以英文逗号(