检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。RSA为不安全的加密算法,推荐您使用ECDSA和DSA加密算法。 表2 SSL证书配置 参数 配置说明 证书名称 填写SSL证书的名称,根据规划自定义。建议您按照一定的命名规则填写SSL证书名称,方便您快速识别和查找。
问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。 管理控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。 后续操作 创建完环境和环境变量后,您可以将API发布到环境,以便API调用者调用。
需要接收固定的常量信息,可以通过设置常量参数来实现。API网关代理向后端服务发送请求时,将常量参数添加到请求的指定位置,然后将请求发送给后端服务。 在“常量参数”下,单击“添加常量参数”,添加后端服务请求的常量参数。 表6 常量参数配置 信息项 描述 常量参数名 填写常量参数的名
您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 后续操作 API调试成功后,您可以将API发布到环境,以便API调用者调用。或者出于API的安全性考虑,为API添加策略。 父主题: API列表
单击分组名称,在“API运行”页面,选择待删除的API,单击“删除”。 说明: API先下线,才能删除。 为API添加策略 单击分组名称,在“API运行”页面,选择待添加策略的API,单击“添加策略”。具体参数配置,参考创建策略章节。 将分组内已发布的API上架至门户网站 任选以下三种方式之一操作,即可上架分组内已发布的API至API中心门户网站。
负载通道 负载通道主要用于将服务通过API网关代理开放给外部访问,它的优势在于使用VPC的内部子网通信,网络时延更低,同时负载通道具有负载均衡功能,从而实现后端服务的负载均衡。 创建负载通道后,在创建API,且后端服务类型为HTTP/HTTPS时,后端服务地址可以直接使用已创建的负载通道。
也可以参考绑定API,将API授权给凭据,与本章所描述方法并无差别。 前提条件 API已发布。 已创建环境。 已创建凭据。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 在API所在行,单击“操作”列的“更多 > 授权”。 单击“添加授权”。 选
上限。 描述 关于控制策略的描述。 添加特殊应用 已创建凭据,或已获取其他用户的凭据ID。 在流控策略详情页面,单击“特殊应用”页签,进入特殊应用页面。 单击“添加特殊应用”,弹出“添加特殊应用”对话框。 通过以下两种方式,添加特殊应用。 添加已有应用:单击“已有应用”,选择已有凭据名称,输入阈值。
使用AppCode进行API请求的简易认证 在创建API时,选择“APP认证”并且开启“支持简易认证”。 如果您修改已有API为简易认证,需要在修改完成后,将API重新发布,使简易认证模式生效。 将支持简易认证的API绑定到已创建的凭据。 发送请求时,增加请求头部参数“X-Apig-AppCode”,省略请求签名相关信息。
0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关:支持将API网关代理中已发布的API,上架至API中心门户网站。 Postman Collection:支持将Postman Collection开发的API,上架至API中心门户网站。 Markd
0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关:支持将API网关代理中已发布的API,上架至API中心门户网站。 Postman Collection:支持将Postman Collection开发的API,上架至API中心门户网站。 Markd
Arts),帮助API开发者高效设计/开发/测试API。支持从API Arts将开发好的API文件一键式导入API中心。 支持区域: 华北-北京四 使用API Arts开发API API资产分享 API中心服务商可以通过在管理控制台创建API资产,将开发好的API分享至API中心门户网站,供其他开发者集成和调用。
在API请求中添加Header参数“X-HW-ID”,参数值为获取API的认证信息中获取到的Key。 在API请求中添加Header参数“X-HW-AppKey”,参数值为获取API的认证信息中获取到的Secret。 APP认证(app_basic认证) 在API请求中添加Heade
环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量。例如创建API时定义了变量名为“Path”,在环境1中创建了变量名“Path”,变量值“/Stage/test”,则API在发布到环
0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关:支持将API网关代理中已发布的API,上架至API中心门户网站。 Postman Collection:支持将Postman Collection开发的API,上架至API中心门户网站。 Markd
> API分组”。 单击右上角“创建API分组 > 创建API分组”。 表1 配置分组信息 参数 配置说明 分组名称 API分组名称,用于将API接口进行分组管理。 描述 对分组的介绍。 单击“确定”,创建API分组。系统会同时为其分配一个子域名,您可以用于调试API。 创建成功
务端和客户端的契约,不能单方面破坏契约。通过如下的方式来保证向后的兼容性: 遵循兼容扩展标准。 忽略请求/响应中的未知字段。 只添加可选字段,不能添加必选字段。 不能更改字段的含义。 当资源URL发生变化的时候,支持重定向。 服务端提供新版本API的同时,需要对老版本API提供支持。
时页面只能访问同源的资源。而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类: 简单请求 简单跨域请求的场景需要满足以下两个条件: 请求方法是HEAD,GET,或者POST。 HTTP的头信息不超出以下范围:
环境变量数量 每个分组在任意一个环境中,最多可以创建50个环境变量。 负载通道数量 每个用户最多可以创建10个VPC通道,每个负载通道最多可以添加10个服务器。 参数数量 每个API最多可以创建50个参数。 发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。 每个API的访问频率
API请求尽量少使用自定义消息头 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 标准消息头及其取值格式按照参考标准,并尽量最小化添加自定义消息头。 所有消息头命名格式一致,自定义消息头命名规范:用连词符“-”分隔单词,采用大驼峰方式如X-APIG-TOKEN。 API响应报文使用分页,避免超长列表数据返回