检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
应用场景 API设计开发 当前面临的主要问题 缺少高效的生产作业平台。 多系统数据不互通、学习成本高、数据一致性困难、效率低、无法团队协作。 API中心解决方案 API中心从华为云或生态伙伴选型轻量化、具备便捷开发体验（高效协同、自动化等）的API工具，并对接集成引入到API中心的API工具库，供API开发者使用。
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力（如实时快递查询服务）通过API接口对外开放，供外部伙伴/开发者调用集成，构建更繁荣的业务系统生态，并且触达更广泛的业务范围。 准备工作 准备好API接口文档，推荐OpenAPI 2.0/3.0格式。
根据您是否需要使用API网关代理功能，选择对应的操作。 是：通过向系统提交工单，说明您的业务场景和诉求。 否：直接执行7。 如果入驻服务商时没有开通API网关代理功能，后续如果想要使用API网关代理，可以变更服务商信息，然后向系统提交工单，联系API中心运营人员开通此功能。 等待审核。5
责任共担 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的云安全挑战和无孔不入的云安全威胁与攻击，华为云在遵从法律法规业界标准的基础上，以安全生态圈为护城河，依托华为独有的软硬件优势，构建面向不同区域和行业的完善云服务安全保障体系。 安全性是华为云与您的共同责任，如图1所示。
集群容灾、数据库主备容灾，保障服务的持久性与可靠性。 表1 API中心可靠性架构 可靠性方案 简要说明 跨Region容灾 全局级部件支持跨Region容灾，当主Region异常后，全局业务可以切换到备Region继续运行。 双AZ容灾 Region级部件实现跨AZ双活，一个AZ异常时不影响云服务持续提供服务。
错误码 用户调用API失败时，系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
署任意规模的API。借助API网关代理，可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。API网关代理帮助您变现服务能力的同时，降低企业研发投入，让您专注于企业核心业务，提升运营效率。您需要先申请入驻成为API中心服务商，才可以使用API网关代理功能，具体操作指导参见服务商入驻。
可以自定义配置AppKey和AppSecret。AppKey是身份标识，需要保证全局唯一。 如果没有特殊需求，不建议使用“自定义配置”，系统会默认生成全局标识，可在凭据详情中查看。 单击“确定”，创建凭据。 创建凭据成功后，在凭据管理页面显示新建凭据和凭据ID。 单击凭据名称，
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
API请求URI中如果存在特殊字符，需要进行转义编码 本条规则是MUST类型的基本规则，可保障API的高可用性。 某些字符，由于有特殊含义或者系统保留，容易被Web应用防火墙或者安全访问控制产品所阻断，导致URI调用不生效，因此不建议在URI中使用，如果必须要用需要用转义编码替换。 转义说明可参考：RFC
可维护性：对于API兼容性、日志实时性和完整性、版本管理等提出规范要求或建议，提升API可维护性。 生命周期管理：对API变更和下线等提出规范要求或建议，保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API，Sh
人与人之间的私人消息，如短信、电话通信内容。 API涉及个人数据时，需要提供隐私声明 本条规则是MUST类型的基本规则，可保障API的安全合规。 如果API提供正常业务时涉及个人数据（包含收集、使用、转移、存储等），必须在API发布过程中提供产品隐私声明，描述收集的所有个人数据类型、目的、处理方式、时限等。
注册API到网关代理：将您的API注册到API网关代理，使您的服务能力变现，同时降低企业研发投入，让您专注于企业核心业务，提升运营效率。 消费API：在API中心门户网站中搜索您需要的API，用于系统集成和项目开发使用。
API，并通过API网关代理开放给用户调用。 API包括基本信息、前后端的请求路径、参数以及请求相关协议。 API分组 API分组是同一种业务API的集合，API开发者以API分组为单位，管理分组内的所有API。 域名管理 在开放API前，您需要为API分组绑定独立域名，API调用者通过独立域名访问分组内的API。
XXX的API，增加XXX字段，用于XXX功能。 API下线前必须提前通知订阅服务的用户 本条规则是MUST类型的基本规则，可保障API租户的业务连续性。 对于需要下线的API，需要梳理订阅该API的用户，并通过公告等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动
如果您需要在API中心门户网站搜索需要的API，用于系统集成和项目开发，请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索：输入您需要的API的一些关键信息，如API名称、描述等，系统会展示相关的搜索结果。 按不同维度搜索：
（可选）配置默认后端的系统参数。如果后端服务需要接收系统运行时产生的参数信息，如网关内置参数，可以通过设置系统参数来实现。API网关代理向后端服务发送请求时，将系统参数添加到请求的指定位置，然后将请求发送给后端服务。 在“系统参数”下，单击“添加系统参数”，添加后端服务请求的系统参数。 表7
调用API API发布到环境后，即支持被其他用户调用。根据API所使用的安全认证方式不同，调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API，该子域名每天最多可以访问1000次。 前提条件 在调用API前，确保您所在网络与API的访问域名或地址互通。 获取API的调用信息
在开放API前，您需要为API分组绑定独立域名，API调用者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名：API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名唯一且不可更改，每天最多可以访问1000次。 独立域
1和TLS1.2，推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。 如果API网关代理当前的配额限制无法满足您的需求，您可以向系统提交工单申请更多配额。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
