检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API 操作场景 API提供者把API接口配置在API网关中，开放后端能力。 创建API主要分为四个步骤：设置基本信息、定义API请求、定义后端服务和定义返回结果。 API网关服务基于REST的API架构，API的开放和调用需要遵循RESTful相关规范。 前提条件 已创建A
配置API的HTTP响应头 API响应是指API网关向客户端返回的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 如果此策略在当前实例中不支持，请联系技术支持升级实例到最新版本。 策略参数会明文展示，为防止信息泄露，请谨慎配置。
{Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endp
配置API的第三方认证 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务，收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持，可提交工单升级实例到最新版本。 第三方认证原理图如下，第三方认证策略绑定API
以换行符结束。 释义： 查询字符串，即查询参数。如果没有查询参数，则为空字符串，即规范后的请求为空行。 格式： 规范查询字符串需要满足以下要求： 根据以下规则对每个参数名和值进行URI编码： 请勿对RFC 3986定义的任何非预留字符进行URI编码，这些字符包括：A-Z、a-z、0-9、-、_、
错误码 当调用API时，可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 通过APIG接口管理API，发生错误时，产生的错误码请参考错误码。 使用APIG错误码时，请以错误码（如APIG.0101）为准，错误信息并非固定不变，有时会对错误信息进行优化修改。
通过APIG创建REST API REST API（Representational State Transfer Application Programming Interface）是基于HTTP协议，通过对API的操作来实现客户端和服务器之间的通信，一种用于构建网络应用程序的
SOC/PCI等）的安全合规认证，用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求，具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书 另外，华为云还提供了以下销售许可证及软件著作权证书，供用户下载和参考。具体请查看合规资质证书。
通过APIG创建GRPC API API网关支持创建GRPC API。gRPC是RPC（远程过程调用）的一种，只需定义每个API的Request和Response，剩下的gRPC框架就可以完成。它的典型特征就是使用protobuf（protocol buffers）作为其接口定义语言（Interface
用户可以根据自己的业务场景选择合适的APIG专享版规格，在此做如下推荐： 如果用户对API并发调用、带宽的要求不高，建议使用APIG专享版基础版实例。 如果用户对API并发调用和带宽有更高的要求，建议用户按照实际的需求选择对应的实例规格。
配置API的响应缓存 您可以通过配置响应缓存策略将后端服务（服务端）返回的应答缓存在API网关中，当客户端发送相同的请求时，网关不用向后端传递请求，直接返回缓存的应答。有效降低后端的负荷，同时减少API调用的延迟。 当使用响应缓存策略时，后端的响应内容会缓存到API网关中，此时A
理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM）。 如果华为云账号已经能满足您的要求，不需要创建独立的IAM用户，您可以跳过本章节，不影响您使用API网关服务的其它功能。 仅API网关专享版支持精细的细粒度授权。 默认情况
离。 将API网关服务资源委托给更专业、高效的其他账号或者云服务，这些账号或者云服务可以根据权限进行代运维。 如果华为云账号已经能满足您的要求，不需要创建独立的IAM用户，您可以跳过本章节，不影响您使用API网关服务的功能。 本章节为您介绍对用户授权的方法，操作流程如图1所示。 前提条件
色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。例如：针对API网关服务，管
配置API的跨域资源共享 出于安全性考虑，浏览器会限制从页面脚本内发起的跨域请求，此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求，从而实现跨域访问。更多跨域访问的说明请参见跨域调用APIG开放的API。 跨域资源共享策略为跨域访问
什么是API网关 API网关（API Gateway）是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务，能快速将企业服务能力包装成标准API接口，帮助您轻松构建、管理和部署任意规模的API，并上架API云商店进行售卖。借助API网关，可以简单、快速、低成本、低风险地实
配置API的流量控制2.0 流量控制2.0策略可以限制单位时间内API的被调用次数，支持参数流控、基础流控和基于基础流控的特殊流控。 基础流控 可以对API、用户、凭据、源IP进行多维度流控，与已有的配置API的流量控制功能一致但不兼容。 参数流控 支持根据Header、Path
配置API的Kafka日志推送 Kafka日志推送策略提供了把API的详细调用日志推送到Kafka的能力，方便用户获取API的调用日志信息。 如果此策略在当前实例中不支持，可提交工单升级实例到最新版本。 约束与限制 同一个环境中，一个API只能被一个Kafka日志推送策略绑定，但
业务高峰预测：如果能预测到业务高峰期，如电商促销季、节假日等，可提前购买包年/包月资源以应对高峰期的需求，避免资源紧张。 数据安全要求高：对于对数据安全性要求较高的业务，包年/包月计费模式可确保资源的持续使用，降低因资源欠费而导致的数据安全风险。 适用计费项 以下计费项支持包年/包月。
使用API网关进行API的托管流程如下图所示。 图1 业务使用流程 创建用户并授权使用APIG 通过IAM服务创建用户并授权使用API网关，如果系统预置的APIG权限不满足授权要求，您也可以创建自定义策略。 创建APIG实例 实例是一个独立的资源空间，所有的操作都是在实例内进行，不同实例间的资源相互隔离。因此，要开放API对外提供服务，首先需要创建实例。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
