检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 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展示在API中心门户网站。 父主题： API网关代理
API响应报文使用分页，避免超长列表数据返回 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页，避免一次查询获取的资源数量过多。 不支持分页查询，则服务应该要设置一个显示条数的默
禁止在API请求中携带超长报文体 本条规则是MUST类型的基本规则，可保障API的高可用性。 API通道默认请求报文体长度（Body Size）限制为2MB，默认请求Header长度（Header Size）限制为1MB。 明确API吞吐量与并发量 本条规则是Should类型的扩展规则，可提升API的可用性。
Syntax）。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则，可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC 7231（Hypertext
本条规则是Should类型的扩展规则，可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划，从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口，需要正式发布接口变更公告，应当至少提前6个月在文档标识（使用@de
如何获取API调用凭据？ 如果是来源于华为云服务的API，您可通过token认证或AK/SK认证进行API的在线调测和调用。在线调测时，用户登录华为云账号后，API中心会为您自动获取Token或者自动生成临时AK/SK，帮助您直接进行在线调测；调用API时，可根据参数填写项的提示
谁为API使用者提供技术支持？ API中心主要是作为API汇聚和运营API的平台，支撑API开发者和应用开发者更高效便捷的开放和使用API。API相关的技术支持等服务，由API提供方即API服务商负责。 父主题： API售卖与技术支持
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
服务商入驻成功后可以取消入驻吗？ 服务商入驻成功后信息还可以修改吗？ API网关代理 是否必须使用API中心的网关代理功能？ 哪些API支持在线调测？ 如何获取API调用凭据？ API售卖与技术支持 如何对API进行商业售卖？ 谁为API使用者提供技术支持？
如何对API进行商业售卖？ 您可以通过华为云云商店，将API作为商品对外售卖。具体参见发布API类商品操作指南。 父主题： API售卖与技术支持
API涉及个人数据时，需要提供隐私声明 本条规则是MUST类型的基本规则，可保障API的安全合规。 如果API提供正常业务时涉及个人数据（包含收集、使用、转移、存储等），必须在API发布过程中提供产品隐私声明，描述收集的所有个人数据类型、目的、处理方式、时限等。 建议使用POST/PUT方式提交个人数据
生产API 使用场景 如果您想要使用API中心提供的工具开发API，请参考本章指导操作。 操作步骤 下面以API Arts工具为例，描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”，进入API
是 PATCH 用于部分更新资源的场景，如果使用PUT操作所需输入的整体资源信息内容大小与PATCH操作无太大差异，优先使用PUT操作，不推荐使用PATCH操作。 是 OPTIONS 获取当前资源支持哪些方法的信息。 是 例如：使用正确的HTTP动词。 “查询虚拟机列表”：GET
图标 为API资产设置一个图标。如果不设置，则显示默认图标。 资产简介 简单介绍下API资产的行业，用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP，用于API在线调试。 分类 选择API资产所属行业，方便API资产在API中心门户网站按行业类别被搜索。
至API中心。 操作步骤 下面以API Arts工具为例，描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”，进入API Arts工具界面。 参考API设计和API测试章节指导，在API
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
PI调用者使用体验。 可维护性：对于API兼容性、日志实时性和完整性、版本管理等提出规范要求或建议，提升API可维护性。 生命周期管理：对API变更和下线等提出规范要求或建议，保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规
API门户 您可以在API中心门户网站搜索行业价值API，用于您的系统集成和项目开发使用。支持以下两种方式访问API中心门户网站： 直接访问API中心门户网站。 进入API中心服务页面。，单击左侧导航栏中的“API门户”链接，跳转至API中心门户网站。 API中心门户网站支持用户在免登录情况下搜索和查看API。
图标 为API资产设置一个图标。如果不设置，则显示默认图标。 资产简介 简单介绍下API资产的行业，用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP，用于API在线调试。 分类 选择API资产所属行业，方便API资产在API中心门户网站按行业类别被搜索。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
