检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
云商店开放接口指南 接口使用方法 公共参数 接口列表 公共错误码 APIGW网关错误码 开放接口示例代码 父主题： 联营License客户端软件对接指南
规范要求 API生产 API开放 父主题： 附录-API治理规范指导
API开放 安全性 可用性 可维护性 生命周期管理 父主题： 规范要求
附录-API治理规范指导 概述 规范要求 工具平台
云商店开放接口说明 商家发布License授权码商品时，需要先在卖家中心申请测试授权码，然后通过公网调试云商店开放接口。 商家调用激活授权码和授权码心跳检测两个接口成功后，可以在卖家中心查看测试授权码的激活状态和心跳检测状态。 父主题： 云商店开放接口描述
API生产 安全性 可用性 易用性 可维护性 父主题： 规范要求
云商店开放接口 接口使用方法 公共参数 接口列表 父主题： SaaS类商品接入指南 V2.0（新商品上架）
云商店开放接口描述 云商店开放接口说明 接口使用方法 公共参数 接口兼容性说明 接口列表 测试授权码激活和心跳检测 错误码 父主题： 联营License类授权码商品接入指南（2.0版本）
工具平台 API生产阶段 API中心通过对接集成，为API开发者提供API Arts等自动化的API设计/开发/测试工具，开发者通过华为云账号登录后即可使用。 API开放阶段 API开发者（API提供方）可以在API中心申请入驻为服务商，然后自助发布上架API。上架成功后，API将在A
对外API规范 API规范示例 为了对外API在调用时有用户信息，API调用时需要在header中传递Modifier、Creator字段。 值格式为：用户名+空格+用户id，如图1所示。
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
"count":1540 } API入参/出参设计必须考虑开发者易于使用 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API设计的输入参数开发者要易于获取，输出参数要让开发者易于理解。降低开发者使用API的使用成本，提升API使用体验。避免API的输入参数要通过多次前置条件API的查询获得。
简介 目的 主要用于指导伙伴、开发者在华为云API中心生产和开放API。通过统一的API治理框架和规范，帮助伙伴、开发者构建并提供有质量保障的API服务，为平台营造良好能力开放与交互的环境，支撑华为云和伙伴及开发者共建API生态。 API治理规范主要从安全、可用性、易用性、可维护
帮助。 上传文件 选择本地API文件上传。 API分组 当“导入方式”选择“API网关”时，支持选择API网关代理中的API分组。 API接口 当“导入方式”为下面几种之一时，支持勾选部分接口导入。如果导入全部接口，则忽略此参数。 OpenAPI API网关 Postman Collection
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
束。 必须对API进行统一注册和统一管理，API注册目标系统为API中心。在API发布过程中必须保证API注册信息的准确性，保证API符合国家法规以及安全规定的要求。 API调用成功率>=99.99% 本条规则是MUST类型的基本规则，可保障API的高可用性。 API调用成功定义
(URI): Generic Syntax）。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则，可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC
术语 API API（Application Programming Interface，应用程序接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。 API Gateway API Gateway（Application
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
/instance/metadata API建议明确标识出版本号 本条规则是Should类型的扩展规则，可提升API的可维护性。 每个API建议带上版本号，保证API的版本显性化，容易被API调用者所识别。版本号建议放置在URI中，用于显性标识所请求的API版本。 服务所提供的API版本定义统一规范成“vX”
概述 简介 术语 父主题： 附录-API治理规范指导
对于需要下线的API，需要梳理订阅该API的用户，并通过公告等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动，并在公告服务下线时间后1个月内对API调用进行监控，当没有API调用流量之后，才启动正式下线。待该API到了正式下线后，API中心不再展示下线的API。 父主题： API开放
生产API 使用场景 如果您想要使用API中心提供的工具开发API，请参考本章指导操作。 操作步骤 下面以API Arts工具为例，描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”，进入API
导入API API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。
取消入驻服务商 生产API API中心为开发者引入自动化的API工具（如API Arts），帮助API开发者高效设计/开发/测试API。支持从API Arts将开发好的API文件一键式导入API中心。 支持区域： 华北-北京四 使用API Arts开发API API资产分享 API中心服务商
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
