检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 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接口文档，推荐OpenAPI 2.0/3.0格式。 准备好API使用指南，说明API凭据获取方式、以及提供API使用时的补充说明信息。
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
通过策略的方式，为API提供灵活的控制策略和扩展能力。 前提条件 一个API只能绑定一个相同类型的策略。 策略和API本身相互独立，只有为API绑定策略后，策略才对API生效。为API绑定策略时需指定发布环境，策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效，不需要重新发布API。
安全合规的API，Should规则在提供更全面指导的基础上，给予开发者灵活的弹性空间，方便开发者更快地加入API生态圈。 适用范围 在华为云API中心发布、用于面向公众开放信息和服务的API。此类API可以充分发挥开发者的创造性，增加企业业务覆盖面和访问流量，是企业新的商业模式和收入来源。
环境变量 API网关代理提供环境变量功能，通过创建环境变量，实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。 当创建API时定义了变量标识，则需要在环境中添
计费说明 API中心当前是免费的平台服务，当前API中心平台本身并不直接面向伙伴/开发者收取费用。 API商业售卖是基于华为云云商店来实现交易和变现，该场景下计费相关信息以华为云云商店相关规定为准。
默认为TCP协议。 检查端口 健康检查的目标端口。 缺省时为负载中主机的端口号。 正常阈值 判定负载通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。 取值为2 ~ 10。缺省时为2。 异常阈值 判定负载通道中主机异常的依据为：连续检查x失败，x为您设置的异常阈值。 取值为2 ~ 10。缺省时为5。
简单请求的跨域访问 如果是创建新的API，在“安全配置”时，打开“支持跨域（CORS）”开关。详细的使用指导，可参考简单请求。 非简单请求的跨域访问 非简单请求的跨域访问需要在API的分组中创建一个“请求方法”为“OPTIONS”的API，作为预检请求。 预检请求API的参数设置
API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程，为您提供高性能、高可用、高安全的API托管服务，能快速将企业服务能力包装成标准API服务，帮助您轻松构建、管理和部署任意规模的API。借助API网关代理，可以简单、快速、低成本、低风险地实现内部系统集成、业务能
配置AppCode 信息项 描述 生成方式 选择AppCode的生成方式。 自动生成：由系统随机生成AppCode。 手动输入：自定义AppCode。 AppCode 仅手动输入方式需要填写AppCode的值。 使用AppCode进行API请求的简易认证 在创建API时，选择“APP认证”并且开启“支持简易认证”。
口仍要能完成正常的功能），并提供替换方式的处理。 新版本API为兼容旧版本，增加的字段不建议作为强制填写的字段，字段取值范围不建议小于原有的取值范围。 API文档记录API接口变更 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 API接口的变更，要具体到参数
名访问分组内的API。 环境 为了方便管理API的生命周期，API网关代理定义了API受限使用范围，这个受限使用的范围，称为环境。例如：API的测试环境，开发环境等。 环境定义了API生命周期管理过程中的不同状态，API可以被发布到不同的自定义环境中。 调用不同环境的API，一般
、数据库主备容灾，保障服务的持久性与可靠性。 表1 API中心可靠性架构 可靠性方案 简要说明 跨Region容灾 全局级部件支持跨Region容灾，当主Region异常后，全局业务可以切换到备Region继续运行。 双AZ容灾 Region级部件实现跨AZ双活，一个AZ异常时不影响云服务持续提供服务。
API技术开放 当前面临的主要问题 业界海量API碎片化分布，缺少统一的汇聚平台展示API。 应用开发者缺少行业价值API的获取途径，不清楚哪些API可用。 API中心解决方案 API中心构建统一汇聚和展示千行百业海量API的开发者门户，为应用开发者提供统一的API搜索查找入口，并
后端服务地址：后端服务的地址。 路径：后端服务的路径。 后端超时 后端服务请求的超时时间。此处默认“5000”ms。 在“返回结果基础定义”页面，定义返回结果。 表5 定义返回结果 信息项 描述 成功响应示例 成功调用API时，返回的响应信息示例。 失败响应示例 调用API失败时，返回的响应信息示例。
果URL为一个已存在的资源，则替换该资源，传入的消息体需包含被替换资源的完整信息。如果传递的信息不完整，在服务实现端需提供对应信息的默认值。 是 DELETE 用于删除资源的场景。 是 HEAD 返回资源的元信息比如：ETag和Last-Modified之类的信息。 是 PATCH
绑定华为IAM认证的API时，租户ID填写API调用者的账号ID。 绑定APP认证的API时，租户ID填写APP所属者的项目ID。 您可以单击控制台右上角的用户名，选择“我的凭证”，在我的凭证页面获取用户的项目ID和账号ID。 阈值 “时长”时间内，此租户访问单个API次数的最大值。 不能大于“API流量限制”值。
sourceIp：API调用者的源地址。 stage：API调用的部署环境。 apiId：API的ID。 appId：API调用者的APP ID。 requestId：当次调用API所生成的请求ID。 serverAddr：网关服务器的地址 。 serverName：网关服务器的名称。 hand
Programing Interface，应用程序接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于软件或硬件得以访问一组例程的能力，而又无需访问源码或理解内部工作机制的细节。API中心是为API开发者和应用开发者构建的海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放AP
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
