检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 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开发者可以申请入驻成
名称，所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API对外开放时，API文档建议使用统一的模板，以便保持API参考文档的一致性，易于开发者理解。在API参考文档中必须包含如下内容：
用、高安全的API托管服务，能快速将企业服务能力包装成标准API服务，帮助您轻松构建、管理和部署任意规模的API。借助API网关代理，可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。API网关代理帮助您变现服务能力的同时，降低企业研发投入，让您专注于
API设计、测试一站式高效协同，API数据自动同步。 API设计与文档实时同步，设计即文档。 API测试与设计同源，设计示例一键导入测试步骤。 API开放简单体验 一键上架：API生产工具中的API资产可以一键上架到API门户，实现开放分享。 API消费快速匹配 支持智能搜索和推荐，缩短应用开发
est请求，从而克服了AJAX只能同源使用的限制。 CORS请求分为两类： 简单请求：头信息之中，增加一个Origin字段。 非简单请求：在正式通信之前，增加一次HTTP查询请求。 开启CORS（非简单请求）时，您需要创建一个“请求方法”为“OPTIONS”的API，具体操作请参考开启跨域访问。
指导 API中心通过生产API、开放API、消费API场景，指导用户快速上手。 生产API 生产API 开放API 上架API至API中心门户网站 注册API到网关代理 消费API 消费API 05 实践 部署web环境 什么是ECS 创建容器应用基本流程 快速创建一个kubernetes集群
导入API API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。
术语 API API（Application Programming Interface，应用程序接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。 API Gateway API Gateway（Application
哪些API支持在线调测？ API中心服务商在上架API资产时，如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件，且提供了API资产的访问域名，则该API可以在线调测。 父主题： API网关代理
可用性 API请求URI中如果存在特殊字符，需要进行转义编码 本条规则是MUST类型的基本规则，可保障API的高可用性。 某些字符，由于有特殊含义或者系统保留，容易被Web应用防火墙或者安全访问控制产品所阻断，导致URI调用不生效，因此不建议在URI中使用，如果必须要用需要用转义编码替换。
与其他服务的关系 API Arts API中心将API Arts作为API生产工具提供给API开发者，并支持API开发者将工具中的API文档一键发布到API中心进行分享和开放。 API Explorer API中心对接集成API Explorer，并将其作为API中心的API调试
基本概念 API API（Application Programming Interface，应用程序编程接口）是一些预先定义的函数，应用将自身的服务能力封装成API，并通过API网关代理开放给用户调用。 API包括基本信息、前后端的请求路径、参数以及请求相关协议。 API分组
域名管理 在开放API前，您需要为API分组绑定独立域名，API调用者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名：API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名唯一且不可更改，每天最多可以访问1000次。
调用API API发布到环境后，即支持被其他用户调用。根据API所使用的安全认证方式不同，调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API，该子域名每天最多可以访问1000次。 前提条件 在调用API前，确保您所在网络与API的访问域名或地址互通。
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则，可保障API的可维护性。 现网API版本一般保留3个版本或以下，如果超过3个版本会增加API本身的维护量，建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户
错误码 用户调用API失败时，系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
导出API 导出JSON或YAML格式的API。API网关代理支持单个API导出和批量API导出。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导出API”，设置导出参数。 表1 导出API 信息项 描述 API分组
可用性 API需要配置并发请求及流量控制 本条规则是Should类型的扩展规则，可提升API的可用性。 在API发布之前，需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分：并发请求控制，吞吐量控制和传输流量控制。 并发请求控制：指API最大允许的客户端连接数量。
响应消息头 调用API时，API网关代理增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关代理调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求，都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
