检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
导入API 操作场景 API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明 x-apigateway-backend-policies
境中。 同一个API在每个环境中最多记录10条最新的发布历史。 前提条件 已创建API分组和分组内的API。 已创建环境。 发布API 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,进入“发布API”页面。 在待发布的API所在行,单击“发布”。
roma_app_name String API归属的集成应用名称 暂不支持 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 暂不支持 backend_api BackendApi object 后端信息 api_group_info ApiGroupCommonInfo
发布API 功能介绍 将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
创建API分组 操作场景 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 一个API只能属于某一个API分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。
调用APIG开放的API API提供者在API网关开放自己的API后,API调用者从API网关中调用API。 约束与限制 如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。 如果在API网关控制台“API管理 > API策略
API管理 创建API 开启跨域访问 调试API 授权API 发布API 下线API 删除API 导入API 导出API 父主题: 共享版操作指导(仅存量用户使用)
成功响应示例 成功调用API时,返回的响应信息示例。 失败响应示例 调用API失败时,返回的响应信息示例。 单击“完成”,进入“API运行”页面,可查看API详情。 创建API相关的FAQ API网关是否支持多后端节点方案? 为什么后端服务调用失败? 在API网关中创建完成API,调用时报“No
信的合同。 创建GRPC API 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。 在“API运行”页面,单击“创建API > 创建GRPC API”。 根据下表参数信息,配置前端定义。
调用API API提供者在API网关开放自己的API后,API调用者从API网关中调用API。 调用限制 如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。 获取API的调用信息 在调用API前,您需要向API提供者获取API的调用信息。
调用API 调用API失败的可能原因 调用API报“414 Request URI too large” 调用API报“The API does not exist or has not been published in the environment” 调用API报“No backend
创建API 操作场景 API提供者把API接口配置在API网关中,开放后端能力。 创建API主要分为四个步骤:设置基本信息、定义API请求、定义后端服务和定义返回结果。 API网关服务基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。 前提条件 已创建A
开放API流程 企业或开发者通过API网关开放自身的服务与数据,实现业务能力变现。 创建API分组 每个API都归属到某一个API分组下,在创建API前应提前创建API分组。 添加API的SSL证书 如果API分组中的API支持HTTPS请求协议,需要为独立域名添加SSL证书。反之,跳过此步骤。
String API所属分组的编号 group_name String API所属分组的名称 status Integer API的状态 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method
X-Request-Id,X-Apig-Latency,X-Apig-Upstream-Latency,X-Apig-RateLimit-Api,X-Apig-RateLimit-User,X-Apig-RateLimit-App,X-Apig-RateLimit-Ip,X-Apig-RateLimit-Api-Allenv
查看APIG的API调用日志 APIG提供了API的可视化分析和统计能力,支持查看API的调用日志。 前提条件 已调用API。 查看API的调用日志 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 日志分析”。 单击“配置访问日
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。
调试尚未发布的API定义 MARKET 调试云商店已购买的API CONSUMER 调试指定运行环境下的API定义 说明: DEVELOPER模式,接口调用者必须是API拥有者。 MARKET模式,接口调用者必须是API购买者或拥有者。 CONSUMER模式,接口调用者必须有API在指定环境上的授权信息或是API拥有者。
任意规模的API。 API管理 自定义API的错误响应信息 配置API的参数编排规则 通过API设计文件导入API 导出APIG的API 流量控制 配置API的流量控制 添加特殊凭据或租户 配置API的流量控制2.0 API插件策略 配置API的跨域资源共享 配置API的HTTP响应头