检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
与特殊调用，可以定义一个“策略后端”，通过调用方的源IP地址，为特殊调用方分配专用的后端服务。 除了定义一个默认的API后端服务，一个API共可以定义5个策略后端。 定义默认后端。 添加策略后端前必须定义一个默认后端，当不满足任何一个策略后端的API请求，都将转发到默认的API后端。
的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。 当创建API时定义了变量标识，则需要在环境中添加变量。例如创建API时定义了变量名为“Path”，在环境1中创建了
API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。 前提条件
描述 凭据的介绍。 （可选）单击“自定义配置”后面的，展开自定义配置区域，可以自定义配置AppKey和AppSecret。AppKey是身份标识，需要保证全局唯一。 如果没有特殊需求，不建议使用“自定义配置”，系统会默认生成全局标识，可在凭据详情中查看。 单击“确定”，创建凭据。
供服务。 AZ内集群容灾 通过集群提供服务，集群中每个微服务都有多个实例，当一个或部分实例异常时，其他实例可以持续提供服务。 数据容灾 数据存储在RDS服务中，RDS实现了AZ容灾方案，数据持续会同步到容灾站点，当生产站点的RDS异常后，容灾站点可以接管业务，保障云服务持续运行。
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
环境 为了方便管理API的生命周期，API网关代理定义了API受限使用范围，这个受限使用的范围，称为环境。例如：API的测试环境，开发环境等。 环境定义了API生命周期管理过程中的不同状态，API可以被发布到不同的自定义环境中。 调用不同环境的API，一般通过在API调用的请求
API异常响应Body内容，异常响应Body中描述及说明。 API请求尽量少使用自定义消息头 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 标准消息头及其取值格式按照参考标准，并尽量最小化添加自定义消息头。 所有消息头命名格式一致，自定义消息头命名规范：用连词符“-”分
“创建/更新数据库实例元数据”：PUT /instance/metadata API建议明确标识出版本号 本条规则是Should类型的扩展规则，可提升API的可维护性。 每个API建议带上版本号，保证API的版本显性化，容易被API调用者所识别。版本号建议放置在URI中，用于显性标识所请求的API版本。
在使用过程中需要使用HTTPS协议保证传输安全。 签名认证 请求Header或者Query中携带请求签名、请求时间和应用身份进行身份认证，该认证方法对请求中URI、HTTP方法、AppId、SignKey、请求时间等采用HMAC-SHA256进行计算，在API请求过程中不会直接传
本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。 在对API日志处理过程中，仅能对API日
identifier），对资源的操作不会改变这些标识，所有的操作都是无状态的，使用标准方法操作资源。 RESTful风格的服务接口需定义：操作名、URL、请求和响应消息体和响应状态码。 本文后续章节将分别描述接口各部分的定义规范。 父主题： 概述
易用性：对API参考文档描述、入参和出参、消息头定义等提出规范要求或建议，提升API调用者使用体验。 可维护性：对于API兼容性、日志实时性和完整性、版本管理等提出规范要求或建议，提升API可维护性。 生命周期管理：对API变更和下线等提出规范要求或建议，保障已订阅API租户的业务连续性。 包含Must类型的基本规则
代理服务器尝试执行请求时，从上游服务器接收到无效的响应。 API请求设置媒体类型和编码格式，响应内容格式需与响应设置媒体类型和编码格式一致 本条规则是MUST类型的基本规则，可保障API的高可用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验，避免出现因请求消息体格式错误导致的执行异常。
什么是API中心 API（Application Programing Interface，应用程序接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于软件或硬件得以访问一组例程的能力，而又无需访问源码或理解内部工作机制的细节。API中心是为API开发者和应用开发者构建的
传输流量控制：指API单位时间内传输的数据量。 API发布过程中必须保证API注册信息的准确性 本条规则是MUST类型的基本规则，可保障API的高可用性。 API发布是API生命周期中重要的部分，因此在发布过程中需要保证API的正确性、可读性、可用性，并对服务质量进行约束。 必
作日，建议您提前进行备案。 已将独立域名CNAME解析到分组的子域名上，具体方法请参见增加CNAME类型记录集。 如果API分组中的API支持HTTPS请求协议，那么在独立域名中需要添加SSL证书，请您提前获取SSL证书的内容和密钥，并创建SSL证书。 操作步骤 进入API中心服务页面。
头中签名是否一致，来校验API网关代理的合法性。 配置参数说明 表1 配置参数说明 信息项 描述 密钥名称 自定义名称，用于识别不同的密钥。 类型 选择签名密钥的认证类型，可选择“HMAC”、“Basic Auth”、“Public Key”和“Aes”。 签名算法 选择Aes的签名算法，包含以下两种：
填写的独立域名必须已备案，并且已解析，详情请参考《用户指南》域名管理章节中的“前提条件”。 步骤3：创建API 在左侧导航栏选择“API网关代理 > API列表”。 单击“创建API”。 配置前端定义。 图2 前端定义 表2 前端定义 参数 配置说明 API名称 系统默认自动生成一个API名称
创建负载通道后，在创建API，且后端服务类型为HTTP/HTTPS时，后端服务地址可以直接使用已创建的负载通道。 例如，负载中包含6台ECS，已创建一条负载通道，其中ECS 01和ECS 04已添加到负载通道中，此时API网关代理通过负载通道可以直接访问负载中的ECS 01和ECS 04。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
