IBM Cloud Docs
关于路线

关于路线

您可以使用IBM Cloud Metrics Routing UI、IBM Cloud Metrics Routing CLI、IBM Cloud Metrics Routing REST API 和IBM Cloud Metrics Routing Terraform 提供程序来管理您帐户中的路线。 路由定义了一些规则,这些规则指示了在某个区域中路由哪些指标以及将它们路由到何处。

了解帐户中的路线运作方式

请注意以下有关路线的信息:

  • 路线在一个帐户下是全局的,并在部署了IBM Cloud® Metrics Routing的所有区域进行评估。

  • 您可以从任何受支持且有IBM Cloud Metrics Routing的位置定义路线。 有关详细信息,请参阅 位置

  • 可以从任何区域IBM Cloud Metrics Routing API 端点访问路线。

  • 最多可以为每个帐户定义 30 个路径。

  • 默认情况下,该账户配置了0条路由。

  • 最多可以为每个路径配置 10 个规则。

  • 最多可以为每个规则配置 8 个位置。

  • 您可以为每个规则配置最多 3 个目标 ( {"targets":[{"id":ID1},{"id":ID2},{"id":ID3}] )。

  • 路线是独立处理的。 如果您有多个路由的规则与相同的指标数据匹配,则该数据将被发送到多个目标。

  • 1个路由定义中的规则按顺序处理。 与指标数据匹配的第一个匹配规则(例如 location )用于处理该数据。 当指标被处理时,它们将不会被该路由定义中的后续规则处理。 如果您想要为所有未被其他规则处理的指标指定一条默认规则,则可以在 rules 定义中将规则( "locations" : ["*"] )指定为 route 的最终规则。

  • 如果指标数据与任何规则都不匹配且未配置默认目标,则指标将被删除并且不会路由到任何目标。

  • 对路由定义中的一个或多个规则的任何更新都会丢弃现有规则集并将其替换为指定的配置。 更新路线时,必须定义规则集中所有不变的现有规则,并将更改添加到必须更新的规则中。

  • 有关路线的信息作为元数据存储在您为IBM Cloud帐户设置的主要位置。

    如果您未配置主要元数据位置,则该位置将设置为您在账户中定义第一个目标的位置。 有关更多信息,请参阅 配置帐户设置

  • 您可以使用私有和公共端点来管理路由。 有关可用 ENDPOINTS 列表的更多信息,请参阅 端点

    • 您可以使用以下格式的 API 端点管理来自私有网络的路由:https://private.REGION.metrics-router.cloud.ibm.com

    • 您可以使用以下格式的 API 端点管理来自公共网络的路由:https://REGION.metrics-router.cloud.ibm.com

    • 您可以通过更新帐户设置来禁用公共端点。 有关更多信息,请参阅 强制实施私有端点

  • 路由名称必须少于或等于 1000 个字符,且不能包含除空格、破折号 -、点 .、下划线 _ 和冒号 : 以外的任何特殊字符。

    该名称不得包含任何个人身份信息 (PII)。

配置路线后,可能需要最多 1 小时才能启用该配置。

IAM 访问权

确保您拥有 正确的 IAM 权限来配置IBM Cloud Metrics Routing。

IAM 权限

下表列出了 IAM 操作、其范围以及管理路由所需的角色。

用于管理路线的 IAM 操作范围和角色
任务 IAM 操作 IAM 策略范围 IAM 角色
创建路径 metrics-router.route.create 帐户 Administrator
Editor
列出所有路径 metrics-router.route.list 帐户 Administrator
Editor
Operator
Viewer
获取路线详情 metrics-router.route.read 帐户 Administrator
Editor
Operator
Viewer
修改路线 metrics-router.route.update 帐户 Administrator
Editor
删除路径 metrics-router.route.delete 帐户 Administrator
Editor

审计事件

下表列出了 IAM 操作、其范围以及管理路由所需的角色。

活动跟踪审计事件行动
任务 活动跟踪审计事件行动
创建路径 metrics-router.route.create
列出所有路径 metrics-router.route.list
获取路线详情 metrics-router.route.read
修改路线 metrics-router.route.update
删除路径 metrics-router.route.delete

CLI 先决条件

在使用 CLI 管理路由之前,请完成以下步骤:

  1. 安装 IBM Cloud CLI

  2. 安装 IBM Cloud Metrics Routing CLI

使用 UI 管理路线

您可以使用IBM Cloud Metrics Routing UI 管理您的路线定义。 有关更多信息,请参阅 管理路线

CLI 命令

下表列出了管理路由时可以执行的操作:

路线操作
操作 命令
创建路径 ibmcloud metrics-router route create
更新路径 ibmcloud metrics-router route update
删除路径 ibmcloud metrics-router route rm
讀取路線 ibmcloud metrics-router route get
列出所有路径 ibmcloud metrics-router route ls

有关更多信息,请参阅 IBM Cloud Metrics Routing v3 CLI

API 先决条件

在使用 API 管理路线之前,请完成以下步骤:

  1. 获取 IAM 访问令牌。 有关更多信息,请参阅 检索 IAM 访问令牌
  2. 确定您计划配置或管理路由的区域中的 API 端点。 有关更多信息,请参阅 端点

API 方法

下表列出了管理路由时可以执行的操作:

使用IBM Cloud Metrics Routing REST API 路由操作
操作 REST API 方法 API_URL
Create a route POST <ENDPOINT>/api/v3/routes
Update a route PATCH <ENDPOINT>/api/v3/routes/<ROUTE_ID>
Delete a route DELETE <ENDPOINT>/api/v3/routes/<ROUTE_ID>
Get information about a route GET <ENDPOINT>/api/v3/routes/<ROUTE_ID>
List all routes GET <ENDPOINT>/api/v3/routes

有关 REST API 的更多信息,请参阅 路由

HTTP 响应代码

在使用 IBM Cloud Metrics Routing REST API 时,您可以获取标准的 HTTP 响应代码,以指示方法是否成功完成。

  • 200 响应始终表示成功。
  • 4xx响应表示失败。
  • 5xx响应通常表示内部系统错误。

有关 HTTP 的一些响应代码,请参见下表:

HTTP 响应代码列表
状态码 状态 描述
200 OK 请求已成功。
201 OK 请求已成功。 资源已创建。
204 OK 路线已成功删除。
400 错误请求 请求未成功。 您可能缺少必需的参数。
401 未授权 API 请求中使用的 IAM 令牌无效或已过期。
403 禁止 由于权限不足,禁止操作。
404 找不到 请求的资源不存在或已被删除。
429 请求次数太多 太多请求过快到达 API。
500 内部服务器错误 IBM Cloud Metrics Routing处理过程中出现错误。