检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
简易认证指APP认证方式下调用API时,在GRPC请求头部消息增加一个参数X-Apig-AppCode,而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。 注意支持GRPCS方式调用,不支持GRPC方式。具体使用请参考配置APIG的API简易认证AppCode。
APIG最佳实践汇总 本文汇总了基于API网关服务(APIG,APIGateway)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎(Cloud
用于后端响应内容的缓存大小为128m。 API网关遵守后端应答中的Cache-Control头的约定来处理缓存,如果后端不返回Cache-Control头,则默认缓存,使用策略中配置的ttl字段作为缓存超期时间。 API网关默认不处理客户端的Cache-Control头,可以通过策略中的client_cache_control来进行配置。
是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”字段。 该字段为false或者未提供该参数时,该条件不生效。 tags 否 Array of TmsKeyValues objects
APP_CODE_NUM_LIMIT:每个APP可以创建的APP code数量限制 REGION_MANAGER_WHITELIST_SERVICES:不校验region manager服务白名单列表,暂不支持 API_SWAGGER_NUM_LIMIT:单个API分组可以绑定的swagger文档数量限制
x-apigateway-ratelimits参数说明 表4 info参数说明 名称 是否必选 参数类型 说明 title 否 String API分组名称,导入到已有分组时不生效 version 否 String 版本号,用户输入自定义版本号或者使用默认的当前时间 description 否 String 分组描述信息
云审计服务支持的APIG操作列表 开通云审计服务 如果您需要收集、记录或者查询API网关服务的操作日志,用于支撑安全分析、审计、问题定位等常见应用场景时,则需要先开通云审计服务。 云审计服务包含以下功能: 记录审计日志 审计日志查询 审计日志转储 事件文件加密 关键操作通知 查看关键操作列表
x-apigateway-ratelimits参数说明 表4 info参数说明 名称 是否必选 参数类型 说明 title 否 String API分组名称,导入到已有分组时不生效 version 否 String 版本号,用户输入自定义版本号或者使用默认的当前时间 description 否 String 分组描述信息
产品咨询 如何将API服务上架到华为云商店上售卖? API分组为什么无法上架到云商店? API、环境、凭据之间的关系? API网关共享版是否可以升级到专享版? APIG控制台所有按钮均无法单击如何处理? 怎样保护API的调用安全? 怎样保证API网关调用后端服务器的安全?
开放API流程 企业或开发者通过API网关开放自身的服务与数据,实现业务能力变现。 创建API分组 每个API都归属到某一个API分组下,在创建API前应提前创建API分组。 添加API的SSL证书 如果API分组中的API支持HTTPS请求协议,需要为独立域名添加SSL证书。反之,跳过此步骤。
添加API的SSL证书 如果API分组中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,支持单向认证和双向认证两种认证方式。 如果不配置SSL证书,将无法保障请求的链路安全,请谨慎配置。 单向认证:客
API概览 API网关专享版接口的分类与说明如表1所示,API网关共享版接口的分类与说明如表2所示。 表1 专享版API概览 类型 说明 API分组管理 包括API分组的创建、修改、删除、查询详情和列表等接口。 环境管理 包括环境的创建、修改、删除和查询列表等接口。 环境变量管理
调用API报“No backend available” 检查后端服务是否可以访问,如果不能访问,请修改后端服务。 检查后端服务对应的ECS安全组配置,查看是否已开放您需要的端口。 检查后端服务地址是否使用公网IP地址,如果使用,需要在APIG控制台的“实例管理 > 查看控制台 >
应用场景 企业内部系统解耦 随着企业的高速发展、业务的快速变化,需要企业内部系统跟随业务需求一同变化,但是企业内部系统存在相互依赖关系,为保持系统的通用性与稳定性,很难应对业务的变化。而API网关使用RESTful API, 帮您简化服务架构,通过规范化、标准化的API接口,快速
创建实例后,不支持修改虚拟私有云(负载)。 安全组 仅墨西哥城一、北京一区域配置的安全组生效。在其他区域购买实例后默认开启ELB负载。开启ELB负载的实例的安全组不生效,如需禁用部分IP请使用访问控制策略。 准备网络环境 负载 虚拟私有云(Virtual Private Cloud,简称VPC)。实例需
使用APIG专享版跨VPC开放后端服务操作流程 创建VPC 创建两个VPC,VPC1为API网关所在VPC,VPC2为后端应用所在VPC。 创建实例 在VPC1上创建API专享版实例。 创建弹性负载均衡 在VPC2上创建弹性负载均衡。 创建对等连接 创建VPC Peering对等连接,打通VPC1和VPC2。
JavaScript 操作场景 使用JavaScript语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 JavaScript SDK支持Node.js、浏览器等运行环境。 关于开发环境搭建,本章节以IntelliJ IDEA 2018
API的认证类型对象数组定义,为空数组 apig-auth-type支持: APP认证: apig-auth-app IAM认证:apig-auth-iam NONE:不填写 表11 status code参数说明 名称 是否必选 参数类型 说明 description 否 String 响应描述信息 schema
API的认证类型对象数组定义,为空数组 apig-auth-type支持: APP认证: apig-auth-app IAM认证:apig-auth-iam NONE:不填写 表12 status code参数说明 名称 是否必选 参数类型 说明 description 否 String 响应描述信息 schema
API的认证类型对象数组定义,为空数组 apig-auth-type支持: APP认证: apig-auth-app IAM认证:apig-auth-iam NONE:不填写 表11 status code参数说明 名称 是否必选 参数类型 说明 description 否 String 响应描述信息 schema