检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
代理服务器尝试执行请求时，从上游服务器接收到无效的响应。 API请求设置媒体类型和编码格式，响应内容格式需与响应设置媒体类型和编码格式一致 本条规则是MUST类型的基本规则，可保障API的高可用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验，避免出现因请求消息体格式错误导致的执行异常。
易用性 API名称必须易于理解、见名知义 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API名称要简洁、易于理解、见名知义，建议按照“动词+名词”格式。 在生产环境的API不能包含“test、uat、sit、beta”等字样，API名称只支持中文、字母、
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划，从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口，需要正
API涉及个人数据时，需要提供隐私声明 本条规则是MUST类型的基本规则，可保障API的安全合规。 如果API提供正常业务时涉及个人数据（包含收集、使用、转移、存储等），必须在API发布过程中提供产品隐私声明，描述收集的所有个人数据类型、目的、处理方式、时限等。 建议使用POST/PUT方式提交个人数据
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 在“策略管理”页面，单击“创建策略”。 单击需要创建的策略类型。 传统策略 不同的策略类型，策略内容的配置不同： 流量控制策略说明 访问控制策略说明 签名密钥策略说明 单击“确定”。 策略创建后，您还需要为API绑定策略，才能使策略对API生效。
用VPC的内部子网通信，网络时延更低，同时负载通道具有负载均衡功能，从而实现后端服务的负载均衡。 创建负载通道后，在创建API，且后端服务类型为HTTP/HTTPS时，后端服务地址可以直接使用已创建的负载通道。 例如，负载中包含6台ECS，已创建一条负载通道，其中ECS 01和ECS
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
禁止在API请求中携带超长报文体 本条规则是MUST类型的基本规则，可保障API的高可用性。 API通道默认请求报文体长度（Body Size）限制为2MB，默认请求Header长度（Header Size）限制为1MB。 明确API吞吐量与并发量 本条规则是Should类型的扩展规则，可提升API的可用性。
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则，可保障API的可维护性。 现网API版本一般保留3个版本或以下，如果超过3个版本会增加API本身的维护量，建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户
表1 配置参数说明 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址：允许/禁止访问API的IP地址。 账号名：允许/禁止访问API的账号名。 动作 包括“允许”和“禁止”。 和“类型”配合使用，允许/禁止访问API的IP地址/账号名。 IP地址
自定义名称，用于识别不同的密钥。 类型 选择签名密钥的认证类型，可选择“HMAC”、“Basic Auth”、“Public Key”和“Aes”。 签名算法 选择Aes的签名算法，包含以下两种： aes-128-cfb aes-256-cfb Key 根据选择的密钥类型，填写不同的密钥信息。
给后端服务。 字节限制 最大长度/最大值：“类型”为“STRING”时，设置参数值的最大字符串长度，“类型”为“NUMBER”时，设置参数值的最大值。 最小长度/最小值：“类型”为“STRING”时，设置参数值的最小字符串长度，“类型”为“NUMBER”时，设置参数值的最小值。 示例
服务信息。 选择后端服务类型，此处选择“HTTP/HTTPS”。 表4 HTTP/HTTPS类型定义后端服务 服务参数 参数说明 负载通道 选择“不使用”负载通道访问后端服务。 URL 请求方法：接口调用方式，此处选择“GET”。 请求协议：选择协议类型，此处选择“HTTP”。 后端服务地址：后端服务的地址。
升API可维护性。 生命周期管理：对API变更和下线等提出规范要求或建议，保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API，Should规则在提供更全面指导的基础上，给予
PI并获得商业收益。 间接变现：API能力开放给应用开发者，供其在应用开发和集成中调用。应用生产出来后，可在华为云云商店上架SaaS等应用类型商品，实现API的间接变现，获得商业收益。
已备案独立域名，未备案的独立域名无法被访问。备案时长需几个工作日，建议您提前进行备案。 已将独立域名CNAME解析到分组的子域名上，具体方法请参见增加CNAME类型记录集。 如果API分组中的API支持HTTPS请求协议，那么在独立域名中需要添加SSL证书，请您提前获取SSL证书的内容和密钥，并创建SSL证书。
X-Apig-Upstream-Latency 从API网关代理请求后端到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug，且后端服务类型不为Mock时，返回此参数 X-Apig-RateLimit-api API流量控制信息 示例：remain:9,limit:10,time:10
同一个环境中，一个API只能被一个流控策略绑定，但一个流控策略可以绑定多个API。 配置参数说明 表1 配置参数说明 信息项 描述 策略名称 API流控策略名称。 类型 分“基础流控”和“共享流控”两类。 基础流控：针对单个API进行流量统计和控制。 共享流控：针对绑定了该策略的所有API进行总流量统计和控制。
API网关代理请求后端服务时，保障后端服务的安全。支持“HMAC”、“Basic Auth”、“Public Key”和“Aes”四种认证类型。 支持区域： 华北-北京四 签名密钥策略说明 凭据管理 使用APP认证的API，需要在API网关代理中创建一个凭据，以生成凭据ID和密钥
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
