检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API中心服务商在上架API资产时，如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件，且提供了API资产的访问域名，则该API可以在线调测。 父主题： API网关代理
访问控制策略说明 访问控制策略是API网关代理提供的API安全防护组件之一，主要用来控制访问API的IP地址和账户，您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的，只有将访问控制策略绑定API后，访问控制策略才对绑定的API生效。
API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。
API在创建后，通过指定授权给某些凭据，让指定凭据能够调用API。 仅在API安全认证方式为“APP认证”时，才支持授权给凭据。 单个凭据最多同时授权1000个API。 也可以参考绑定API，将API授权给凭据，与本章所描述方法并无差别。 前提条件 API已发布。 已创建环境。 已创建凭据。 操作步骤 进入API中心服务页面。
API工具库 该页面展示的是一些开发API的工具。通过这个页面的工具可以开发API，然后通过创建API资产，将开发好的API分享至API中心。 操作步骤 下面以API Arts工具为例，描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。
se信息。 调试失败时，返回HTTP状态码为4xx或5xx，具体错误信息请参见错误码。 您可以通过调整请求参数与参数值，发送不同的请求，验证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，该子域名每天最多可以访问1000次。 前提条件 在调用API前，确保您所在网络与API的访问域名或地址互通。 获取API的调用信息 在调用API前，您需要向API提供方获取API的调用信息。
创建负载通道后，在创建API，且后端服务类型为HTTP/HTTPS时，后端服务地址可以直接使用已创建的负载通道。 例如，负载中包含6台ECS，已创建一条负载通道，其中ECS 01和ECS 04已添加到负载通道中，此时API网关代理通过负载通道可以直接访问负载中的ECS 01和ECS 04。 图1 通过API网关代理访问负载通道中的ECS
PS，传输重要或敏感数据时推荐使用HTTPS。 子域名：所在分组的调试域名。 路径：接口请求的路径。请求路径可以包含请求参数，请求参数使用{}标识，例如/a/{b}，也可以通过配置'+'号做前缀匹配，例如：/a/{b+}。 匹配模式 分为两种模式： 绝对匹配：调用的请求Path固定为创建时填写的API请求Path。
全局级部件支持跨Region容灾，当主Region异常后，全局业务可以切换到备Region继续运行。 双AZ容灾 Region级部件实现跨AZ双活，一个AZ异常时不影响云服务持续提供服务。 AZ内集群容灾 通过集群提供服务，集群中每个微服务都有多个实例，当一个或部分实例异常时，其他实例可以持续提供服务。 数据容灾 数
PI受限使用范围，这个受限使用的范围，称为环境。例如：API的测试环境，开发环境等。 环境定义了API生命周期管理过程中的不同状态，API可以被发布到不同的自定义环境中。 调用不同环境的API，一般通过在API调用的请求头增加指定的头部参数，头部参数名固定为x-stage，它的取值为环境名，用以区分不同的环境。
如果在选择环境时，没有自己需要的环境，单击“创建环境”链接，创建一个自己需要的环境。 单击“确定”，完成API发布。 已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户后，选择待下线的API，单击“下线”即可。
对外开放API时，您需要为API分组绑定自己的独立域名。 一个API只能属于某一个API分组。 API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名每天最多可以访问1000次。 创建API分组 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击右上角的“创建API
orization头中签名是否一致，来校验API网关代理的合法性。 使用限制 同一个环境中，一个API只能被一个签名密钥绑定，一个签名密钥可以绑定多个API。 使用流程 图1 签名密钥流程图 在API中心管理控制台创建签名密钥。 将新创建的签名密钥绑定API。 API网关代理将签
在API的设计阶段需要对单位时间可处理的能力进行设计，指标包括吞吐量和并发量。 吞吐量（TPS）是指服务在单位时间内处理请求的数量，使用单位时间为秒。 并发量是指服务可以同时承载的正常使用系统功能的用户的数量。 服务API的最大吞吐量/并发量与承诺的服务吞吐量/并发量需要100%吻合。当发现无法达到承诺的吞
不支持分页查询，则服务应该要设置一个显示条数的默认值，避免一次返回过多资源。默认返回数量需要在接口参考中对外说明，避免调用者以为查询出了全量信息。查询条件中可以设定查询数量(limit)，位移量(offset)。查询资源列表需要返回符合查询条件的资源总数(count)、查询数量(limit)、位移量(offset)。
对于非简单请求，在正式通信之前，浏览器会增加一次HTTP查询请求，称为预检请求。浏览器询问服务器，当前页面所在的源是否在服务器的许可名单之中，以及可以使用哪些HTTP请求方法和头信息字段。预检通过后，浏览器向服务器发送简单请求。 开启跨域访问 API网关代理默认不开启跨域访问，如果您需要开启，请参考以下说明完成跨域配置。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
