设置了环境变量后,使用到该变量的API的调试功能将不可使用。
API、环境、凭据之间的关系? API可以被发布到不同的环境中。比如RELEASE和BETA两个环境,分别代表线上和测试环境。 应用(凭据)指代一个API调用者的身份。创建应用(凭据)时,系统会自动生成用于认证该身份的应用(凭据)Key&Secret。将指定的API授权给指定应用(
导出分组下所有API 功能介绍 提供用户导出API定义的接口。 导出指定分组指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。
导出分组下所有API 功能介绍 提供用户导出API定义的接口。 导出指定分组指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。
查看APP未绑定的API列表 功能简介 查询指定环境上某个APP未绑定的API列表,包括自有API和从云商店购买的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。
仅在API发布到环境后,才支持被授权。 仅在API为APP认证时,才支持授权给应用。 前提条件 已创建API分组和分组内的API。 (可选)已创建环境。 已创建应用。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。
查询API列表 功能介绍 查看API列表,返回API详细信息、发布信息等,但不能查看到后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。
查询API列表 功能介绍 查看API列表,返回API详细信息、发布信息等,但不能查看到后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis[?
查询API历史版本列表 功能介绍 查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。 URI HTTP/HTTPS请求方法以及URI如下表所示。
绑定流控策略 功能介绍 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。
删除环境 操作场景 已创建的环境不再提供服务,可以将环境删除。 前提条件 已创建环境。 操作步骤 进入共享版控制台。 选择“开放API > 环境管理”,进入到环境管理信息页面。 在待删除的环境所在行,单击“删除”,弹出对话框。 仅在环境未被API发布时,支持删除。 单击“确定”,完成环境管理信息
批量导出API 功能介绍 按API ID列表批量导出指定分组、指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。
批量导出API 功能介绍 按API ID列表批量导出指定分组、指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1.0/apigw/openapi/apis?
绑定流控策略 功能介绍 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。 当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。
API创建完成后,在“API运行”页签中,单击“发布最新版本”,发布API。 使用接口测试工具调用API。 本实践通过IP调用DEFAULT分组下的API,输入“wss://IP地址/hello”发送请求即可。其中,IP地址为APIG控制台“实例信息”中的弹性IP地址。
查看流控策略绑定的API列表 功能介绍 查询某个流控策略上已经绑定的API列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。
约束与限制 不支持API管理模块中的导入导出API功能、导入API设计文件、导入CSE微服务功能、导入CCE工作负载功能、调试API功能。 不支持后端降级策略中后端策略类型为Mock、HTTP&HTTPS、FunctionGraph的断路器策略。 不支持Base64编码配置。
查看APP未绑定的API列表 功能简介 查询指定环境上某个APP未绑定的API列表,包括自有API和从云商店购买的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。 单击“
无法修改API网关增加的系统响应头(x-apig-*,x-request-id等),包括API网关提供的CORS功能增加的响应头。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。
您即将访问非华为云网站,请注意账号财产安全