检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
签名密钥：API网关代理提供签名密钥，用于后端服务校验API网关代理是否合法。 访问控制 流量控制：API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。 访问控制：API网关代理支持通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API，保护后端服务。
Gateway（Application Programming Interface gateway，API网关）是当前API的一个公共服务，是所有API注册和发布的入口。 JSON JSON(JavaScript Object Notation) 是一个轻量级的数据交换格式，它易于人类读写及其解析生成。
工具平台 API生产阶段 API中心通过对接集成，为API开发者提供API Arts等自动化的API设计/开发/测试工具，开发者通过华为云账号登录后即可使用。 API开放阶段 API开发者（API提供方）可以在API中心申请入驻为服务商，然后自助发布上架API。上架成功后，API
API生产 安全性 可用性 易用性 可维护性 父主题： 规范要求
API开放 安全性 可用性 可维护性 生命周期管理 父主题： 规范要求
本条规则是Should类型的扩展规则，可提升API的可用性。 在API发布之前，需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分：并发请求控制，吞吐量控制和传输流量控制。 并发请求控制：指API最大允许的客户端连接数量。 吞吐量（TPS）控制：指API单位时间内可并发处理的能力。 传输流量控制：指API单位时间内传输的数据量。
涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括： 密码、AK/SK、Token等身份凭据。
在API请求Header或者Query中携带AppId和AppKey用于进行身份认证，该认证方法直接传递密钥，在使用过程中需要使用HTTPS协议保证传输安全。 签名认证 请求Header或者Query中携带请求签名、请求时间和应用身份进行身份认证，该认证方法对请求中URI、HTT
下内容： API目录，包括本次提供API的列表信息。 API名称及API功能介绍。 API请求方法和URI。 API请求参数说明，包括Header、Query参数，需要明确字段内容和取值范围。 API请求Body内容，Body内容需要明确请求结构体内容及各个字段的取值范围。 API响应状态码，状态码及对应的说明。
保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。 在对API日志
果超过3个版本会增加API本身的维护量，建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户端的契约，不能单方面破坏契约。通过如下的方式来保证向后的兼容性： 遵循兼容扩展标准。 忽略请求/响应中的未知字段。 只添加可选字段，不能添加必选字段。
API文档记录API接口变更 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 API接口的变更，要具体到参数级别，必须将API修订的记录按照时间和版本顺序排列进行条目化，具体示例如表1所示。 表1 API修订记录 时间 版本 变更内容 2021-07-15 V1.0 XXX服务API初始发布
API中心 API中心（API Hub）是为API开发者和应用开发者构建的，海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放API，支持应用开发者快速查找所需API并进行应用开发和集成。API中心贯通并粘合API生产、API开放和API消费，促进API供需匹配，形成API生产、消费、再生产的良性循环。
开放后端能力。创建API主要分为两个步骤： 前端配置 支持配置前端定义、安全配置和请求参数。 后端配置 支持配置默认后端、策略后端和返回结果。 API网关代理是基于REST的API架构，API的开放和调用需要遵循RESTful相关规范。 前提条件 已创建API分组。如果未创建API分组，请创建API分组。
API分组 创建API分组 域名管理 环境变量 父主题： API网关代理
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题： API网关代理
服务商 服务商入驻 变更服务商信息 取消入驻服务商
API网关代理 是否必须使用API中心的网关代理功能？ 哪些API支持在线调测？ 如何获取API调用凭据？
API售卖与技术支持 如何对API进行商业售卖？ 谁为API使用者提供技术支持？
修订记录 发布日期 修订记录 2023-05-31 第七次正式发布。 优化如下章节： 上架API至API中心门户网站 2023-03-31 第六次正式发布。 优化如下章节： 上架API至API中心门户网站 消费API 2023-03-22 第五次正式发布。 优化如下章节： 生产API
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
