检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
响应消息头 调用API时，API网关代理增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关代理调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求，都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时
注册API到网关代理 使用场景 如果您想要将已开发好的API注册到API中心网关，请参考本章指导操作。 前提条件 已完成服务商入驻，具体操作指导参考《用户指南》服务商入驻章节。 使用流程 作为API提供者开放API，您需要先后完成以下流程： 步骤1：创建API分组 进入API中心服务页面
创建凭据并绑定API 使用APP认证的API，需要在API网关代理中创建一个凭据，以生成凭据ID和密钥对（Key、Secret）。将创建的凭据绑定API后，才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API，无需创建凭据。 创建凭据 进入API中心服务页面
API数据分析 API数据分析页面通过图表的形式，直观地展示您在API网关代理中已经发布的所有API被调用的情况。 前提条件 已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 查看步骤 进入API中心服务页面。 在左侧导航栏选择“API数据分析”。 资源概览区域参数的含义如表
哪些API支持在线调测？ API中心服务商在上架API资产时，如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件，且提供了API资产的访问域名，则该API可以在线调测。 父主题： API网关代理
为简易认证绑定AppCode 简易认证指调用API时，在HTTPS请求头部消息增加一个参数“X-Apig-AppCode”（参数值填凭据详情中“AppCode”的值），而不需要对请求内容签名，API网关代理也仅校验AppCode，不校验请求签名，从而实现快速响应。 当使用APP认证
是否必须使用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可以同时提供给不同的环境调用，如生产、测试或开发。RELEASE是默认存在的环境，无需创建。 创建环境 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”，填写环境信息。 表1 环境信息 信息项
负载通道 负载通道主要用于将服务通过API网关代理开放给外部访问，它的优势在于使用VPC的内部子网通信，网络时延更低，同时负载通道具有负载均衡功能，从而实现后端服务的负载均衡。 创建负载通道后，在创建API，且后端服务类型为HTTP/HTTPS时，后端服务地址可以直接使用已创建的负载通道
可用性 API请求URI中如果存在特殊字符，需要进行转义编码 本条规则是MUST类型的基本规则，可保障API的高可用性。 某些字符，由于有特殊含义或者系统保留，容易被Web应用防火墙或者安全访问控制产品所阻断，导致URI调用不生效，因此不建议在URI中使用，如果必须要用需要用转义编码替换
错误码 用户调用API失败时，系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
访问控制策略说明 访问控制策略是API网关代理提供的API安全防护组件之一，主要用来控制访问API的IP地址和账户，您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的，只有将访问控制策略绑定API后，访问控制策略才对绑定的
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
易用性 API名称必须易于理解、见名知义 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API名称要简洁、易于理解、见名知义，建议按照“动词+名词”格式。 在生产环境的API不能包含“test、uat、sit、beta”等字样，API名称只支持中文、字母、数字以及
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppKey
域名管理 在开放API前，您需要为API分组绑定独立域名，API调用者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名：API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名唯一且不可更改，每天最多可以访问1000
环境变量 API网关代理提供环境变量功能，通过创建环境变量，实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。 当创建API时定义了变量标识，则需要在环境中添加变量
流量控制策略说明 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。为了提供持续稳定的服务，您可以通过创建流控策略，针对部分API进行流量控制。 使用限制 同一个环境中，一个API只能被一个流控策略绑定，但一个流控策略可以绑定多个API。 配置参数说明
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
