IBM Cloud Docs
管理Monitoring目标

管理Monitoring目标

您可以使用IBM Cloud Metrics Routing UI、IBM Cloud Metrics Routing CLI、IBM Cloud Metrics Routing REST API 和IBM Cloud Metrics Routing Terraform 提供程序来管理您帐户中的Monitoring目标。 目标是可以收集指标的资源。

有关IBM Cloud Metrics Routing目标的更多信息，请参阅 目标。

关于Monitoring目标

您可以配置IBM Cloud Metrics Routing以将支持该服务的不同区域生成的指标路由到Monitoring目标。

  • 您只能路由在IBM Cloud Metrics Routing可用的区域中生成的指标。 有关更多信息，请参阅区域。

  • 如果您有监管和合规要求，请检查Monitoring目标是否在有效位置可用。

  • 要配置IBM Cloud Metrics Routing以将指标路由到Monitoring实例，您必须配置服务到服务授权。 您不必向IBM Cloud Metrics Routing提供凭据。 您可以在同一帐户中的 {{site.data.keyword.metrics_router_full_notm {{site.data.keyword.metrics_router_full_notm}} } 服务与IBM Cloud Metrics Routing服务与 {{ {{site.data.keyword.mon_short}} Monitoring服务实例之间定义服务到服务的授权。

    有关配置服务到服务身份验证的信息，请参阅 管理授权以授予服务之间的访问权限。

IAM 访问权

您必须拥有正确的 IAM 权限才能管理目标。 有关信息，请参阅 管理 IAM 访问。

使用用户界面创建目标

执行以下操作以使用 UI 创建目标。

仅列出并选择您帐户中的资源。 要指定不同账户中的资源，请选择 “选择目标” 下的 “指定 CRN”。

  1. 登录您的IBM Cloud帐户。

  2. 单击菜单图标菜单图标>可观察性。

  3. 单击监控。

  4. 单击 “路由”。

  5. 单击目标选项卡。

  6. 单击 “创建” 打开创建面板。

  7. 需要服务授权：需要服务授权才能允许IBM Cloud Metrics Routing与IBM Cloud Monitoring进行通信。 单击立即授权以自动创建策略，或单击在 IAM 中授予访问权限。

  8. 选择目的地：选择按实例搜索或指定 CRN

    • 按实例搜索：从表中选择一个IBM Cloud Monitoring实例，或者单击 “创建” 以创建一个新的IBM Cloud Monitoring实例。
    • 指定 CRN：输入IBM Cloud Monitoring实例的云资源名称 (CRN)。 这使您可以从不同的帐户输入 CRN。

  9. 指定目标详细信息。

  • 目标名称：为目标输入一个有意义的名称。

  • 目标区域：选择目标区域。

  • 切换 “设置为默认目标” 以在IBM Cloud Metrics Routing设置中自动将新目标设置为默认目标。 有关更多详细信息，请参阅 默认目标文档。

  1. 单击创建目标。

使用 UI 更新目标

执行以下操作以使用 UI 更新目标。

仅列出并选择您帐户中的资源。 要指定不同账户中的资源，请选择 “选择目标” 下的 “指定 CRN”。

  1. 登录您的IBM Cloud帐户。

  2. 单击菜单图标菜单图标>可观察性。

  3. 单击监控。

  4. 单击 “路由”。

  5. 单击目标选项卡。

  6. 确定要更新哪个目标，然后单击操作图标。

  7. 单击 “取消设置为默认值”可从IBM Cloud Metrics Routing设置中删除您的目标作为默认目标。 有关更多详细信息，请参阅 默认目标文档。

  8. 单击编辑以打开更新面板。

  9. 详细信息：单击 “编辑” 以更新目标的名称。 您还可以在IBM Cloud Metrics Routing设置中切换默认目标以添加或删除您的目标作为默认目标。

    您还可以查看与目标相关的路线。

  10. 单击 “保存” 以更新您的目标。

  11. 目标：单击 “编辑” 以更改与目标相关的IBM Cloud Monitoring实例。

  12. 单击 “保存” 以更新您的目标。

使用 UI 删除目标

执行以下操作以使用 UI 删除目标。

如果IBM Cloud Metrics Routing目标在路由中使用或作为默认目标设置，则您无法删除该目标。

  1. 登录您的IBM Cloud帐户。

  2. 单击菜单图标菜单图标>可观察性。

  3. 单击监控。

  4. 单击 “路由”。

  5. 单击目标选项卡。

  6. 确定要更新哪个目标，然后单击操作图标。

  7. 单击 “删除”，然后在确认面板中单击 “删除”。

使用 UI 列出所有目标

执行以下操作以使用 UI 列出所有目标。

  1. 登录您的IBM Cloud帐户。

  2. 单击菜单图标菜单图标>可观察性。

  3. 单击监控。

  4. 单击 “路由”。

  5. 单击目标选项卡。

该表显示：

  • 目标类型

  • 目标名称

  • 目的地区域

  • 路线：如果目标在任何定义的路线中使用，则路线的数量。

CLI 先决条件

在使用 CLI 管理目标之前，请完成以下步骤：

  1. 安装 IBM Cloud CLI。

  2. 安装 IBM Cloud Metrics Routing CLI。

  3. 登录到 IBM Cloud。 运行以下命令：ibmcloud login

  4. 在配置IBM Cloud Metrics Routing路由或目标之前，您必须配置主要元数据区域。 主要元数据区域使用 ibmcloud metrics-router setting update 命令 --primary-metadata-region 选项进行配置。

使用 CLI 创建Monitoring目标

使用此命令创建一个Monitoring目标，用于配置平台指标的目标。

目标名称在帐户中是唯一的。

ibmcloud metrics-router target create --name TARGET_NAME --destination-crn CRN_VALUE [--region REGION] [--output FORMAT]

命令选项

--region REGION | -r REGION

地区名称，例如“us-south 或”eu-gb。 如果未指定，则将使用登录的区域或目标区域。

--name TARGET_NAME

赋予目标的名称。

不要在任何资源名称中包含任何个人身份信息 (PII)。

--destination-crn CRN_VALUE

Monitoring实例的 CRN。

--output FORMAT

目前支持的格式是 JSON。 如果指定，输出将以 JSON 格式返回。 如果未指定 "JSON，输出将以表格格式返回。

help | --help | -h

列出该命令可用的选项。

示例

以下是使用 ibmcloud metrics-router target create --name my-target --destination-crn crn:v1:bluemix:public:sysdig-monitor:au-syd:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:: 命令的示例。

此示例展示了成功创建目标的示例。

Target
Name:               		my-target
ID:                 		000000000-00000000-0000-0000-00000000
REGION:                         us-east
Type:               		sysdig_monitor
Destination CRN:     		crn:v1:bluemix:public:sysdig-monitor:au-syd:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
CreatedAt:            		2021-07-21T16:04:15.174Z
UpdatedAt:            		2021-07-21T16:04:15.174Z

使用 CLI 更新Monitoring目标

使用此命令更新Monitoring目标。 您可以修改目标的名称和目的地 CRN。 任何与目标最初创建时不同的指定值都将更新为命令中指定的值。

目标名称在帐户中是唯一的。

ibmcloud metrics-router target update --target TARGET [--name TARGET_NAME] [--destination-crn DESTINATION_TARGET_CRN] [--output FORMAT]

命令选项

--target TARGET

ID 或当前目标名称。

--name TARGET_NAME

赋予目标的名称。

不要在任何资源名称中包含任何个人身份信息 (PII)。

--destination-crn DESTINATION_TARGET_CRN

Monitoring实例的 CRN。

--output FORMAT

目前支持的格式是 JSON。 如果指定，输出将以 JSON 格式返回。 如果未指定 "JSON，输出将以表格格式返回。

help | --help | -h

列出该命令可用的选项。

示例

以下是使用 ibmcloud metrics-router target update --target my-target --name my-new-target-name 命令的示例。

Target
Name:               		my-new-target-name
ID:                 		000000000-00000000-0000-0000-00000000
REGION:                         us-east
CRN:                		crn:v1:bluemix:public:metrics-router:us-south:a/xxxxxxxxxx:000000000-00000000-0000-0000-00000000
Type:               		sysdig_monitor
Destination CRN:     		crn:v1:bluemix:public:sysdig-monitor:au-syd:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
CreatedAt:            		2021-07-21T16:04:15.174Z
UpdatedAt:            		2021-07-21T16:04:15.174Z

使用 CLI 删除目标

使用此命令删除目标。

ibmcloud metrics-router target rm --target TARGET [--force]

命令选项

--target TARGET
目标的 ID 或名称。
--force | -f
将删除目标而不向用户提供任何额外提示。
help | --help | -h
列出该命令可用的选项。

示例

以下是使用 ibmcloud metrics-router target rm --target xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx 命令的示例。

Are you sure you want to remove the target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx? [y/N]>y
OK
Target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx was successfully removed.

使用 CLI 获取有关目标的信息

使用此命令获取有关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 target get --target new-target-name 命令显示Monitoring目标的示例。

Name:               		my-target
ID:                 		000000000-00000000-0000-0000-00000000
REGION:                         us-east
CRN:                		crn:v1:bluemix:public:metrics-router:us-south:a/xxxxxxxxxx:000000000-00000000-0000-0000-00000000
Type:               		sysdig_monitor
Destination CRN:     		crn:v1:bluemix:public:sysdig-monitor:au-syd:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
CreatedAt:            		2021-07-21T16:04:15.174Z
UpdatedAt:            		2021-07-21T16:04:15.174Z

列出区域内的所有目标

使用此命令列出IBM Cloud Metrics Routing区域的配置目标。

ibmcloud metrics-router target ls [--output FORMAT]

命令选项

--output FORMAT
目前支持的格式是 JSON。 如果指定，输出将以 JSON 格式返回。 如果未指定 "JSON，输出将以表格格式返回。
help | --help | -h
列出该命令可用的选项。

示例

以下是使用 ibmcloud metrics-router target ls 命令的示例。

Name                       ID                                     Region     Type              	CreatedAt                   UpdatedAt
target-01                  xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx   us-south    sysdig_monitor    2020-11-18T03:52:08.603Z    2020-11-19T03:52:08.603Z
target-02                  yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy   us-south    sysdig_monitor    2020-11-18T03:52:01.592Z    2020-11-19T03:52:08.603Z
target-02-backup           zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz   us-east     sysdig_monitor    2021-02-26T06:53:13.466Z    2020-11-19T03:52:08.603Z

API 目标和操作

下表列出了可以运行的管理目标的操作：

使用IBM Cloud Metrics Routing REST API 来定位操作
操作 REST API 方法 API_URL
创建目标 POST <ENDPOINT>/api/v3/targets
更新目标 PATCH <ENDPOINT>/api/v3/targets/<TARGET_ID>
删除目标 DELETE <ENDPOINT>/api/v3/targets/<TARGET_ID>
读取目标 GET <ENDPOINT>/api/v3/targets/<TARGET_ID>
列出所有目标 GET <ENDPOINT>/api/v3/targets

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

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

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

  • 您可以通过更新帐户设置来禁用公共端点。 有关更多信息，请参阅 配置目标和区域设置。

有关 REST API 的更多信息，请参阅 目标。

API 先决条件

要进行 API 调用来管理目标，请完成以下步骤：

  1. 获取 IAM 访问令牌。 有关更多信息，请参阅 检索 IAM 访问令牌。
  2. 确定您计划配置或管理目标的区域中的 API 端点。 有关更多信息，请参阅 端点。
  3. 在配置IBM Cloud Metrics Routing路由或目标之前，您必须配置主要元数据区域。 使用 修改设置 API 方法配置主要元数据区域。

使用 API 创建Monitoring目标

您可以使用以下cURL命令创建Monitoring目标：

目标名称在帐户中是唯一的。

curl -X POST <ENDPOINT>/api/v3/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
    "name": "TARGET_NAME",
    "destination_crn": "CRN"
  }'

Where

  • <ENDPOINT> 是您计划配置或管理目标的区域中的 API 端点。 有关更多信息，请参阅 端点。

  • TARGET_NAME 是目标的名称。 名称的最大长度为 256 个字符。

    不要在任何资源名称中包含任何个人身份信息 (PII)。

  • CRN 表示Monitoring实例的 CRN。

例如，您可以使用以下cURL请求在达拉斯创建目标：

curl -X POST https://private.us-south.metrics-router.cloud.ibm.com/api/v3/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
    "name": "My-target",
    "target_type": "crn:v1:bluemix:public:sysdig-monitor:au-syd:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::"
  }'

在响应中，您将获得有关目标的信息，例如表示目标 GUID 的 id 和表示目标 CRN 的 crn。

使用 API 更新Monitoring目标

您可以修改目标的名称和目的地 CRN。 任何与目标最初创建时不同的指定值都将更新为请求中指定的值。

当您更新Monitoring目标时，您必须在请求的数据部分中包含目标信息。

  • 您必须传递所有字段。
  • 更新需要更改的字段。

目标名称在帐户中是唯一的。

您可以使用以下cURL命令来更新目标：

curl -X PATCH <ENDPOINT>/api/v3/targets/TARGET_ID -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
    "name": "TARGET_NAME",
    "destination_crn": "CRN"
  }'

Where

  • <ENDPOINT> 是您计划配置或管理目标的区域中的 API 端点。 有关更多信息，请参阅 端点。

  • TARGET_ID 是目标的 ID。

  • TARGET_NAME 是目标的名称。 名称的最大长度为 256 个字符。

    不要在任何资源名称中包含任何个人身份信息 (PII)。

  • CRN 表示Monitoring实例的 CRN。

例如，您可以使用以下cURL请求在达拉斯创建目标：

curl -X PATCH https://private.us-south.metrics-router.cloud.ibm.com/api/v3/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
    "name": "My target",
    "destination_crn": "crn:v1:bluemix:public:sysdig-monitor:au-syd:a/<account-id>:<instance-id>::"
    }
  }'

使用 API 删除目标

您可以使用以下cURL命令删除目标：

curl -X DELETE <ENDPOINT>/api/v3/targets/<TARGET_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

Where

  • <ENDPOINT> 是您计划配置或管理目标的区域中的 API 端点。 有关更多信息，请参阅 端点。
  • <TARGET_ID> 是目标的 ID。

例如，您可以使用以下cURL请求删除 ID 为 00000000-0000-0000-0000-000000000000 目标：

curl -X DELETE https://private.us-south.metrics-router.cloud.ibm.com/api/v3/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

使用 API 查看目标

您可以使用以下cURL命令查看 1 个目标的配置详细信息：

curl -X GET <ENDPOINT>/api/v3/targets/<TARGET_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

Where

  • <ENDPOINT> 是您计划配置或管理目标的区域中的 API 端点。 有关更多信息，请参阅 端点。
  • <TARGET_ID> 是目标的 ID。

例如，您可以运行以下cURL请求来获取有关 ID 为 00000000-0000-0000-0000-000000000000 目标的信息：

curl -X GET https://private.us-south.metrics-router.cloud.ibm.com/api/v3/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

使用 API 列出所有目标

您可以使用以下cURL命令查看所有目标：

curl -X GET <ENDPOINT>/api/v3/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

Where

  • <ENDPOINT> 是您计划配置或管理目标的区域中的 API 端点。 有关更多信息，请参阅 端点。

例如，您可以运行以下cURL请求来获取有关在达拉斯定义的目标的信息：

curl -X GET https://private.us-south.metrics-router.cloud.ibm.com/api/v3/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

HTTP 响应代码

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

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

一些 HTTP 响应代码请参见下表：

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