检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
附录-API治理规范指导 概述 规范要求 工具平台
概述 简介 术语 父主题： 附录-API治理规范指导
规范要求 API生产 API开放 父主题： 附录-API治理规范指导
API网关代理 是否必须使用API中心的网关代理功能？ 哪些API支持在线调测？ 如何获取API调用凭据？
API售卖与技术支持 如何对API进行商业售卖？ 谁为API使用者提供技术支持？
修订记录 发布日期 修订记录 2023-05-31 第七次正式发布。 优化如下章节： 上架API至API中心门户网站 2023-03-31 第六次正式发布。 优化如下章节： 上架API至API中心门户网站 消费API 2023-03-22 第五次正式发布。 优化如下章节： 生产API
开放API 上架API至API中心门户网站 注册API到网关代理
API生产 安全性 可用性 易用性 可维护性 父主题： 规范要求
API开放 安全性 可用性 可维护性 生命周期管理 父主题： 规范要求
只允许授权的访问。 签名密钥：API网关代理提供签名密钥，用于后端服务校验API网关代理是否合法。 访问控制 流量控制：API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。 访问控制：API网关代理支持通过设置IP地址或账户的黑白名单来禁
进入API中心服务页面，在左侧导航栏选择“服务商入驻”，申请入驻服务商。 在API中心门户网站首页，单击页面右上角的“服务商入驻”，进入申请入驻服务商页面。 仅支持华为云企业用户申请入驻API中心服务商。 父主题： 服务商入驻
生命周期管理：对API变更和下线等提出规范要求或建议，保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API，Should规则在提供更全面指导的基础上，给予开发者灵活的弹性空间，方便开发者更快地加入API生态圈。
阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则，可提升API的可维护性。 HTTP方法的需要符合幂等性的约束，幂等性的约束是指一次和多次请求某一个资源应该具有同样的副作用，单
运维运营安全，以及更广义的安全合规遵从。 租户：负责云服务内部的安全，安全地使用云。 华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类各项云服务内部的安全以及对租户定制配置进行安全有效的管理，包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统，虚拟防火墙、API网
性能、高可用、高安全的API托管服务。 API数据分析：查看API网关代理中已经发布的API被调用的情况，如被请求调用的次数，调用失败的次数等。 支持区域： 华北-北京四 服务商入驻 变更服务商信息 取消入驻服务商 生产API API中心为开发者引入自动化的API工具（如API
Programing Interface，应用程序接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于软件或硬件得以访问一组例程的能力，而又无需访问源码或理解内部工作机制的细节。API中心是为API开发者和应用开发者构建的海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放AP
订阅成功后，鼠标放在“联系咨询”上面，就会显示服务商的电话和邮箱。您可以通过已获取的联系方式联系服务商，获取API的调用方式。 单击“已订阅”，可以取消订阅API。 获取API的调用凭据。 需要付费购买的API（来源于华为云市场的API），可按照页面引导和提示，完成API购买，然后在“买家中心>已购买的服务”中看到商
于XXX功能。 XXX的API，增加XXX字段，用于XXX功能。 API下线前必须提前通知订阅服务的用户 本条规则是MUST类型的基本规则，可保障API租户的业务连续性。 对于需要下线的API，需要梳理订阅该API的用户，并通过公告等方式向订阅API的用户进行提醒。通知需要在服务
能说明API的用途，场景及约束。 API描述信息建议使用Markdown格式编写，便于生成对应API文档，API描述信息长度建议不超过2000字符。 例如：发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表，列表包括
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
