您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息
本文档介绍如何在 Apigee Edge 的路由器上配置 I/O 超时。
路由器上的 I/O 超时表示在建立连接并将请求发送到消息处理器后,路由器等待接收来自消息处理器的响应的时间。路由器上的 I/O 超时默认值为 57 秒。
您可以根据自己的需求,在默认值 57 秒的基础上增加或减少路由器的 I/O 超时。它可以通过以下方式进行配置:
- 在虚拟主机中
- 在路由器上
以下属性用于控制路由器的 I/O 超时:
物业名称 | 位置 | 说明 |
---|---|---|
proxy_read_timeout
|
虚拟主机 |
指定在建立连接并将请求发送到消息处理器后,路由器等待接收来自消息处理器的响应的最长时间。 如果消息处理器在此超时期限内没有响应,则路由器超时。 默认情况下,此属性采用为路由器上的 如果为特定虚拟主机使用新的超时值修改此属性,则只有使用该特定虚拟主机的 API 代理会受到影响。 |
conf_load_balancing_load.balancing.driver.proxy.read.timeout
|
路由器 |
指定在建立连接并将请求发送到消息处理器后,路由器等待接收来自消息处理器的响应的最长时间。 如果消息处理器在此超时期限内没有响应,则路由器超时。 此属性用于该路由器上的所有虚拟主机。 此属性的默认值为 57 秒。 您可以按照下方在路由器上配置 I/O 超时中的说明修改此属性,也可以通过在虚拟主机级别设置 您可以使用以下表示法将此属性的时间间隔设置为秒以外的时间: ms: milliseconds s: seconds (default) m: minutes h: hours d: days w: weeks M: months (length of 30 days) y: years (length of 365 days) |
conf_load_balancing_load.balancing.driver.nginx.upstream_next_timeout
|
路由器 |
指定在建立连接并将请求发送到每个消息处理器后,路由器等待接收来自所有消息处理器的响应的总时间。 当您的 Edge 安装有多个消息处理器且在出现错误时启用重试时,此功能适用。其值为以下值之一:
与 |
准备工作
在使用本文档中的步骤之前,请务必了解以下主题:
- 如果您不熟悉虚拟主机属性,请参阅 虚拟主机属性参考文档。
- 如果您不熟悉如何在 Private Cloud 上配置 Edge 的属性,请参阅如何配置 Edge。
- 请务必遵循 配置 I/O 超时的最佳实践建议。
在虚拟主机中配置 I/O 超时
本部分介绍如何在与组织和环境关联的虚拟主机中配置 I/O 超时。您可以通过 proxy_read_timeout
属性在虚拟主机中配置 I/O 超时,该属性表示以秒为单位的 I/O 超时值。
您可以使用以下某种方法配置虚拟主机:
- Edge 界面
- Edge API
Edge 界面
如需使用 Edge 界面配置虚拟主机,请执行以下操作:
- 登录 Edge 界面。
- 依次转到 Admin > Virtual Hosts。
- 选择您要在其中执行更改的特定环境。
- 选择要为其配置新 I/O 超时值的特定虚拟主机。
- 在属性下,更新代理读取超时值(以秒为单位)。
例如,如果您要将超时时间更改为 120 秒,请输入 120,如下图所示:
- 保存更改。
Edge API
如需使用 Edge API 配置虚拟主机,请执行以下操作:
- 使用
Get virtual host API 获取当前的虚拟主机配置,如下所示:
公有云用户
curl -v -X GET https//api.enterprise.apigee.com/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -u <username>
Private Cloud 用户
curl -v -X GET http://<management-host>:<port #>/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -u <username>
其中:
{organization-name} 是组织的名称
{environment-name} 是环境的名称
{virtualhost-name} 是虚拟主机的名称
虚拟主机配置示例
{ "hostAliases": [ "api.myCompany,com" ], "interfaces": [], "listenOptions": [], "name": "secure", "port": "443", "retryOptions": [], "sSLInfo": { "ciphers": [], "clientAuthEnabled": "false", "enabled": "true", "ignoreValidationErrors": false, "keyAlias": "myCompanyKeyAlias", "keyStore": "ref://myCompanyKeystoreref", "protocols": [] }, "useBuiltInFreeTrialCert": false }
- 将
proxy_read_timeout
属性添加到properties
下现有的虚拟主机配置 JSON 载荷中(值以秒为单位)。例如,如需将 I/O 超时更改为 120 秒,请添加
properties
代码块,如下所示:更新后的虚拟主机配置示例
{ "hostAliases": [ "api.myCompany,com", ], "interfaces": [], "listenOptions": [], "name": "secure", "port": "443", "retryOptions": [], "properties": { "property": [ { "name": "proxy_read_timeout", "value": "120" } ] }, "sSLInfo": { "ciphers": [], "clientAuthEnabled": "false", "enabled": "true", "ignoreValidationErrors": false, "keyAlias": "myCompanyKeyAlias", "keyStore": "ref://myCompanyKeystoreref", "protocols": [] }, "useBuiltInFreeTrialCert": false }
- 将更新后的虚拟主机配置保存在一个文件中。例如
virtualhost-payload.json
。 - 使用
Update a virtual host API 更新
virtualhost
配置,如下所示:公有云用户
curl -v -X POST Content-Type: application/json https://api.enterprise.apigee.com/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -d @virtualhost-payload.json -u <username>
Private Cloud 用户
curl -v -X POST Content-Type: application/json http://<management-host>:<port #>/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -d @virtualhost-payload.json -u <username>
其中:
{organization-name} 是组织的名称
{environment-name} 是环境的名称
{virtualhost-name} 是虚拟主机的名称
验证虚拟主机上的 I/O 超时
本部分介绍如何使用 Edge API 验证虚拟主机上的 I/O 超时已成功修改。
- 执行
Get virtual host API 以获取
virtualhost
配置,如下所示:公有云用户
curl -v -X GET https://api.enterprise.apigee.com/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -u <username>
Private Cloud 用户
curl -v -X GET http://<management server-host>:<port #>/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -u <username>
其中:
{organization-name} 是组织的名称
{environment-name} 是环境的名称
{virtualhost-name} 是虚拟主机的名称
- 验证属性
proxy_read_timeout
是否已设置为新值。更新后的虚拟主机配置示例
{ "hostAliases": [ "api.myCompany,com", ], "interfaces": [], "listenOptions": [], "name": "secure", "port": "443", "retryOptions": [], "properties": { "property": [ { "name": "proxy_read_timeout", "value": "120" } ] }, "sSLInfo": { "ciphers": [], "clientAuthEnabled": "false", "enabled": "true", "ignoreValidationErrors": false, "keyAlias": "myCompanyKeyAlias", "keyStore": "ref://myCompanyKeystoreref", "protocols": [] }, "useBuiltInFreeTrialCert": false }
请注意,在上面的示例中,
proxy_read_timeout
已使用新值 120 秒进行设置。 - 如果您仍然看到
proxy_read_timeout,
的旧值,请确认您已正确执行了在虚拟主机中配置 I/O 超时中所述的所有步骤。如果您遗漏了任何步骤,请重新正确重复所有步骤。 - 如果您仍然无法修改 I/O 超时,请与 Apigee Edge 支持团队联系。
配置路由器上的 I/O 超时
本部分介绍如何在路由器上配置 I/O 超时。I/O 超时可通过路由器属性 conf_load_balancing_load.balancing.driver.proxy.read.timeout
进行配置,该属性表示 I/O 超时值(以秒为单位)。
如需在路由器上配置 I/O 超时,请执行以下操作:
- 在路由器机器上,在编辑器中打开以下文件。如果不存在,则创建一个。
/opt/apigee/customer/application/router.properties
例如,要使用
vi
打开文件,请输入以下命令:vi /opt/apigee/customer/application/router.properties
- 向
properties
文件中添加一行以下格式的内容,并将time_in_seconds
替换成一个值: - 保存您的更改。
- 确保此属性文件归
apigee
用户所有,如下所示:chown apigee:apigee /opt/apigee/customer/application/router.properties
- 重启路由器,如下所示:
/opt/apigee/apigee-service/bin/apigee-service edge-router restart
- 如果您有多个路由器,请在所有路由器上重复上述步骤。
conf_load_balancing_load.balancing.driver.proxy.read.timeout=time_in_seconds
例如,要将路由器上的 I/O 超时更改为 120 秒,请添加以下行:
conf_load_balancing_load.balancing.driver.proxy.read.timeout=120
您还可以修改 I/O 超时(以分钟为单位)。例如,如需将超时时间更改为两分钟,请添加以下行:
conf_load_balancing_load.balancing.driver.proxy.read.timeout=2m
验证路由器上的 I/O 超时
本部分介绍如何验证路由器上的 I/O 超时是否已成功修改。
即使您使用令牌 conf_load_balancing_load.balancing.driver.proxy.read.timeout
在路由器上设置 I/O 超时,您也需要验证实际属性 proxy_read_timeout
是否已使用新值设置。
- 在
/opt/nginx/conf.d
目录中搜索属性proxy_read_timeout
,并检查它是否已使用新值进行设置,如下所示:grep -ri "proxy_read_timeout" /opt/nginx/conf.d
- 如果在路由器上成功设置了新的 I/O 超时值,则上述命令会在所有虚拟主机配置文件中显示新值。
以下是上述
grep
命令在 I/O 超时为 120 秒时的示例结果:/opt/nginx/conf.d/0-default.conf:proxy_read_timeout 120; /opt/nginx/conf.d/0-edge-health.conf:proxy_read_timeout 1s;
请注意,在上面的示例输出中,属性
proxy_read_timeout
已在0-default.conf
(默认虚拟主机的配置文件)中使用新值 120 进行设置。这表示路由器上的 I/O 超时已成功配置为 120 秒。 - 如果您仍然看到属性
proxy_read_timeout
的旧值,请验证是否已正确执行在路由器上配置 I/O 超时中所述的所有步骤。如果您遗漏了任何步骤,请再次正确重复所有步骤。 - 如果您仍然无法修改 I/O 超时,请与 Apigee Edge 支持团队联系。
下一步该做什么?
了解如何在消息处理器中配置 I/O 超时