检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 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运行”页面。
环境变量 在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API在不同环境中调用不同的后端服务。 流量控制 流量控制支持从用户、凭据、源IP和时间段等不同的维度限制对API的调用次数，保护后端服务。
如果在URL中设置变量，那么必须在待发布环境上配置变量名和变量值，否则变量无法赋值，API将无法正常调用。 变量名严格区分大小写。 自定义host头域 仅在使用负载通道时，可设置。
在生产环境的API不能包含“test、uat、sit、beta”等字样，API名称只支持中文、字母、数字以及“_”或者"-"，API名称长度建议不超过150字符。
管理控制台的“调试”功能，固定为调试环境，不支持携带环境变量调试。 后续操作 创建完环境和环境变量后，您可以将API发布到环境，以便API调用者调用。 父主题： API策略
API分组 创建API分组 域名管理 环境变量 父主题： API网关代理
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。
环境变量数量 每个分组在任意一个环境中，最多可以创建50个环境变量。 负载通道数量 每个用户最多可以创建10个VPC通道，每个负载通道最多可以添加10个服务器。 参数数量 每个API最多可以创建50个参数。 发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。
在API发布过程中必须保证API注册信息的准确性，保证API符合国家法规以及安全规定的要求。 API调用成功率>=99.99% 本条规则是MUST类型的基本规则，可保障API的高可用性。 API调用成功定义：调用API时响应码为除5XX外其余响应码。
表1 HTTP动词 方法 描述 幂等性 POST 适用于新建资源场景，以及CRUD无法表达的操作场景（Non-CRUD）。 否 GET 用于获取资源的场景，必须具备安全性。 是 PUT 如果操作的URL为一个新资源，则创建该资源。
添加环境变量 通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。 修改分组信息 在分组所在行“操作”列，单击“编辑”，对分组名称及描述进行修改。 导出分组 在分组所在行“操作”列，单击“更多>导出”。 删除分组 在分组所在行“操作”列，单击“更多>删除”。
API请求设置媒体类型和编码格式，响应内容格式需与响应设置媒体类型和编码格式一致 本条规则是MUST类型的基本规则，可保障API的高可用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验，避免出现因请求消息体格式错误导致的执行异常。
API下线前必须提前通知订阅服务的用户 本条规则是MUST类型的基本规则，可保障API租户的业务连续性。 对于需要下线的API，需要梳理订阅该API的用户，并通过公告等方式向订阅API的用户进行提醒。
API涉及个人数据时，需要提供隐私声明 本条规则是MUST类型的基本规则，可保障API的安全合规。 如果API提供正常业务时涉及个人数据（包含收集、使用、转移、存储等），必须在API发布过程中提供产品隐私声明，描述收集的所有个人数据类型、目的、处理方式、时限等。
单击需要创建的策略类型。 传统策略 不同的策略类型，策略内容的配置不同： 流量控制策略说明 访问控制策略说明 签名密钥策略说明 单击“确定”。 策略创建后，您还需要为API绑定策略，才能使策略对API生效。 为API绑定策略 单击策略名称，进入策略详情。
创建负载通道后，在创建API，且后端服务类型为HTTP/HTTPS时，后端服务地址可以直接使用已创建的负载通道。
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。
支持“HMAC”、“Basic Auth”、“Public Key”和“Aes”四种认证类型。 支持区域： 华北-北京四 签名密钥策略说明 凭据管理 使用APP认证的API，需要在API网关代理中创建一个凭据，以生成凭据ID和密钥对（Key、Secret）。
包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API，Should规则在提供更全面指导的基础上，给予开发者灵活的弹性空间，方便开发者更快地加入API生态圈。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
