检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API开放 安全性 可用性 可维护性 生命周期管理 父主题： 规范要求
开放API 上架API至API中心门户网站 注册API到网关代理
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力（如实时快递查询服务）通过API接口对外开放，供外部伙伴/开发者调用集成，构建更繁荣的业务系统生态，并且触达更广泛的业务范围。 准备工作 准备好API接口文档，推荐OpenAPI 2.0/3.0格式。
oken和AK/SK。 如果是来源于华为云市场的API商品，可按照页面提示完成购买，然后在“买家中心>已购买的服务”中看到商品信息，单击“资源详情”可查看API调用凭据（AppKey/AppSecret）。 如果是其他来源的技术开放型API，可根据API使用指南或者联系API服务商获取API调用凭据。
Generic Syntax）。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则，可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC 7231（Hypertext
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
本条规则是Should类型的扩展规则，可提升API的可用性。 在API的设计阶段需要对单位时间可处理的能力进行设计，指标包括吞吐量和并发量。 吞吐量（TPS）是指服务在单位时间内处理请求的数量，使用单位时间为秒。 并发量是指服务可以同时承载的正常使用系统功能的用户的数量。 服务API的最大吞吐量
默认为TCP协议。 检查端口 健康检查的目标端口。 缺省时为负载中主机的端口号。 正常阈值 判定负载通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。 取值为2 ~ 10。缺省时为2。 异常阈值 判定负载通道中主机异常的依据为：连续检查x失败，x为您设置的异常阈值。 取值为2 ~ 10。缺省时为5。
以查看API的详细信息。 获取API的调用凭据 需要付费购买的API（来源于华为云市场的API），可按照页面引导和提示，完成API购买，然后在“买家中心>已购买的服务”中看到商品信息，单击“资源详情”可查看API调用凭据（AppKey/AppSecret）。 不需要付费购买的AP
后端服务地址：后端服务的地址。 路径：后端服务的路径。 后端超时 后端服务请求的超时时间。此处默认“5000”ms。 在“返回结果基础定义”页面，定义返回结果。 表5 定义返回结果 信息项 描述 成功响应示例 成功调用API时，返回的响应信息示例。 失败响应示例 调用API失败时，返回的响应信息示例。
独立域名：您自定义的域名，API调用者通过访问独立域名来调用您开放的API。 独立域名不能重复。 前提条件 已有独立域名。可通过域名注册服务申请新的域名。 已备案独立域名，未备案的独立域名无法被访问。备案时长需几个工作日，建议您提前进行备案。 已将独立域名CNAME解析到分组的子域名上，
API中心是一个汇聚了海量的API的平台。通过汇聚丰富的行业能力API，帮助API开发者高效便捷的分享和开放API，支持应用开发者快速查找所需API并进行应用开发和集成。API中心覆盖了API生产、API开放、API消费全场景，一站式体验。 本文档为您提供生产API、开放API、消费API的操作指导
口仍要能完成正常的功能），并提供替换方式的处理。 新版本API为兼容旧版本，增加的字段不建议作为强制填写的字段，字段取值范围不建议小于原有的取值范围。 API文档记录API接口变更 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 API接口的变更，要具体到参数
OpenAPI：支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关：支持将API网关代理中已发布的API，上架至API中心门户网站。 Postman Collection：支持将Postman Collection开发的API，上架至API中心门户网站。
生命周期管理：对API变更和下线等提出规范要求或建议，保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API，Should规则在提供更全面指导的基础上，给予开发者灵活的弹性空间，方便开发者更快地加入API生态圈。
sourceIp：API调用者的源地址。 stage：API调用的部署环境。 apiId：API的ID。 appId：API调用者的APP ID。 requestId：当次调用API所生成的请求ID。 serverAddr：网关服务器的地址 。 serverName：网关服务器的名称。 hand
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
Interface，应用程序接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于软件或硬件得以访问一组例程的能力，而又无需访问源码或理解内部工作机制的细节。API中心是为API开发者和应用开发者构建的海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放API，支持应用开发者快速查找所需API并进行应用开发和集成。
订阅成功后，鼠标放在“联系咨询”上面，就会显示服务商的电话和邮箱。您可以通过已获取的联系方式联系服务商，获取API的调用方式。 单击“已订阅”，可以取消订阅API。 获取API的调用凭据。 需要付费购买的API（来源于华为云市场的API），可按照页面引导和提示，完成API购买，然后在“买家中心>已购买的服务”中看到商
华为云：负责云服务自身的安全，提供安全的云。华为云的安全责任在于保障其所提供的IaaS、PaaS和SaaS各类各项云服务自身的安全，涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身，也包括
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
