检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
SDK API网关开放的API,安全认证方式可选IAM认证、APP认证、自定义认证或无认证。四者的区别以及如何选择,请参考调用API。本章节主要提供APP认证的SDK下载以及文档。 操作场景 API使用APP认证时,请根据需要下载SDK包和文档,参考文档完成API的调用。 操作步骤
导入,界面可预览待导入API内容。 图2 导入参数 (可选)修改待导入API的全局配置。 您可以修改全局配置,如前后端的请求配置,也可以修改具体的接口配置。 图3 修改全局配置 图4 修改接口配置 单击“快速上线”,完成API导入。 导入的API不会自动发布到环境,需要您手动发布。
已获取API的调用信息,具体参见认证前准备。 已安装IntelliJ IDEA 2018.3.5或以上版本,如果未安装,请至IntelliJ IDEA官方网站下载。 已安装PHP安装包8.0.3或以上版本,如果未安装,请至PHP官方下载页面下载。 将PHP安装目录中的“php.ini-prod
函数工作流服务开放 API网关可以将无服务器服务(即函数工作流服务)作为后端服务开放给合作伙伴,与传统的服务相比,函数工作流服务具有易开发、易部署、易维护的特点。使用函数工作流服务,快速构建后端业务逻辑处理,将这些业务逻辑函数通过API网关的标准API接口开放,并发能力得到线性扩展。
使用场景 API网关主要涉及以下几个开发场景: API调用认证开发:API的认证方式为APP认证或IAM认证,则需要在业务系统侧进行调用认证的开发,为API请求添加认证信息。 使用APP认证(签名认证)调用API:API调用者通过API网关提供Key、Secret和SDK,对API请求进行签名认证。
SDK API网关开放的API,安全认证方式可选IAM认证、APP认证、自定义认证或无认证。四者的区别以及如何选择,请参考调用API。 本章节主要提供APP认证的SDK下载以及文档。IAM认证请参考“使用IAM认证调用API”章节。 操作场景 API使用APP认证时,请根据需要下
/v2/{project_id}/apigw/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用
timeout”原因分析 API认证鉴权 是否支持HTTPS的双向认证? “无认证”方式的API该怎么鉴权与调用? API控制策略 是否支持对请求并发次数做自定义控制? API调用是否存在带宽限制 怎样给指定的用户开放API 配置了身份认证的API,如何在特殊场景下(如指定IP地址)允许不校验身份?
如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。 网关错误响应类型说明 API网关提供的错误响应类型见下表,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截
删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{inst
根据下表参数信息,配置安全配置。 表4 定义API请求 参数 配置说明 安全认证 选择API认证方式,此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。此处勾选简易认证。 单击“下一步”,配置默认后端信息。
version: v1 方式一:通过创建负载通道开放CCE工作负载 创建负载通道。 进入API网关控制台,在左侧导航栏上方选择实例。 在左侧导航栏中选择“API管理 > API策略”。 在“负载通道”页签中单击“创建负载通道”。 基本信息配置。 表1 基本信息配置 参数 配置说明 通道名称
下三种配置方式中选择配置: / /{包名}.{服务名} /{包名}.{服务名}/{方法名} 包名、服务名、方法名从proto文件中获取。 当前端路径设置“/{包名}.{服务名}/{方法名}”时,API的匹配模式才可以使用“绝对匹配”。 不支持Base64编码配置。 安全配置请参考5
查看实例特性列表 功能介绍 查看实例特性列表。注意:实例不支持以下特性的需要联系技术支持升级实例版本。 支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/
已创建前端自定义认证。如果未创建,请参考自定义认证章节创建。 配置API前端 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称,
缺省值:HTTPS 枚举值: HTTP HTTPS BOTH GRPCS req_method String API的请求方式,当API的请求协议为GRPC类型协议时请求方式固定为POST。 枚举值: GET POST PUT DELETE HEAD PATCH OPTIONS ANY req_uri
删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书、上架信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE
删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE
编辑健康检查配置 操作场景 VPC通道创建完成后,可通过编辑健康检查配置修改健康检查项。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 单击“VPC通道名称”,进入VPC通道详情页面。 单击“健康检查”,进入“健康检查”页签。
缺省值:HTTPS 枚举值: HTTP HTTPS BOTH GRPCS req_method 是 String API的请求方式,当API的请求协议为GRPC类型协议时请求方式固定为POST。 枚举值: GET POST PUT DELETE HEAD PATCH OPTIONS ANY req_uri