度量值路由 CLI
IBM Cloud® 命令行界面 (CLI) 为服务产品提供额外功能。 此信息描述如何使用 CLI 来定义和管理 IBM Cloud® Metrics Routing 实例的设置。
安装 CLI
-
安装 IBM Cloud CLI。
-
运行以下命令安装 CLI:
ibmcloud plugin install metrics-router
当 IBM Cloud CLI 和插件的更新可用时,将在命令行上通知您。 确保 CLI 保持最新,以便您可以使用最新的命令。 您可以通过运行 ibmcloud plugin list
来查看所有已安装插件的当前版本。
准备工作
在配置 IBM Cloud Metrics Routing 路由或目标之前,必须配置主元数据区域。 主元数据区域是使用 ibmcloud metrics-router setting update
命令 --primary-metadata-region
选项配置的。
如果未配置主元数据区域,那么路由和目标命令将失败。
ibmcloud metrics-router 路由创建
使用此命令可创建到 IBM Cloud Metrics Routing 目标的新路径。
目标必须是 IBM Cloud Monitoring 实例。
ibmcloud metrics-router route create --name ROUTE_NAME ( --rules RULES | --file RULES_DEFINITION_JSON_FILE ) [--output FORMAT] [--force]
命令选项
--name ROUTE_NAME
- 要对路由指定的名称。
请勿在任何资源名称中包含任何个人标识信息 (PII)。
--file RULES_DEFINITION_JSON_FILE
- 包含路由规则定义的 JSON 文件。 该文件需要按如下所示进行格式化:
[
{
"targets": [{"id":"ID1"},{"id":"ID2"}]
}
]
其中 targets
是以逗号分隔的目标标识列表。
规则定义还可以选择包含包含过滤器。 例如
[{
"action": "send",
"targets": [{
"id":"11111111-1111-1111-1111-111111111111"
}],
"inclusion_filters": [
{
"operand": "service_name",
"operator": "in",
"values": [
"appconnect",
"cloudant",
"containers-kubernetes"
]
},
{
"operand": "location",
"operator": "in",
"values": [
"us-south",
"eu-de"
]
}
]
}]
Where:
action
-
操作定义 IBM Cloud® Metrics Routing 是包含还是排除路由上的度量。 支持两个操作:
send
和drop
。 如果未指定,那么缺省操作是发送度量值。send
- 根据路由规则,在定义的路由上发送指标。
drop
- 在已定义路由上发送指标时,会根据路由规则排除指标。
operand
-
操作数是运行
operator
测试的属性的名称。 支持以下操作数:location
,service_name
,service_instance
,resource_type
和resource
。 operator
-
支持两个运算符:
in
和is
。in
-
将操作数属性的值与一个值列表进行比较。
您最多可以定义 20 个值。
is
-
将操作数属性的值与单个值进行比较。
使用
is
时,只能指定 1 个值。
values
-
要与
operand
属性进行比较的字符串或字符串数组,以确定度量是否已路由。 使用is
operator
时,values
必须包含单个字符串。 使用in
operator
时,values
可以在数组中包含多个字符串。有效值取决于
operand
。location
- 任何 有 IBM Cloud Metrics Routing 的地方。
service_name
- IBM Cloud 服务的 CRN 服务名称,该服务生成的度量值通过 IBM Cloud Metrics Routing
service_instance
、resource_type
和resource
- 适合 [IBM Cloud 服务的值,该服务生成的度量值通过IBM Cloud Metrics Routing
--rules RULES
-
以单引号括起的 JSON 格式化规则定义。 例如
--rules '[{"action": "send", "targets":[{"id": "11111111-1111-1111-1111-111111111111"}], "inclusion_filters":[{"operand": "location","operator": "is","values": ["us-south"]}]}]
其中
targets
是以逗号分隔的目标标识列表。规则定义还可以选择包含包含过滤器。 例如
[{ "action": "send", "targets": [{ "id":"11111111-1111-1111-1111-111111111111" }], "inclusion_filters": [ { "operand": "service_name", "operator": "in", "values": [ "appconnect", "cloudant", "containers-kubernetes" ] }, { "operand": "location", "operator": "in", "values": [ "us-south", "eu-de" ] } ] }]
其中:
action
-
操作定义 IBM Cloud® Metrics Routing 是包含还是排除路由上的度量。 支持两个操作:
send
和drop
。 如果未指定,那么缺省操作是发送度量值。send
- 根据路由规则,在定义的路由上发送指标。
drop
- 在已定义路由上发送指标时,会根据路由规则排除指标。
operand
-
操作数是运行
operator
测试的属性的名称。 支持以下操作数:location
,service_name
,service_instance
,resource_type
和resource
。 operator
-
支持两个运算符:
in
和is
。in
-
将操作数属性的值与一个值列表进行比较。
您最多可以定义 20 个值。
is
-
将操作数属性的值与单个值进行比较。
使用
is
时,只能指定 1 个值。
values
-
要与
operand
属性进行比较的字符串或字符串数组,以确定度量是否已路由。 使用is
operator
时,values
必须包含单个字符串。 使用in
operator
时,values
可以在数组中包含多个字符串。有效值取决于
operand
。location
- 任何 有 IBM Cloud Metrics Routing 的地方。
service_name
- IBM Cloud 服务的 CRN 服务名称,该服务生成的度量值通过 IBM Cloud Metrics Routing
service_instance
、resource_type
和resource
- 适合 [IBM Cloud 服务的值,该服务生成的度量值通过IBM Cloud Metrics Routing
--output FORMAT
-
如果指定了
JSON
,那么将以 JSON 格式返回输出。 如果未指定JSON
,那么将以表格格式返回输出。 --force
-
运行该命令而不提示确认。 仅当生成的路由废弃平台指标时,此标志才适用。
help
|--help
|-h
-
列出可用于该命令的选项。
ibmcloud metrics-路由器路由更新
使用此命令可更新到 IBM Cloud Metrics Routing 目标的路径。 与最初创建路由时不同的任何指定值都将更新为命令中指定的值。
目标必须是 IBM Cloud Monitoring 实例。
ibmcloud metrics-router route update --route ROUTE [--name ROUTE_NAME] ( --rules RULES | --file RULES_DEFINITION_JSON_FILE ) [--output FORMAT] [--force]
命令选项
--route ROUTE
-
路由的现有名称或 ID。
--name ROUTE_NAME
-
要提供给路由的更新名称 (可选)。
请勿在任何资源名称中包含任何个人标识信息 (PII)。
--file RULES_DEFINITION_JSON_FILE
-
包含路由规则定义的 JSON 文件。 该文件需要按如下所示进行格式化:
[ { "targets": [{"id":"ID1"},{"id":"ID2"}] } ]
其中
targets
是以逗号分隔的目标标识列表。规则定义还可以选择包含包含过滤器。 例如
[{ "action": "send", "targets": [{ "id":"11111111-1111-1111-1111-111111111111" }], "inclusion_filters": [ { "operand": "service_name", "operator": "in", "values": [ "appconnect", "cloudant", "containers-kubernetes" ] }, { "operand": "location", "operator": "in", "values": [ "us-south", "eu-de" ] } ] }]
其中:
action
-
操作定义 IBM Cloud® Metrics Routing 是包含还是排除路由上的度量。 支持两个操作:
send
和drop
。 如果未指定,那么缺省操作是发送度量值。send
- 根据路由规则,在定义的路由上发送指标。
drop
- 在已定义路由上发送指标时,会根据路由规则排除指标。
operand
-
操作数是运行
operator
测试的属性的名称。 支持以下操作数:location
,service_name
,service_instance
,resource_type
和resource
。 operator
-
支持两个运算符:
in
和is
。in
-
将操作数属性的值与一个值列表进行比较。
您最多可以定义 20 个值。
is
-
将操作数属性的值与单个值进行比较。
使用
is
时,只能指定 1 个值。
values
-
要与
operand
属性进行比较的字符串或字符串数组,以确定度量是否已路由。 使用is
operator
时,values
必须包含单个字符串。 使用in
operator
时,values
可以在数组中包含多个字符串。有效值取决于
operand
。location
- 任何 有 IBM Cloud Metrics Routing 的地方。
service_name
- IBM Cloud 服务的 CRN 服务名称,该服务生成的度量值通过 IBM Cloud Metrics Routing
service_instance
、resource_type
和resource
- 适合 [IBM Cloud 服务的值,该服务生成的度量值通过IBM Cloud Metrics Routing
--rules RULES
-
以单引号括起的 JSON 格式化规则定义。 例如
--rules '[{"action": "send", "targets":[{"id": "11111111-1111-1111-1111-111111111111"}], "inclusion_filters":[{"operand": "location","operator": "is","values":["us-south"]}]}]
其中
target_ids
是以逗号分隔的目标标识列表。规则定义还可以选择包含包含过滤器。 例如
[{ "action": "send", "targets": [{ "id":"11111111-1111-1111-1111-111111111111" }], "inclusion_filters": [ { "operand": "service_name", "operator": "in", "values": [ "appconnect", "cloudant", "containers-kubernetes" ] }, { "operand": "location", "operator": "in", "values": [ "us-south", "eu-de" ] } ] }]
其中:
action
-
操作定义 IBM Cloud® Metrics Routing 是包含还是排除路由上的度量。 支持两个操作:
send
和drop
。 如果未指定,那么缺省操作是发送度量值。send
- 根据路由规则,在定义的路由上发送指标。
drop
- 在已定义路由上发送指标时,会根据路由规则排除指标。
operand
-
操作数是运行
operator
测试的属性的名称。 支持以下操作数:location
,service_name
,service_instance
,resource_type
和resource
。 operator
-
支持两个运算符:
in
和is
。in
-
将操作数属性的值与一个值列表进行比较。
您最多可以定义 20 个值。
is
-
将操作数属性的值与单个值进行比较。
使用
is
时,只能指定 1 个值。
values
-
要与
operand
属性进行比较的字符串或字符串数组,以确定度量是否已路由。 使用is
operator
时,values
必须包含单个字符串。 使用in
operator
时,values
可以在数组中包含多个字符串。有效值取决于
operand
。location
- 任何 有 IBM Cloud Metrics Routing 的地方。
service_name
- IBM Cloud 服务的 CRN 服务名称,该服务生成的度量值通过 IBM Cloud Metrics Routing
service_instance
、resource_type
和resource
- 适合 [IBM Cloud 服务的值,该服务生成的度量值通过IBM Cloud Metrics Routing
--output FORMAT
-
如果指定了
JSON
,那么将以 JSON 格式返回输出。 如果未指定JSON
,那么将以表格格式返回输出。 --force
-
运行该命令而不提示确认。 仅当生成的路由废弃平台指标时,此标志才适用。
help
|--help
|-h
-
列出可用于该命令的选项。
ibmcloud metrics-路由器路由 rm
使用此命令删除 IBM Cloud Metrics Routing 路由。
ibmcloud metrics-router route rm --route ROUTE [--force]
命令选项
--route ROUTE
- 要删除的路由的名称或标识。
--force
- 删除路由而不向用户提供任何其他提示。
help
|--help
|-h
- 列出可用于该命令的选项。
ibmcloud metrics-路由器路由获取
使用此命令可获取有关 IBM Cloud Metrics Routing 路径的信息。
ibmcloud metrics-router route get --route ROUTE [--output FORMAT]
命令选项
--route <ROUTE_ID>
- 路由的名称或标识。
--output FORMAT
- 如果指定了
JSON
,那么将以 JSON 格式返回输出。 如果未指定JSON
,那么将以表格格式返回输出。 help
|--help
|-h
- 列出可用于该命令的选项。
ibmcloud metrics-router 路由 ls
使用此命令可列出帐户中 IBM Cloud Metrics Routing 的所有已配置路径。
ibmcloud metrics-router route ls [--output FORMAT]
命令选项
--output FORMAT
- 如果指定了
JSON
,那么将以 JSON 格式返回输出。 如果未指定JSON
,那么将以表格格式返回输出。 help
|--help
|-h
- 列出可用于该命令的选项。
ibmcloud metrics-router 目标创建
使用此命令可创建用于为平台度量值配置目标的目标。
目标必须是 IBM Cloud Monitoring 实例。
ibmcloud metrics-router target create --name TARGET_NAME --destination-crn DESTINATION_TARGET_CRN [--region REGION] [--output FORMAT]
命令选项
--region REGION
|-r REGION
-
地区名称,例如
us-south
或eu-gb
。 如果未指定,那么将使用已登录或目标区域。 --name TARGET_NAME
-
要对目标指定的名称。
请勿在任何资源名称中包含任何个人标识信息 (PII)。
--destination-crn DESTINATION_TARGET_CRN
-
用于接收 IBM Cloud Metrics Routing发送的度量值的服务实例或资源的 CRN。 确保您具有 IBM Cloud Metrics Routing 与 IBM Cloud 资源之间的服务授权。 有关更多信息,请参阅 管理授权以授予服务之间的访问权。
--output FORMAT
-
支持格式为 JSON。 如果指定,那么将以 JSON 格式返回输出。 如果未指定
JSON
,那么将以表格格式返回输出。 help
|--help
|-h
-
列出可用于该命令的选项。
ibmcloud metrics-路由器目标更新
使用此命令可更新要用于为平台度量值配置目标的目标。
目标必须是 IBM Cloud Monitoring 实例。
ibmcloud metrics-router target update --target TARGET [--name TARGET_NAME] [--destination-crn DESTINATION_TARGET_CRN] [--output FORMAT]
命令选项
--region REGION
|-r REGION
-
地区名称,例如
us-south
或eu-gb
。 如果未指定,那么将使用已登录或目标区域。 --target TARGET
-
要更新的目标的名称或 ID。
--name TARGET_NAME
-
要对目标指定的新名称。
请勿在任何资源名称中包含任何个人标识信息 (PII)。
--destination-crn DESTINATION_TARGET_CRN
-
用于接收 IBM Cloud Metrics Routing发送的度量值的服务实例或资源的 CRN。 确保您具有 IBM Cloud Metrics Routing 与 IBM Cloud 资源之间的服务授权。 有关更多信息,请参阅 管理授权以授予服务之间的访问权。
--output FORMAT
-
支持格式为 JSON。 如果指定,那么将以 JSON 格式返回输出。 如果未指定
JSON
,那么将以表格格式返回输出。 help
|--help
|-h
-
列出可用于该命令的选项。
ibmcloud metrics-路由器目标 rm
使用此命令删除目标。
ibmcloud metrics-router target rm --target TARGET [--force]
命令选项
--target TARGET
- 目标的 ID 或名称。
--force
|-f
- 删除目标而不向用户提供任何其他提示。
help
|--help
|-h
- 列出可用于该命令的选项。
ibmcloud metrics-路由器目标获取
使用此命令可获取有关 IBM Cloud Metrics Routing 目标的信息。
ibmcloud metrics-router target get --target TARGET [--output FORMAT]
命令选项
--target TARGET
- 目标的 ID 或名称。
--output FORMAT
- 支持的格式为 JSON。 如果指定,那么将以 JSON 格式返回输出。 如果未指定
JSON
,那么将以表格格式返回输出。 help
|--help
|-h
- 列出可用于该命令的选项。
ibmcloud metrics-router 目标 ls
使用此命令可列出 IBM Cloud Metrics Routing的已配置目标。
ibmcloud metrics-router target ls [--output FORMAT]
命令选项
--output FORMAT
- 支持的格式为 JSON。 如果指定,那么将以 JSON 格式返回输出。 如果未指定
JSON
,那么将以表格格式返回输出。 help
|--help
|-h
- 列出可用于该命令的选项。
ibmcloud metrics-路由器设置获取
使用此命令可获取 IBM Cloud Metrics Routing 帐户配置的设置。
ibmcloud metrics-router setting get [--output FORMAT]
命令选项
--output FORMAT
- 如果指定了
JSON
,那么将以 JSON 格式返回输出。 如果未指定JSON
,那么将以表格格式返回输出。 help
|--help
|-h
- 列出可用于该命令的选项。
ibmcloud metrics-路由器设置更新
使用此命令可修改当前设置,例如 IBM Cloud Metrics Routing中的缺省目标,允许的目标区域,主元数据区域和辅助元数据区域。 与最初创建目标时不同的任何值都将更新为命令中指定的值。 如果未指定任何选项,那么将返回当前设置。
在通过设置 --private-api-endpoint-only TRUE
来禁用公共端点之前,请确保您的帐户具有对专用端点的访问权。 您可以通过运行命令 ibmcloud account show
来执行此操作。 如果 VRF Enabled
为 true
且 Service Endpoint Enabled
为 true
,那么您有权访问专用端点。
如果您无权访问专用端点,那么无法启用公共端点。 需要专用端点访问才能启用公共端点。
ibmcloud metrics-router setting update [--primary-metadata-region REGION] [--backup-metadata-region REGION] [--private-api-endpoint-only ( TRUE | FALSE )] [--default-targets TARGET] [--permitted-target-regions REGIONS] [--output FORMAT] [--force]
命令选项
backup-metadata-region
-
backup-metadata-region
是存储 IBM Cloud Metrics Routing 配置的元数据备份的位置。 default-targets
-
default-targets
是目标标识的列表。 如果没有路由规则导致将度量值发送到其他目标,那么这些目标将接收度量值。 TARGET 是以逗号分隔的目标标识列表。 permitted-target-regions
-
permitted-target-regions
是可用于定义目标的区域的列表。 REGION 是以逗号分隔的区域列表。 如果未指定,那么可以使用任意数量的区域来定义目标。例如,要将可用于定义目标的区域限制为
us-south
和eu-de
,请指定:--permitted-target-regions us-south,eu-de
。要删除所有已配置的区域,请指定
--permitted-target-regions ""
。 primary-metadata-region
-
primary-metadata-region
是存储 IBM Cloud Metrics Routing 配置元数据的位置。 private-api-endpoint-only
-
指定是否可以使用专用端点。 如果
TRUE
,那么只能使用专用端点。 --output FORMAT
-
如果指定了
JSON
,那么将以 JSON 格式返回输出。 如果未指定JSON
,那么将以表格格式返回输出。 help
|--help
|-h
-
列出可用于该命令的选项。