检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APIG业务使用流程 API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。 API网关支持专享版和共享版(存量
x-apigateway-backend-policies.conditions 含义:API网关定义的API后端策略条件。 作用域:x-apigateway-backend-policies 示例: paths: '/users/{userId}': get:
x-apigateway-auth-type 含义:基于Swagger的apiKey认证格式,定义API网关支持的特有认证方式。 作用域:Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger: securityDefinitions:
x-apigateway-backend 含义:API网关定义的API后端服务定义。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/users/{userId}': get: produces:
如何将API服务上架到华为云商店上售卖? API服务上架到华为云商店,您需要按如下流程完成部署和配置: 完成API的创建、发布等工作 此部分操作在API网关服务中完成,您可以参考《API网关用户指南》。 其他相关操作包括“API分组”、“API管理”和“环境管理”等。 (可选)配置API的流量控制策略
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。
x-apigateway-backend-policies 含义:API网关定义的API后端策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/users/{userId}': get:
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 调用方法 请参见如何调用API。 URI POST /v2/{project_id
更新VPC通道 功能介绍 更新指定VPC通道的参数 使用传入的后端实例列表对VPC通道进行全量覆盖,如果后端实例列表为空,则会全量删除已有的后端实例; 使用传入的后端服务器组列表对VPC通道进行全量覆盖,如果后端服务器组列表为空,则会全量删除已有的服务器组; 调用方法 请参见如何调用API。
产品优势 开箱即用的服务 只需在管理控制台配置,即可快速创建API。提供页面调试工具,简化API开发。可同时发布一个API到多个环境,快速迭代、测试API。 便捷的API生命周期管理 API网关提供全生命周期的API管理,从设计、开发、测试、发布、运维、上架、下架等, 实现完整的
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
更新VPC通道 功能介绍 更新指定VPC通道的参数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/vpc-channels/{id} URI中的参数说明如下表所示。 表2
创建插件 功能介绍 创建插件信息。 插件不允许重名 插件创建后未绑定API前是无意义的,绑定API后,对绑定的API即时生效 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/plugins
授权 功能介绍 APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
修改插件 功能介绍 修改插件信息。 插件不允许重名 插件不支持修改类型和可见范围 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id} 表1 路径参数
Python 操作场景 使用Python语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 准备环境 已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。
获取异步任务结果 功能介绍 获取异步任务结果。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/async-tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述
创建APP 功能介绍 APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apps
重置密钥 功能介绍 重置指定APP的密钥。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/secret/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
配置API的后端服务签名校验 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名信