检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
本。” API文档按照模板进行写作 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API对外开放时，API文档建议使用统一的模板，以便保持API参考文档的一致性，易于开发者理解。在API参考文档中必须包含如下内容： API目录，包括本次提供API的列表信息。
(URI): Generic Syntax）。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则，可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则，可保障API的可维护性。 现网API版本一般保留3个版本或以下，如果超过3个版本会增加API本身的维护量，建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户
对于需要下线的API，需要梳理订阅该API的用户，并通过公告等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动，并在公告服务下线时间后1个月内对API调用进行监控，当没有API调用流量之后，才启动正式下线。待该API到了正式下线后，API中心不再展示下线的API。 父主题： API开放
API分组 创建API分组 域名管理 环境变量 父主题： API网关代理
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题： API网关代理
API工具库 该页面展示的是一些开发API的工具。通过这个页面的工具可以开发API，然后通过创建API资产，将开发好的API分享至API中心。 操作步骤 下面以API Arts工具为例，描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。
对已经订阅的API单个或批量取消订阅：参考取消订阅API。 查看订阅的所有API 进入API中心服务页面。 选择左侧导航栏中的“API订阅管理” ，进入“API订阅管理”页面。 “API订阅管理”页面展示您在API中心门户网站订阅的所有API。您可以在右上角输入API资产名称或服务商名称，筛选想要查看的API。
在API资产列表页，单击API资产名称，查看API资产详情。 修改API资产信息 在API资产列表页，单击API资产所在行“操作”列的“编辑”，修改API资产信息。 删除API资产 在API资产列表页，单击API资产所在行“操作”列的“删除”。 查看API资产包含的接口信息 在AP
产品架构 图1 API中心产品架构 API中心主要包括API工具，API门户，API网关代理，API运营四个产品模块： API工具 API中心通过对接集成API开发工具，为API开发者提供简单易用的API工具，帮助开发者高效地设计、测试API。 API门户 API中心构建面向广大
概述 简介 术语 父主题： 附录-API治理规范指导
术语 API API（Application Programming Interface，应用程序接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。 API Gateway API Gateway（Application
工具平台 API生产阶段 API中心通过对接集成，为API开发者提供API Arts等自动化的API设计/开发/测试工具，开发者通过华为云账号登录后即可使用。 API开放阶段 API开发者（API提供方）可以在API中心申请入驻为服务商，然后自助发布上架API。上架成功后，API将在A
维度针对API生产（API设计/开发/测试）和API开放提供规则建议。 安全：对API的安全认证、涉及敏感信息或个人隐私数据使用和处理提出规范要求或建议，保障API的安全合规。 可用性：对API调用成功率、响应时长、并发及流量控制、吞吐量等提出规范要求或建议，保障API的高可用性。
创建API分组 API分组相当于API的集合，API提供者以API分组为单位，管理分组内的所有API。您在创建API前，需要先创建API分组。 目前支持两种创建分组方式： 创建API分组 创建一个简单的分组，不包含API，用户可自行创建API。 导入Swagger文件 从本地导入已有的API文件，同步创建分组。
的API分组。 API接口 当“导入方式”为下面几种之一时，支持勾选部分接口导入。如果导入全部接口，则忽略此参数。 OpenAPI API网关 Postman Collection API Arts API URL 当“导入方式”为“URL”时，需要填写API资产的URL地址。 根据表2参数信息配置资产基本信息。
API列表 创建API 导入API 导出API 发布API 授权API 调试API 下线API 开启跨域访问 父主题： API网关代理
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
