检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
给后端服务。 字节限制 最大长度/最大值：“类型”为“STRING”时，设置参数值的最大字符串长度，“类型”为“NUMBER”时，设置参数值的最大值。 最小长度/最小值：“类型”为“STRING”时，设置参数值的最小字符串长度，“类型”为“NUMBER”时，设置参数值的最小值。 示例
API请求参数说明，包括Header、Query参数，需要明确字段内容和取值范围。 API请求Body内容，Body内容需要明确请求结构体内容及各个字段的取值范围。 API响应状态码，状态码及对应的说明。 API响应参数说明包括Header参数，需要明确字段内容和取值范围。 API正常响应Body内
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
端的契约，不能单方面破坏契约。通过如下的方式来保证向后的兼容性： 遵循兼容扩展标准。 忽略请求/响应中的未知字段。 只添加可选字段，不能添加必选字段。 不能更改字段的含义。 当资源URL发生变化的时候，支持重定向。 服务端提供新版本API的同时，需要对老版本API提供支持。 例如
API涉及个人数据时，需要提供隐私声明 本条规则是MUST类型的基本规则，可保障API的安全合规。 如果API提供正常业务时涉及个人数据（包含收集、使用、转移、存储等），必须在API发布过程中提供产品隐私声明，描述收集的所有个人数据类型、目的、处理方式、时限等。 建议使用POST/PUT方式提交个人数据
代理服务器尝试执行请求时，从上游服务器接收到无效的响应。 API请求设置媒体类型和编码格式，响应内容格式需与响应设置媒体类型和编码格式一致 本条规则是MUST类型的基本规则，可保障API的高可用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验，避免出现因请求消息体格式错误导致的执行异常。
禁止在API请求中携带超长报文体 本条规则是MUST类型的基本规则，可保障API的高可用性。 API通道默认请求报文体长度（Body Size）限制为2MB，默认请求Header长度（Header Size）限制为1MB。 明确API吞吐量与并发量 本条规则是Should类型的扩展规则，可提升API的可用性。
能完成正常的功能），并提供替换方式的处理。 新版本API为兼容旧版本，增加的字段不建议作为强制填写的字段，字段取值范围不建议小于原有的取值范围。 API文档记录API接口变更 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 API接口的变更，要具体到参数级别，
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 在“策略管理”页面，单击“创建策略”。 单击需要创建的策略类型。 传统策略 不同的策略类型，策略内容的配置不同： 流量控制策略说明 访问控制策略说明 签名密钥策略说明 单击“确定”。 策略创建后，您还需要为API绑定策略，才能使策略对API生效。
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
同一个环境中，一个API只能被一个流控策略绑定，但一个流控策略可以绑定多个API。 配置参数说明 表1 配置参数说明 信息项 描述 策略名称 API流控策略名称。 类型 分“基础流控”和“共享流控”两类。 基础流控：针对单个API进行流量统计和控制。 共享流控：针对绑定了该策略的所有API进行总流量统计和控制。
Origin：此字段必选，表示请求消息所属源。 Access-Control-Request-Method：此字段必选，表示请求会使用哪些HTTP请求方法。 Access-Control-Request-Headers：此字段可选，表示请求会额外发送的头信息字段。 后端服务返回消息：无。
API网关代理请求后端服务时，保障后端服务的安全。支持“HMAC”、“Basic Auth”、“Public Key”和“Aes”四种认证类型。 支持区域： 华北-北京四 签名密钥策略说明 凭据管理 使用APP认证的API，需要在API网关代理中创建一个凭据，以生成凭据ID和密钥
升API可维护性。 生命周期管理：对API变更和下线等提出规范要求或建议，保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API，Should规则在提供更全面指导的基础上，给予
表1 配置参数说明 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址：允许/禁止访问API的IP地址。 账号名：允许/禁止访问API的账号名。 动作 包括“允许”和“禁止”。 和“类型”配合使用，允许/禁止访问API的IP地址/账号名。 IP地址
用VPC的内部子网通信，网络时延更低，同时负载通道具有负载均衡功能，从而实现后端服务的负载均衡。 创建负载通道后，在创建API，且后端服务类型为HTTP/HTTPS时，后端服务地址可以直接使用已创建的负载通道。 例如，负载中包含6台ECS，已创建一条负载通道，其中ECS 01和ECS
通过集群提供服务，集群中每个微服务都有多个实例，当一个或部分实例异常时，其他实例可以持续提供服务。 数据容灾 数据存储在RDS服务中，RDS实现了AZ容灾方案，数据持续会同步到容灾站点，当生产站点的RDS异常后，容灾站点可以接管业务，保障云服务持续运行。 父主题： 安全
自定义名称，用于识别不同的密钥。 类型 选择签名密钥的认证类型，可选择“HMAC”、“Basic Auth”、“Public Key”和“Aes”。 签名算法 选择Aes的签名算法，包含以下两种： aes-128-cfb aes-256-cfb Key 根据选择的密钥类型，填写不同的密钥信息。
服务信息。 选择后端服务类型，此处选择“HTTP/HTTPS”。 表4 HTTP/HTTPS类型定义后端服务 服务参数 参数说明 负载通道 选择“不使用”负载通道访问后端服务。 URL 请求方法：接口调用方式，此处选择“GET”。 请求协议：选择协议类型，此处选择“HTTP”。 后端服务地址：后端服务的地址。
API定义范围 基础定义：只导出API前端定义。其中API前端定义除了Swagger规范定义项外，还包括API网关代理的一些Swagger扩展字段。 全量定义：导出API前端定义和后端定义。 扩展定义：导出API前端定义、后端定义、API关联的流量控制、访问控制等策略及绑定关系。 导出格式
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
