检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
什么是API网关 API网关(API Gateway)是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务,能快速将企业服务能力包装成标准API接口,帮助您轻松构建、管理和部署任意规模的API,并上架API云商店进行售卖。借助API网关,可以简单、快速、低成本、低风险地实现内部系统集成和业务能力开放
成长地图 | 华为云 API网关 API网关(APIG)是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务,融合安全、负载均衡、流量入口治理、微服务流量治理、运维等多项能力,帮助企业轻松实现API安全开放、API高并发调用和入口流量、微服务流量精细化治理,简单、快速、低成本
功能总览 功能总览 全部 API网关 购买API网关 开放API 调用API 导入导出API 自定义认证 API SDK OBS 2.0支持 API网关 API网关(API Gateway)提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建
自定义API的错误响应信息 网关响应指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为
APIG支持的监控指标 功能说明 本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 SYS.APIC 监控指标 表1 监控指标说明 指标ID
怎样使用API网关? API网关提供了以下方式来管理/调用API: Web化的服务管理平台,即管理控制台。 如果您已注册云服务,可直接登录管理控制台,单击管理控制台左上角,然后单击“API网关 APIG”。 有关管理控制台的功能描述以及操作使用指导,请参考《API网关用户指南》。
关闭实例公网出口 功能介绍 关闭实例公网出口 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/nat-eip 表1 路径参数 参数 是否必选 参数类型 描述 project_id
实例更新或绑定EIP 功能介绍 实例更新或绑定EIP(仅当实例为LVS类型时支持) 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/eip 表1 路径参数 参数 是否必选 参数类型 描述
通过API设计文件导入API 将Swagger或OpenAPI定义的API导入到API网关,支持导入到新分组和导入到已有分组两种方式。导入前您需要在API定义中补全API网关的扩展定义。 导入到新分组注意事项 将API定义导入到一个新的分组,导入过程中系统会自动创建一个新的API分组
x-apigateway-backend.parameters 含义:API网关定义的API后端参数定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。 Token认证:通过Token认证调用请求
查询监控数据 功能介绍 查询指定时间范围指定指标的指定粒度的监控数据,可以通过参数指定需要查询的数据维度。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/metric-data 表1
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 204 APIG.0000 Successful 请求成功 无 400 APIC.7211 Parameter
API导入导出 API导入失败是什么原因? swagger导入API的扩展字段有没有模板?
添加API的SSL证书(可选) 如果API分组中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,支持单向认证和双向认证两种认证方式。 单向认证:客户端与服务端连接时,客户端需要验证所连接的服务端是否正确
swagger导入API的扩展字段有没有模板? 模板在开发中。 您可以先配置好1~2个API,再导出作为模板。 父主题: API导入导出
方案概述 应用场景 当在公网中调用APIG上公开的业务API时,如果不限制API调用的次数,随着用户的不断增加,会引起后端性能的下降,甚至会因为恶意用户发送的大量请求导致网站或程序崩溃。APIG提供了传统策略:流量控制,从API、用户、凭据、源IP等多个维度进行流控。 然而,随着用户多样性以及需求多样性的增加
配置API的调用域名 在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。最多可以添加5个独立域名,不限访问次数。 独立域名可分为内网域名和公网域名两种: 内网域名:部署在云服务平台内的业务系统,可以使用内网域名访问API。 公网域名:部署在云服务平台外的业务系统
新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token? x-auth-token在API网关内部已经被定义了,如果您再次创建此参数名,容易导致冲突。 API网关控制台中已经限定您无法创建HEADER位置的x-auth-token,
x-apigateway-ratelimit 含义:引用流控策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-ratelimit