检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划，从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。
规范要求 API生产 API开放 父主题： 附录-API治理规范指导
API开放 安全性 可用性 可维护性 生命周期管理 父主题： 规范要求
必须对API进行统一注册和统一管理，API注册目标系统为API中心。在API发布过程中必须保证API注册信息的准确性，保证API符合国家法规以及安全规定的要求。 API调用成功率>=99.99% 本条规则是MUST类型的基本规则，可保障API的高可用性。
API生产 安全性 可用性 易用性 可维护性 父主题： 规范要求
所有消息头命名格式一致，自定义消息头命名规范：用连词符“-”分隔单词，采用大驼峰方式如X-APIG-TOKEN。 API响应报文使用分页，避免超长列表数据返回 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 获取资源集合的API建议支持分页。
API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则，可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppKey
服务所提供的API版本定义统一规范成“vX”，这里X是一个正整数如：v1，v2等，要在API版本文档中明确在接口中说明清楚哪个版本号是目前服务主推的版本，哪些版本是支持但已经不推荐的版本，方便API调用者通过该接口快速了解与跟进服务API的变化。
在对API日志处理过程中，仅能对API日志进行增维操作，禁止对API日志中重要部分，如请求时间、请求者身份、请求IP地址、请求域名、请求URL地址、响应时间、响应状态码进行篡改。 父主题： API开放
读者对象 API构建者包括：架构师、开发、测试、运维、产品经理、CTO等。 父主题： 概述
附录-API治理规范指导 概述 规范要求 工具平台
API提供方可在API中心完成API发布、变更、下线等生命周期管理。 操作指导 相关操作指导，请参考华为云帮助中心API Hub。 父主题： 附录-API治理规范指导
概述 简介 术语 父主题： 附录-API治理规范指导
本文后续章节将分别描述接口各部分的定义规范。 父主题： 概述
环境管理 API可以同时提供给不同的环境调用，如生产、测试或开发。RELEASE是默认存在的环境，无需创建。 创建环境 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”，填写环境信息。
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题： API网关代理
域名管理 在开放API前，您需要为API分组绑定独立域名，API调用者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。
选择左侧导航栏中的“API订阅管理” ，进入“API订阅管理”页面。 “API订阅管理”页面展示您在API中心门户网站订阅的所有API。您可以在右上角输入API资产名称或服务商名称，筛选想要查看的API。 取消订阅API 进入API中心服务页面。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
