检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
规范要求 API生产 API开放 父主题： 附录-API治理规范指导
附录-API治理规范指导 概述 规范要求 工具平台
涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括： 密码、AK/SK、Token等身份凭据。
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划，从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口，需要正
并发请求控制：指API最大允许的客户端连接数量。 吞吐量（TPS）控制：指API单位时间内可并发处理的能力。 传输流量控制：指API单位时间内传输的数据量。 API发布过程中必须保证API注册信息的准确性 本条规则是MUST类型的基本规则，可保障API的高可用性。 API发布是API生命周
“查询虚拟机列表”：GET /servers “创建VPC网络”：POST /vpc “删除虚拟机标签”：DELETE /server/tag “创建/更新数据库实例元数据”：PUT /instance/metadata API建议明确标识出版本号 本条规则是Should类型的扩展规则，可提升API的可维护性。
Identifiers (URI): Generic Syntax）。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则，可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
API生产 安全性 可用性 易用性 可维护性 父主题： 规范要求
标准消息头及其取值格式按照参考标准，并尽量最小化添加自定义消息头。 所有消息头命名格式一致，自定义消息头命名规范：用连词符“-”分隔单词，采用大驼峰方式如X-APIG-TOKEN。 API响应报文使用分页，避免超长列表数据返回 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 获取资源
API开放 安全性 可用性 可维护性 生命周期管理 父主题： 规范要求
API提供方可在API中心完成API发布、变更、下线等生命周期管理。 操作指导 相关操作指导，请参考华为云帮助中心API Hub。 父主题： 附录-API治理规范指导
API数据分析 API数据分析页面通过图表的形式，直观地展示您在API网关代理中已经发布的所有API被调用的情况。 前提条件 已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 查看步骤 进入API中心服务页面。 在左侧导航栏选择“API数据分析”。 资源概览区域参数的含义如表1所示。
概述 简介 术语 父主题： 附录-API治理规范指导
安全：对API的安全认证、涉及敏感信息或个人隐私数据使用和处理提出规范要求或建议，保障API的安全合规。 可用性：对API调用成功率、响应时长、并发及流量控制、吞吐量等提出规范要求或建议，保障API的高可用性。 易用性：对API参考文档描述、入参和出参、消息头定义等提出规范要求或建议，提升API调用者使用体验。
的一个公共服务，是所有API注册和发布的入口。 JSON JSON(JavaScript Object Notation) 是一个轻量级的数据交换格式，它易于人类读写及其解析生成。 HTTP HTTP（Hyper Text Transfer Protocol）是超文本传输协议。 HTTPS
导入API API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。
AZ内集群容灾 通过集群提供服务，集群中每个微服务都有多个实例，当一个或部分实例异常时，其他实例可以持续提供服务。 数据容灾 数据存储在RDS服务中，RDS实现了AZ容灾方案，数据持续会同步到容灾站点，当生产站点的RDS异常后，容灾站点可以接管业务，保障云服务持续运行。 父主题： 安全
哪些API支持在线调测？ API中心服务商在上架API资产时，如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件，且提供了API资产的访问域名，则该API可以在线调测。 父主题： API网关代理
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
