网关收到访问请求时,通过API的策略判断是否匹配并决定之后的处理动作。策略包含路由策略,负载均衡策略,限流策略和鉴权策略等多种策略。

前提条件

如果需要为API添加鉴权策略,则需要先创建凭证。具体操作,请参见新建凭证

背景信息

添加服务的场景不同,必须为API添加的策略也不同:
  • 从注册中心添加服务,必须为API添加路由和负载均衡策略后才能发布生效。
  • 从EDAS关联服务,必须为API添加路由策略后才能发布生效。

操作步骤

  1. 登录微服务网关控制台
  2. 在顶部菜单栏选择地域。
  3. 在左侧导航栏选择网关管理
  4. 网关管理页面单击网关名称。
  5. 网关详情页面左侧导航栏单击API管理
  6. API管理页面单击API名称。
  7. API详情页面的策略区域确定目标链路,不同链路的策略作用范围不同。
    • 请求处理:网关接收到API请求后,最先执行的处理环节。
    • 响应处理:网关在生成API请求后,最后执行的处理环节。
    • 后端请求处理:网关在发起后端微服务的请求前,最后执行的处理环节。
    • 后端响应处理:网关在接收后端微服务的响应后,最先执行的处理环节。
    说明 一般只需配置请求处理响应处理两个环节,若涉及需特别强调时机差异处理时可配置后端处理。
  8. 在目标链路内添加策略,您可以选择以下任一方式添加策略:
    • 创建新策略
      1. 在目标链路区域单击创建策略
      2. 创建策略对话框选择策略类型,并设置策略信息,然后单击确认创建新策略
        参数 说明
        策略名称 仅限字母、数字和下划线(_),最长255个字符,必须以字母开头。
        策略别名 易于辨识策略的别名信息。
        策略类型 根据需要选择策略,本示例选择路由-ZUUL
        启用状态 策略的启用状态,默认开启。
        策略配置 根据需要配置策略,也可以在模板基础上配置其它参数。
    • 选择已有策略
      1. 在目标链路区域单击选择已有策略
      2. 已有策略对话框选中目标策略,单击确认选择已有策略
      3. 在目标链路内单击策略名称,在编辑策略对话框中开启策略启用开关,然后单击确认开启策略启用开关
        说明 选择已有策略,默认不启用该策略,未启用的策略携带未启用标识标识。如果需要启用,请开启启用状态开关。
  9. 可选:同一个链路中如果存在多条策略,鼠标悬停在策略名称上并移动出现的移动按钮 图标,调整策略的优先级。

结果验证

API创建成功并添加必要策略后,您可以在控制台直接填写调用参数和发起服务调用请求,并能快速得到服务调用的结果。如果发现请求异常,则根据响应信息排查服务端口、网络或代码的问题。

  1. 在API列表中,选择目标API,单击操作列下的测试
  2. 在测试API面板,选择调用IP请求方法并设置测试参数,然后单击执行
    说明 如果您是第一次使用或者一个小时内未曾使用测试功能,在使用测试功能前,需要初始化测试引擎。待测试引擎初始化完成后,您才可以使用测试功能。
    测试API
    参数 描述
    调用IP 网关入口SLB的IP。
    说明 暂不支持HTTPS测试,需选择80端口。
    请求方法 调用API的请求方法,包含POSTPUTGETDELETE

    请根据实际情况选择请求方法。

    测试参数 根据默认模板填写httpHeadersparamspath等测试参数。

    本示例仅设置path为实际访问路径/demo/user/rest

  3. 测试服务面板的结果区域,查看服务调用返回信息。
    • 调用服务成功:显示调用服务的成功响应信息。例如本示例返回的Hello from [8080]!
    • 调用服务失败:显示调用服务的失败响应信息。请根据响应信息,排查服务的端口、网络及代码本身的问题。