检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
名称，所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API对外开放时，API文档建议使用统一的模板，以便保持API参考文档的一致性，易于开发者理解。在API参考文档中必须包含如下内容：
错误码 用户调用API失败时，系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
消费API 使用场景 如果您需要在API中心门户网站搜索需要的API，用于系统集成和项目开发，请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索：输入您需要的API的一些关键信息，如API名称、描述等，系统会展示相关的搜索结果。
域名管理 在开放API前，您需要为API分组绑定独立域名，API调用者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名：API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名唯一且不可更改，每天最多可以访问1000次。
约束与限制 API中心的使用限制如下： 创建API资产：每个用户最多可以创建50个API资产。 API网关代理：API网关代理使用限制如表1所示。 表1 API网关代理使用限制 限制项 限制值 API分组数量 每个用户最多可以创建50个API分组。 独立域名数量 每个分组最多可以绑定5个独立域名。
可用性 API请求URI中如果存在特殊字符，需要进行转义编码 本条规则是MUST类型的基本规则，可保障API的高可用性。 某些字符，由于有特殊含义或者系统保留，容易被Web应用防火墙或者安全访问控制产品所阻断，导致URI调用不生效，因此不建议在URI中使用，如果必须要用需要用转义编码替换。
概述 API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程，为您提供高性能、高可用、高安全的API托管服务，能快速将企业服务能力包装成标准API服务，帮助您轻松构建、管理和部署任意规模的API。借助API网关代理，可以简单、快速、低成本、低风险地实现内部系统集
创建凭据并绑定API 使用APP认证的API，需要在API网关代理中创建一个凭据，以生成凭据ID和密钥对（Key、Secret）。将创建的凭据绑定API后，才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API，无需创建凭据。 创建凭据 进入API中心服务页面。
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力（如实时快递查询服务）通过API接口对外开放，供外部伙伴/开发者调用集成，构建更繁荣的业务系统生态，并且触达更广泛的业务范围。 准备工作 准备好API接口文档，推荐OpenAPI 2.0/3.0格式。
应用场景 API设计开发 当前面临的主要问题 缺少高效的生产作业平台。 多系统数据不互通、学习成本高、数据一致性困难、效率低、无法团队协作。 API中心解决方案 API中心从华为云或生态伙伴选型轻量化、具备便捷开发体验（高效协同、自动化等）的API工具，并对接集成引入到API中心的API工具库，供API开发者使用。
调用API API发布到环境后，即支持被其他用户调用。根据API所使用的安全认证方式不同，调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API，该子域名每天最多可以访问1000次。 前提条件 在调用API前，确保您所在网络与API的访问域名或地址互通。
API门户 您可以在API中心门户网站搜索行业价值API，用于您的系统集成和项目开发使用。支持以下两种方式访问API中心门户网站： 直接访问API中心门户网站。 进入API中心服务页面。，单击左侧导航栏中的“API门户”链接，跳转至API中心门户网站。 API中心门户网站支持用户在免登录情况下搜索和查看API。
取消入驻服务商 您如果想要取消在API中心入驻服务商，可以参考本章指导操作。 前提条件 仅允许华为云账号取消入驻服务商，不允许该账号下的IAM用户取消入驻服务商。 已删除该华为云账号及其下的IAM用户注册在API网关代理的所有API。 已删除该华为云账号及其下的IAM用户分享在API中心门户网站的所有API资产。
创建API API提供者把API接口配置在API网关代理中，开放后端能力。创建API主要分为两个步骤： 前端配置 支持配置前端定义、安全配置和请求参数。 后端配置 支持配置默认后端、策略后端和返回结果。 API网关代理是基于REST的API架构，API的开放和调用需要遵循RESTful相关规范。
服务商入驻 API中心管理控制台的以下功能只允许API中心服务商使用，如果您想要使用以下功能，需要先申请入驻成为API中心服务商： API资产管理：通过创建API资产，将您开发好的API分享至API中心门户网站，供其他开发者搜索和调用。 API网关代理：API网关代理包括API的
上架API至API中心门户网站 使用场景 如果您想要将已开发好的API上架至API中心门户网站，请参考本章指导操作。 前提条件 已完成服务商入驻，具体操作指导参考《用户指南》服务商入驻章节。 操作步骤 进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。
注册API到网关代理 使用场景 如果您想要将已开发好的API注册到API中心网关，请参考本章指导操作。 前提条件 已完成服务商入驻，具体操作指导参考《用户指南》服务商入驻章节。 使用流程 作为API提供者开放API，您需要先后完成以下流程： 步骤1：创建API分组 进入API中心服务页面。
API资产管理 通过创建API资产，将您开发好的API分享至API中心门户网站，其他开发者就可以在API中心门户网站搜索到您分享的API，用于自己的项目开发。 前提条件 已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 1个服务商最多可以创建50个API资产。 1
概述 API中心是一个汇聚了海量的API的平台。通过汇聚丰富的行业能力API，帮助API开发者高效便捷的分享和开放API，支持应用开发者快速查找所需API并进行应用开发和集成。API中心覆盖了API生产、API开放、API消费全场景，一站式体验。 本文档为您提供生产API、开放A
可用性 API需要配置并发请求及流量控制 本条规则是Should类型的扩展规则，可提升API的可用性。 在API发布之前，需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分：并发请求控制，吞吐量控制和传输流量控制。 并发请求控制：指API最大允许的客户端连接数量。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
