在 GraphOS 路由器中执行操作限制

设置深度、高度、别名和根字段的约束

此功能仅在 GraphOS Enterprise计划.
中可用。您可以通过注册免费企业试用版.

您可以在操作限制中定义您的router's 配置，以拒绝可能恶意的请求。如果一个操作超过了任何指定限制，则会被拒绝（除非您以warn_only模式运行您的 router）。（warn_only模式运行）。

设置

要使用操作限制，您必须运行GraphOS Router 的 v1.17 或更高版本。下载最新版本。

您需要在router 的YAML 配置文件中定义操作限制，例如：

router.yaml

1
limits:
2
  max_depth: 100
3
  max_height: 200
4
  max_aliases: 30
5
  max_root_fields: 20
6

7
  # Uncomment to enable warn_only mode
8
  # warn_only: true

每个限制值都是一个整数。您可以定义任何组合的支持的限制。

支持的限制

`max_depth`

限制操作中的选择集最深嵌套层级，包括fields（字段）在fragments（片段）中。

下面是具有深度三的GetBook 操作：

1
query GetBook {
2
  book { # Depth 1 (root field)
3
    ...bookDetails
4
  }
5
}
6

7
fragment bookDetails on Book {
8
  details { # Depth 2 (nested under `book`)
9
    ... on ProductDetailsBook {
10
      country # Depth 3 (nested under `details`)
11
    }
12
  }
13
}

`最大高度`

限制在一个操作中包含的唯一字段数量，包括片段的字段。如果一个特定的字段通过别名被多次包含，则只计算一次。

下面的 GetUser 操作的高度为三：

1
query GetUser {
2
  user { # 1
3
    id   # 2
4
    name # 3
5
    username: name # Aliased duplicate (not counted)
6
  }
7
}

每个唯一的字段都会将操作的高度增加一个，无论该字段的返回类型（标量、对象或列表）。

`最大别名`

限制一个操作中包含的总别名字段数，包括片段的字段。

下面的 GetUser 操作包含了三个别名：

1
query GetUser {
2
  user {
3
    nickname: name # 1
4
    username: name # 2
5
    handle: name   # 3
6
  }
7
}

每个别名字段都会将别名计数增加一个，无论该字段的返回类型（标量、对象或列表）。

`最大根字段`

限制一个操作中根字段的数量，包括片段中的根字段。如果一个特定的根字段通过别名被多次包含，每个使用都计为一次。

以下操作包括三个根字段：

1
query GetTopProducts {
2
  topBooks { # 1
3
    id
4
  }
5
  topMovies { # 2
6
    id
7
  }
8
  topGames { # 3
9
    id
10
  }
11
}

`warn_only` 模式

如果你以 warn_only 模式运行路由器，则超过定义的限值的不被拒绝。相反，路由器会像平常一样处理这些操作，并发出一条 WARN 跟踪，记录所有超过的限值，如下所示：

1
2023-03-15T19:08:23.123456Z WARN apollo_router::operation_limits: max_depth exceeded, max_depth: 3, current_op_depth: 5, operation: "query GetOwnerLocation {cat {owner {location {postalCode}}}}"

在测试期间以 warn_only 模式运行可能有助于确定为你 supergraph 设置的最合适的限值。

您可以为您的路由器启用或禁用 warn_only 模式，这在您的路由器's YAML 配置文件中，如下所示：

router.yaml

1
limits:
2
  warn_only: true # warn_only mode always enabled

超出限制的响应格式

每当您的路由器因为超过操作限制而拒绝请求时，路由器会以 400 HTTP 状态码和一个标准的 GraphQL 错误响应体进行响应：

1
# HTTP 400
2
{
3
  "data": {},
4
  "errors": [
5
    {
6
      "message": "Maximum height (field count) limit exceeded in this operation",
7
      "extensions": {
8
        "code": "MAX_HEIGHT_LIMIT"
9
      }
10
    }
11
  ]
12
}

如果您在 warn_only 模式下运行您的路由器，则

子图身份验证

使用持久查询进行白名单