检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开启跨域访问 什么是跨域访问 浏览器出于安全性考虑，会限制从页面脚本内发起的跨域访问（CORS）请求，此时页面只能访问同源的资源。而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求，从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类： 简单请求 简单跨域请求的场景需要满足以下两个条件：
API列表 创建API 导入API 导出API 发布API 授权API 调试API 下线API 开启跨域访问 父主题： API网关代理
请参考发布API发布。 支持跨域CORS 是否开启跨域访问CORS（cross-origin resource sharing）。 CORS允许浏览器向跨域服务器，发出XMLHttpRequest请求，从而克服了AJAX只能同源使用的限制。 CORS请求分为两类： 简单请求：头信息之中，增加一个Origin字段。
禁止在API请求中携带超长报文体 本条规则是MUST类型的基本规则，可保障API的高可用性。 API通道默认请求报文体长度（Body Size）限制为2MB，默认请求Header长度（Header Size）限制为1MB。 明确API吞吐量与并发量 本条规则是Should类型的扩展规则，可提升API的可用性。
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
Bad Gateway 代理服务器尝试执行请求时，从上游服务器接收到无效的响应。 API请求设置媒体类型和编码格式，响应内容格式需与响应设置媒体类型和编码格式一致 本条规则是MUST类型的基本规则，可保障API的高可用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请
调试API 发布API 授权API 下线API 开启跨域访问 负载通道 环境管理 创建策略 流量控制策略 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。同时支持通过添加特殊应用或特殊租户对某一凭据或用户设置专有的流量控制策略。 支持区域： 华北-北京四
API响应报文使用分页，避免超长列表数据返回 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页，避免一次查询获取的资源数量过多。 不支持分页查询，则服务应该要设置一个显示条数的默认值，避免一次返回
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划，从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口，需要正
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则，可保障API的可维护性。 现网API版本一般保留3个版本或以下，如果超过3个版本会增加API本身的维护量，建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户
生命周期管理：对API变更和下线等提出规范要求或建议，保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API，Should规则在提供更全面指导的基础上，给予开发者灵活的弹性空间，方便开发者更快地加入API生态圈。
流量控制：API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。 访问控制：API网关代理支持通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API，保护后端服务。 父主题： 安全
仅在“类型”为“IP地址”时，需要设置。 说明： 允许或禁止访问的IP地址条数，分别最多可以配置100条。 账号名 输入需要允许或者禁止访问API的账号名，仅在API的安全认证方式为“华为IAM认证”时适用。 仅在“类型”为“账号名”时，需要设置。支持输入多个账号名，以英文“,”隔开，如aaa
单击“创建API”。 配置前端定义。 图2 前端定义 表2 前端定义 参数 配置说明 API名称 系统默认自动生成一个API名称，建议按照一定的命名规则填写，方便后期快速识别和查找。 所属分组 默认创建API分组中已创建分组。 URL 请求方法：接口调用方式，此处选择“GET”。 请求协议
细信息对话框。 如果想要设置之前版本为当前版本，则在版本所在行，单击“切换至此版本”，弹出“切换至此版本”对话框。 单击“确定”，完成版本的切换。此时版本号旁边括号里显示“当前版本”，说明设置成功。API调用者调用此API时，API参数以“当前版本”设置的参数值为准。 查看已发布API被调用情况
缺省时为负载中主机的端口号。 正常阈值 判定负载通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。 取值为2 ~ 10。缺省时为2。 异常阈值 判定负载通道中主机异常的依据为：连续检查x失败，x为您设置的异常阈值。 取值为2 ~ 10。缺省时为5。 超时时间 检查期间，无响应的时间，单位为秒。
根据获取API的请求信息中获取的请求参数进行设置。 {Header}：请求头参数，格式为“参数名: 参数取值”，例如Content-Type: application/json。需根据获取API的请求信息中获取的Headers进行设置。 {Body}：请求消息体，JSON格式。需
资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。 说明： 同一个华为云账号下的API资产名称不能重复。 图标 为API资产设置一个图标。如果不设置，则显示默认图标。 资产简介 简单介绍下API资产的行业，用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP，用于API在线调试。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
