检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力（如实时快递查询服务）通过API接口对外开放，供外部伙伴/开发者调用集成，构建更繁荣的业务系统生态，并且触达更广泛的业务范围。 准备工作 准备好API接口文档，推荐OpenAPI 2.0/3.0格式。
应用场景 API设计开发 当前面临的主要问题 缺少高效的生产作业平台。 多系统数据不互通、学习成本高、数据一致性困难、效率低、无法团队协作。 API中心解决方案 API中心从华为云或生态伙伴选型轻量化、具备便捷开发体验（高效协同、自动化等）的API工具，并对接集成引入到API中心的API工具库，供API开发者使用。
署任意规模的API。借助API网关代理，可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。API网关代理帮助您变现服务能力的同时，降低企业研发投入，让您专注于企业核心业务，提升运营效率。您需要先申请入驻成为API中心服务商，才可以使用API网关代理功能，具体操作指导参见服务商入驻。
集群容灾、数据库主备容灾，保障服务的持久性与可靠性。 表1 API中心可靠性架构 可靠性方案 简要说明 跨Region容灾 全局级部件支持跨Region容灾，当主Region异常后，全局业务可以切换到备Region继续运行。 双AZ容灾 Region级部件实现跨AZ双活，一个AZ异常时不影响云服务持续提供服务。
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
安全性是华为云与您的共同责任，如图1所示。 华为云：负责云服务自身的安全，提供安全的云。华为云的安全责任在于保障其所提供的IaaS、PaaS和SaaS各类各项云服务自身的安全，涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务
错误码 用户调用API失败时，系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
API数据分析：查看API网关代理中已发布的API被调用的情况，如被请求调用的次数，调用失败的次数等。 只允许华为云企业账号申请成为API中心服务商。 前提条件 已完成华为云账号企业用户实名认证。 仅允许华为云账号入驻API中心服务商，不允许该账号下的IAM用户入驻API中心服务商。 操作步骤 进入API中心服务页面。
API，并通过API网关代理开放给用户调用。 API包括基本信息、前后端的请求路径、参数以及请求相关协议。 API分组 API分组是同一种业务API的集合，API开发者以API分组为单位，管理分组内的所有API。 域名管理 在开放API前，您需要为API分组绑定独立域名，API调用者通过独立域名访问分组内的API。
PI租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API，Should规则在提供更全面指导的基础上，给予开发者灵活的弹性空间，方便开发者更快地加入API生态圈。 适用范围 在华为云API中心
您如果想要取消在API中心入驻服务商，可以参考本章指导操作。 前提条件 仅允许华为云账号取消入驻服务商，不允许该账号下的IAM用户取消入驻服务商。 已删除该华为云账号及其下的IAM用户注册在API网关代理的所有API。 已删除该华为云账号及其下的IAM用户分享在API中心门户网站的所有API资产。
API每次最大可以调用12M的请求包。 TLS协议 支持TLS1.1和TLS1.2，推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。 如果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分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名唯一且不可更改，每天最多可以访问1000次。 独立域
华为云集成工作台、低代码平台等华为云或生态伙伴相关服务或产品，为API开发者提供高效协同、自动化的API生产工具，并支持高价值API商业售卖；为应用开发者提供多场景、低门槛的低代码应用开发环境和开箱即用的API。 通过统一汇聚和持续运营，华为云API中心贯通并粘合API生产、AP
API请求URI中如果存在特殊字符，需要进行转义编码 本条规则是MUST类型的基本规则，可保障API的高可用性。 某些字符，由于有特殊含义或者系统保留，容易被Web应用防火墙或者安全访问控制产品所阻断，导致URI调用不生效，因此不建议在URI中使用，如果必须要用需要用转义编码替换。 转义说明可参考：RFC
可以自定义配置AppKey和AppSecret。AppKey是身份标识，需要保证全局唯一。 如果没有特殊需求，不建议使用“自定义配置”，系统会默认生成全局标识，可在凭据详情中查看。 单击“确定”，创建凭据。 创建凭据成功后，在凭据管理页面显示新建凭据和凭据ID。 单击凭据名称，
人与人之间的私人消息，如短信、电话通信内容。 API涉及个人数据时，需要提供隐私声明 本条规则是MUST类型的基本规则，可保障API的安全合规。 如果API提供正常业务时涉及个人数据（包含收集、使用、转移、存储等），必须在API发布过程中提供产品隐私声明，描述收集的所有个人数据类型、目的、处理方式、时限等。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
