检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
保护后端服务。为了提供持续稳定的服务，您可以通过创建流控策略，针对部分API进行流量控制。 使用限制 同一个环境中，一个API只能被一个流控策略绑定，但一个流控策略可以绑定多个API。 配置参数说明 表1 配置参数说明 信息项 描述 策略名称 API流控策略名称。 类型 分“基础流控”和“共享流控”两类。
支持以下6种方式，上架API文件至API中心门户网站： OpenAPI：支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关：支持将API网关代理中已发布的API，上架至API中心门户网站。 Postman Collection：支持将Postman
本文档为您提供生产API、开放API、消费API的操作指导。您可以根据自身需求，选择一个或多个场景进行操作。 生产API：通过API工具库中提供的工具，完成API的设计、测试。 开放API： 上架API至API中心门户网站：通过创建API资产，将您开发好的API分享在API中心门户网站，供其他开发者调用。 注册
支持以下6种方式，上架API文件至API中心门户网站： OpenAPI：支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关：支持将API网关代理中已发布的API，上架至API中心门户网站。 Postman Collection：支持将Postman
支持以下6种方式，上架API文件至API中心门户网站： OpenAPI：支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关：支持将API网关代理中已发布的API，上架至API中心门户网站。 Postman Collection：支持将Postman
定API后，访问控制策略才对绑定的API生效。 使用限制 同一个环境中，一个API只能被一个限制IP地址的访问控制策略绑定。 同一个环境中，一个API只能被一个限制账号名的访问控制策略绑定。 一个访问控制策略可以绑定多个API。 配置参数说明 表1 配置参数说明 信息项 描述 策略名称
创建API分组 创建一个简单的分组，不包含API，用户可自行创建API。 导入Swagger文件 从本地导入已有的API文件，同步创建分组。 对外开放API时，您需要为API分组绑定自己的独立域名。 一个API只能属于某一个API分组。 API分组创建后，系统为分组自动分配一个内部测试用的
创建策略 通过策略的方式，为API提供灵活的控制策略和扩展能力。 前提条件 一个API只能绑定一个相同类型的策略。 策略和API本身相互独立，只有为API绑定策略后，策略才对API生效。为API绑定策略时需指定发布环境，策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效，不需要重新发布API。
单击“下一步”，进入后端配置。 后端配置 支持定义多个策略后端，即满足一定条件后转发给指定的API后端服务，用以满足不同的调用场景。例如为了区分普通调用与特殊调用，可以定义一个“策略后端”，通过调用方的源IP地址，为特殊调用方分配专用的后端服务。 除了定义一个默认的API后端服务，一个API共可以定义5个策略后端。
环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。 当创建API时定义了变量标识，则需要在环境中添加变量。例如创建API时定义了变量名为“Path”，在环境1中创建了变量名“Path”，变量值“/Stage/test”，则A
创建凭据并绑定API 使用APP认证的API，需要在API网关代理中创建一个凭据，以生成凭据ID和密钥对（Key、Secret）。将创建的凭据绑定API后，才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API，无需创建凭据。 创建凭据 进入API中心服务页面。
通过设置IP地址或账户的黑白名单来禁止或允许某个IP地址或账户访问API。 凭据 凭据定义了一个API调用者的身份。API中心支持将一个API授权给多个凭据，也支持将多个API授权给同一个凭据。 签名密钥 签名密钥由一对Key和Secret组成，用于后端服务验证API网关代理的身
双AZ容灾 Region级部件实现跨AZ双活，一个AZ异常时不影响云服务持续提供服务。 AZ内集群容灾 通过集群提供服务，集群中每个微服务都有多个实例，当一个或部分实例异常时，其他实例可以持续提供服务。 数据容灾 数据存储在RDS服务中，RDS实现了AZ容灾方案，数据持续会同步到容
说明、发布时间和发布环境），并支持回滚到不同的API历史版本。 已发布的API，在修改信息后，需要重新发布才能将修改后的信息同步到环境中。 同一个API在每个环境中最多记录10条最新的发布历史。 前提条件 已创建环境。 发布API 进入API中心服务页面。 在左侧导航栏选择“API网关代理
为简易认证绑定AppCode 简易认证指调用API时，在HTTPS请求头部消息增加一个参数“X-Apig-AppCode”（参数值填凭据详情中“AppCode”的值），而不需要对请求内容签名，API网关代理也仅校验AppCode，不校验请求签名，从而实现快速响应。 当使用APP认
每个API建议带上版本号，保证API的版本显性化，容易被API调用者所识别。版本号建议放置在URI中，用于显性标识所请求的API版本。 服务所提供的API版本定义统一规范成“vX”，这里X是一个正整数如：v1，v2等，要在API版本文档中明确在接口中说明清楚哪个版本号是目前服务主推的版本，哪些版本是支持但已
网关代理传过来的Authorization头中签名是否一致，来校验API网关代理的合法性。 使用限制 同一个环境中，一个API只能被一个签名密钥绑定，一个签名密钥可以绑定多个API。 使用流程 图1 签名密钥流程图 在API中心管理控制台创建签名密钥。 将新创建的签名密钥绑定API。
本条规则是MUST类型的基本规则，可保障API的高可用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验，避免出现因请求消息体格式错误导致的执行异常。 API响应内容格式需要与响应设置媒体类型和编码格式一致。在API响应中对媒体类型和编码格式的正确定义有助于服务端对请求体
填写的独立域名必须已备案，并且已解析，详情请参考《用户指南》域名管理章节中的“前提条件”。 步骤3：创建API 在左侧导航栏选择“API网关代理 > API列表”。 单击“创建API”。 配置前端定义。 图2 前端定义 表2 前端定义 参数 配置说明 API名称 系统默认自动生成一个API名称，建议按照一定的命名规则填写，方便后期快速识别和查找。
前进行备案。 已将独立域名CNAME解析到分组的子域名上，具体方法请参见增加CNAME类型记录集。 如果API分组中的API支持HTTPS请求协议，那么在独立域名中需要添加SSL证书，请您提前获取SSL证书的内容和密钥，并创建SSL证书。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
