检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调试指定运行环境下的API定义 说明: DEVELOPER模式,接口调用者必须是API拥有者。 MARKET模式,接口调用者必须是API购买者或拥有者。 CONSUMER模式,接口调用者必须有API在指定环境上的授权信息或是API拥有者。 path 是 String API的请求路径,需以"/"开头,最大长度1024
创建API 功能介绍 添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务
到API云商店,实现业务能力变现。 如果您作为API调用者,您可以获取并调用API提供者在API网关开放的API,减少开发时间与成本。 例如,企业A在API网关中开放了电话号码归属地查询API,并发布到API云商店。企业B通过API云商店调用此API,并支付调用此API所产生的费
String API归属的集成应用名称 暂不支持 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 暂不支持 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo
创建API 功能介绍 添加一个API,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接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。
String API所属分组的编号 group_name String API所属分组的名称 status Integer API的状态 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method
API创建 无法创建API是什么原因? API的响应码如何定义? 使用VPC通道(负载通道),后端服务的主机端口怎么填写? 不使用VPC通道(负载通道)时,后端服务地址可以是什么? 后端服务地址是否一定要配置为ECS的地址? 后端服务是否支持绑定私网ELB地址? 后端服务地址支持填写私有地址(子网IP)吗?
API安全 怎样保护API? 怎样保证API网关调用后端服务器的安全? 能否针对VPC通道(负载通道)内的ECS私有IP进行访问控制
适用于将一份全新且完整的API导入到API网关。 导入API前,请注意以下事项: API网关中API分组和API的配额满足需求。 使用Swagger info或OpenAPI info的title作为API分组名称,新创建的API分组名称不能与已有的API分组名称重名。 导入的API定义中,如
API监控 支持的监控指标 创建告警规则 查看监控指标 父主题: 监控分析
导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/i
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
下线API 功能介绍 将API从某个已发布的环境上下线,下线后,API将无法再被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/inst
单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,弹出“删除API”对话框。 在待删除的API所在行,单击“更多 > 删除”。 单击“API名称”,进入API详情页面。在右上角单击“删除”。 如果需要批量删除API,则勾选待删除的API,单击“删除”。最多同时删除1000个API。
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
调试API 操作场景 API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已创建API分组和分组内的API。
API管理 对象模型 创建API 修改API 删除API 发布API 下线API 批量发布或下线API 查看API详情 查询API列表 查询API历史版本列表 根据版本编号下线API 查看版本详情 查询API运行时定义 调试API 父主题: 共享版API(仅存量用户使用)
或在左侧导航栏选择“API管理 > API列表”,单击“导出API”。 设置导出参数。 表1 导出API 参数 说明 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。