通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
当租户的后端服务收到请求时,可以校验这个签名,如果签名校验不通过,则该请求不是API网关发出的请求,租户可以拒绝这个请求,从而保证API的安全性,避免API被未知来源的请求攻击。 调用方法 请参见如何调用API。
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。
当租户的后端服务收到请求时,可以校验这个签名,如果签名校验不通过,则该请求不是API网关发出的请求,租户可以拒绝这个请求,从而保证API的安全性,避免API被未知来源的请求攻击。
如果API的后端服务信息中定义了环境变量,则需要在环境中添加对应的变量。通过环境变量,可实现同一个API,在不同环境中调用不同的后端服务。 例如创建API时,后端服务请求Path中定义了变量“Path”。
相关文档 在“分组信息”页面的“域名管理”区域,将已绑定独立域名的端口修改为新增的入端口或在绑定独立域名时选择新增的入端口,用户才可以通过不同的端口访问不同的后端服务。 父主题: 管理APIG实例
如果您通过负载通道访问后端服务,那么独立域名绑定的端口需与负载通道中后端服务器的访问端口保持一致。
表5 Mock类型定义后端服务 参数 配置说明 后端服务类型 选择后端服务类型,此处选择“Mock”,实际请求不会调用到后端服务,通常用于后端服务没有搭建好的API联调环境。如果已有搭建好的后端服务,根据实际需要配置其他后端服务类型,操作详情请参考创建API。
适用计费项 使用量(包含API调用量和公网流量) 如果后端服务与API网关不在同一区域,或后端服务不在华为云,将会额外收取API网关到后端服务的流量费用。 适用场景 适用于API需求较小的场景。 父主题: 计费模式
获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询子网列表”章节。
导入导出API的限制与兼容性说明 在API网关中导入或者导出API时,限制与兼容性如下所示: 约束与限制 API网关参数限制,如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中,header
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
backend-signature:后端服务签名示例。 sdk-request:签名算法的调用示例,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。 调用API示例 在工程中引入sdk。
修改特殊设置 功能介绍 修改某个流控策略下的某个特殊设置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/throttle-specials/{id} URI中的参数说明如下表所示
API定义范围 全量定义:包括API前端请求定义、后端服务定义和响应定义。适用于将API定义备份为Swagger或OpenAPI文件。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制策略、访问控制策略、插件策略的定义和绑定关系的导出。
指定的镜像服务协议须与用户的镜像业务协议保持一致。 镜像地址 镜像服务的地址。由IP/域名和端口号组成,总长度不超过255。格式为主机:端口(如:xxx.xxx.xxx:7443)。如果不写端口号,那么HTTPS默认端口号为443,HTTP默认端口号为80。
API调用场景 API请求参数配置 使用域名调用API 使用服务分配的调试域名或服务绑定的域名调用API,无需另外配置。 使用IP调用API 使用IP地址直接调用API,需要在请求消息中添加Header参数“host”。
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
弹性云服务器不存在 弹性云服务器被删除或者传入的ID错误 404 APIG.3094 Instance task does not exist.
如果您通过负载通道访问后端服务,那么独立域名绑定的端口需与负载通道中后端服务器的访问端口保持一致。