检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
修改API 功能介绍 修改指定API的信息,包括后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
创建APP 功能介绍 APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw
校验APP 功能介绍 校验APP是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
创建环境 功能介绍 在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供生产使用
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍VPC通道的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 VPC通道对象模型 参数 类型 说明 操作类型 是否必选
查看版本详情 功能介绍 查询某个指定的版本详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/versions/{version_id} URI中的参数说明如下表所示
调试API 功能介绍 调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apis/debug/{
专享版-APP授权管理 APP授权 解除授权 查看APP已绑定的API列表 查看APP未绑定的API列表 查看API已绑定的APP列表 父主题: 专享版API(V2)
专享版-配置管理 查询某个实例的租户配置列表 查询租户实例配置列表 父主题: 专享版API(V2)
专享版-域名管理 绑定域名 绑定域名证书 修改域名 解绑域名 设置调试域名是否可以访问 删除域名证书 查看域名证书 父主题: 专享版API(V2)
自定义认证 创建自定义认证 删除自定义认证 父主题: 共享版操作指导(仅存量用户使用)
删除分组 操作场景 API分组在创建后,如需对创建的数据进行删除,可以删除此分组。 如果API分组下存在API,API分组无法被删除。 前提条件 已创建分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。 通过以下任意一种方式,进入“
已购买API 操作场景 API网关共享版支持查看已购买的API,明确已购买服务的详情。并通过调试API,验证服务是否正常。 已购买的API,需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”,进入到已购买
APIG使用流程 API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关的开放API和调用API功能,可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放。 开放API 企业或开发者通过
查看APIG的API调用日志 APIG提供了API的可视化分析和统计能力,支持查看API的调用日志。 前提条件 已调用API。 查看API的调用日志 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 日志分析”。 单击“配置访问日志
配置API的响应缓存 您可以通过配置响应缓存策略将后端服务(服务端)返回的应答缓存在API网关中,当客户端发送相同的请求时,网关不用向后端传递请求,直接返回缓存的应答。有效降低后端的负荷,同时减少API调用的延迟。 当使用响应缓存策略时,后端的响应内容会缓存到API网关中,此时API
创建API 功能介绍 添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。
对象模型 本节介绍环境的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 环境管理对象模型 参数 类型 说明 操作类型 是否必选 id String