检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API网关具备SSL传输、严格的访问控制、IP黑白名单控制、认证鉴权、防重放防攻击、多种审计等安全措施,全方位保护API安全调用,且能实施灵活而精细的配额管理及流控管理以保护您的后端服务。帮助您灵活、安全的开放您的服务。 灵活的策略路由 支持配置不同的后端,按照多种策略进行匹配转发
这个API时,就会使用绑定的签名密钥对请求参数进行数据加密,生成签名。当租户的后端服务收到请求时,可以校验这个签名,如果签名校验不通过,则该请求不是API网关发出的请求,租户可以拒绝这个请求,从而保证API的安全性,避免API被未知来源的请求攻击。 URI HTTP/HTTPS请求方法以及URI如下表所示
想继续使用,需要在指定的时间内为实例续费,否则实例资源会自动释放,数据丢失且不可恢复。 续费操作仅适用于包年/包月实例,按需计费实例不需要续费,只需要保证账户余额充足即可。 包年/包月实例在到期前续费成功,所有资源得以保留,且实例的运行不受影响。实例到期后的状态说明,请参见到期后影响。
查看APP Code详情 功能介绍 App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/app
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
String 筛选的特殊租户的账号ID 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 throttle_specials 字典数据类型 本次查询返回的特殊配置列表 total Integer 符合条件的特殊设置总数 size Integer 本次查询返回的列表长度 表4
符合条件的API的总数 size Integer 本次返回的列表长度 apis 字典数据类型 本次返回的API列表 表4 apis参数说明 参数 类型 说明 id String API编号 name String API名称 group_id String API所属分组的编号 group_name
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
创建APP 功能介绍 APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps
创建APP Code 功能介绍 App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes
户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 name String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。
String 筛选的特殊应用名称 user 否 String 筛选的特殊租户的账号ID 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 throttle_specials 字典数据类型 本次查询返回的特殊配置列表 total Integer 符合条件的特殊设置总数 size
每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API的总数 size Integer 本次返回的列表长度 apis 字典数据类型 本次返回的API列表
API的流量控制策略不生效怎么处理? 如果流控策略的API流量限制或源IP流量限制不生效,检查API是否绑定流控策略。 如果流控策略的用户流量限制不生效,检查API的安全认证方式是否为APP认证或IAM认证。 如果流控策略的应用(凭据)流量限制不生效,检查API的安全认证方式是否为APP认证。
如果需要批量解绑API,则勾选待解绑的API,单击“解除”。最多同时解绑1000个API。 后续操作 如果某个应用希望受流量策略控制,可以通过对该策略增加特殊应用实现,具体参考添加特殊应用或租户。增加特殊应用后,此应用的应用流量受特殊应用的阈值限制,而API流量和用户流量受流量策略限制。
配置API的流量控制 添加特殊凭据或租户 配置API的流量控制2.0 API插件策略 配置API的跨域资源共享 配置API的HTTP响应头 配置API的Kafka日志推送 配置API的断路器 其他常用操作 配置API的发布环境和环境变量 配置API的访问控制 配置API的后端服务签名校验
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次返回的列表长度 auths 字典数据类型 本次返回的API列表
当后端服务没有在设置的后端超时时间内返回时,API网关提示后端服务调用失败。 在编辑API中增加后端超时时间,或缩小后端的处理时间。 如果“后端服务地址”在ECS(Elastic Cloud Server),ECS的安全组的出/入方向规则可能拦截了请求。 检查后端服务所在ECS的安全组,确保出/入方向端口规则和协议都设置正确。