检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API调用对请求的响应消息体限制 API调用对请求的响应体大小没有限制。 API调用对请求的请求体大小有限制。详细指导请参考request_body_size。 父主题: 调用API
开放API 使用APIG专享版开放云容器引擎CCE工作负载 使用APIG专享版开放本地数据中心的服务能力 使用APIG专享版跨VPC开放后端服务 使用APIG专享版实现gRPC服务的路由转发 使用APIG专享版实现WebSocket服务的转发 使用APIG专享版实现http到https
管理API 查看或编辑APIG的API信息 配置API的自定义认证 配置API的参数编排规则 自定义API的错误响应信息 克隆APIG的API 授权APIG的API 下线APIG的API 导入导出API APIG的API设计文件扩展定义
修订记录 表1 文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口
API策略 是否支持对API的请求并发次数做控制? 企业账号是否有调试域名每天最多可以访问1000次的限制? API调用是否存在带宽限制 API的流量控制策略不生效怎么处理? 怎样给指定的用户开放API? API访问控制策略配置的IP地址是否为客户端的IP地址?
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。 单击“
配置凭据策略 配置API认证凭据的配额控制 配置API认证凭据访问控制
not exist or has not been published in the environment” 调用API报“No backend available” API的后端服务报“Backend unavailable”或“Backend timeout” API认证 APIG
API网关默认API流量控制为每秒200次,如果您的后端服务不能支撑单个API 200次/秒的调用请求,可设置流量控制策略,将限额调低。 父主题: 产品咨询
导入API设计文件 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击“创建API分组 > 导入API设计文件”。 在弹窗中选择本地路径下的API文件,然后单击“打开”导入文件。 填写导入信息。
假设您计划购买APIG专业版(未开启公网带宽),购买时长1个月,购买个数1个,在价格计算器页面底部,您将看到所需的配置费用。 图1 配置费用示例 计费周期 包年/包月API网关的计费周期是根据您购买的时长来确定的(以GMT+08:00时间为准)。
父主题: 管理APIG实例
通过API网关将企业服务能力包装成标准API服务,上架API云商店进行售卖。变现自身服务能力的同时,降低合作伙伴的研发投入,使合作伙伴更加专注于自身核心业务,提升运营效率。 云原生API开放 API网关除了将传统的服务作为后端服务外,还可以将微服务集群作为后端服务进行开放。
开放API 开放API流程 创建API分组 添加API的SSL证书(可选) 配置API的调用域名 创建API的负载通道(可选) 创建API 调试APIG创建的API 配置API的发布环境和环境变量(可选) 发布APIG创建的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分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 一个API只能属于某一个API分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。