检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
限制与兼容性说明 在API网关中导入或者导出API时,限制与兼容性如下所示: 限制说明 API网关参数限制,如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中,header位置的参数名称,不区分大小写。
API网关提供的实例版本有:基础版、专业版、企业版、铂金版等,您可以根据实际业务需要按需使用。实例版本说明,请参考产品规格。如果您当前使用的实例版本不能满足需要,API网关支持升级产品版本,例如从“基础版”升级到“专业版”或者铂金版,并且对现有业务没有影响。 实例版本单价,请参考价格详情中的包年/包月计费价格。
如果发现当前计费模式无法满足您的业务需求,您可以变更计费模式。 目前仅北京一、北京四、乌兰察布一、上海一、上海二、广州、广州-友好用户环境和贵阳一支持包周期收费方式。 区域 指APIG实例部署的区域,建议和您其他的业务部署在相同区域,这样不同的业务可以在负载内以子网方式通信,节省公网带宽成本,降低网络延时。
云监控对API网关的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 查看单个API的监控指标 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面左侧选择API。 在“监
调用API 本章节仅提供请求地址和认证参数的配置指导,客户端的其他参数配置需要用户自行调整,如超时配置、SSL配置等。如果客户端参数配置错误会导致业务受损,建议参考业界标准进行配置。 构造API请求,示例如下: POST https://{Address}/{Path}?{Query} {Header}
凭据配额策略用于限制客户端(API调用者)在某个时间周期内的API调用次数,支持自定义重置时间。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“凭据配额策略”区域,单击“绑定”。
作负载生成的负载通道,动态监测工作负载下所有实例的地址变化,并自动更新到负载通道中。 支持通过CCE工作负载标签配置进行灰度发布,完成灰度测试与版本切换。 提供多种认证方式,增加访问安全性。 提供访问流量控制策略,增加后端服务的安全性 与直接访问容器应用相比,API网关提供流量控制,确保后端服务稳定运行。
ecret将失效,绑定此凭据的API将无法调用,请更新SDK中的密钥对,并重新调用API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 单击“重置Secret”。 在弹窗中单击“确定”。
会监测微服务下所有在线实例的地址变化,并更新到负载通道中。 前提条件 已创建CSE微服务。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击“创建API分组 > 导入CSE微服务”。根据下表参数说
告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面的“监控视图”区域,单击
克隆API暂不支持克隆绑定策略,如果需要绑定策略请手动操作。 前提条件 已创建API,如果未创建API,请创建API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面,单击“更多 > 克隆”。
查看API列表 API列表支持查看当前实例下所有的API,包含URL、运行环境、安全认证等信息。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 您可以管理当前实例下的所有API,支持编辑、发布、调试等操作。 在左侧导航栏选择“API管理 > API列表”,进入到API列表页面。
实例信息”界面开启出口地址。 检查VPC网络中的ACL配置,查看是否有相关ACL策略限制了API网关实例与后端服务所在子网的通信。 如果使用VPC通道,检查VPC通道业务端口、健康检查端口、后端服务器添加是否均正常。 如果VPC通道类型为微服务,检查APIG实例是否添加路由。详细操作请参见负载通道章节。 共享版APIG后端不支持配置内网ELB。
策略均不生效。 调试API时,后端超时时间最大支持60s。 前提条件 已搭建完成后端服务。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页签,选择待调试的API,单击“调试”。
黑白名单:APIG支持系统级和API级别的IP黑白名单,拒绝恶意访问。 后端流量控制:APIG提供后端负载均衡、自动熔断等能力保护后端业务。 父主题: 安全
保护后端服务。您可以为客户端设置访问控制策略,允许/禁止某个IP地址的客户端访问API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“访问控制策略”区域,单击“绑定”。
调试API 操作场景 API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已创建API分组和分组内的API。
单个凭据最多同时授权1000个API。 前提条件 API已发布。 已创建环境。 已创建凭据。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面,选择待授权的API,单击“更多
ode”。 在弹窗中选择“自动生成”生成方式。 单击“确定”。 调用API。 使用接口测试工具配置API请求和认证信息。 选择请求方法“GET”,在“API运行”页面将URL地址复制到接口测试工具中,URL地址由https://调试域名/路径组成。 添加Header参数名称:X-
使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击API分组名称,进入API分组详情页面。 单个下线API