关于目标
您可以使用IBM Cloud Metrics Routing UI、IBM Cloud Metrics Routing CLI、IBM Cloud Metrics Routing REST API 和IBM Cloud Metrics Routing Terraform 提供程序来管理您帐户中的Monitoring目标。 目标是可以收集指标的资源。 资源可以位于生成指标的同一IBM Cloud帐户中,也可以位于不同的帐户中。
了解目标在您帐户中的运作方式
请注意有关目标的以下信息:
-
目标是帐户下的区域,可以从任何区域IBM Cloud Metrics Routing API 端点访问。
-
您可以在任何支持IBM Cloud Metrics Routing的位置定义目标。 有关详细信息,请参阅 位置。
-
每个帐户最多可以配置 16 个目标。
-
您可以为每个IBM Cloud帐户配置最多两个默认目标。
默认目标从您未在账户中指定的位置收集指标,并将该位置生成的指标路由到何处。
-
有关目标的信息作为元数据存储在您为IBM Cloud帐户设置的主要位置和备份位置。 存储的信息包括有关目标资源和发送指标的凭证的详细信息。
在配置目标之前必须设置主要元数据位置。
如果您未配置主要元数据位置,则该位置将设置为您在账户中定义第一个目标的位置。 有关更多信息,请参阅 配置帐户设置。
-
您可以使用私有和公共端点来管理目标。 有关可用端点列表的更多信息,请参阅 端点。
-
您可以使用以下格式的 API 端点管理来自私有网络的目标:
https://private.REGION.metrics-router.cloud.ibm.com
-
您可以使用以下格式的 API 端点管理来自公共网络的目标:
https://REGION.metrics-router.cloud.ibm.com
-
您可以通过更新帐户设置来禁用公共端点。 有关更多信息,请参阅 强制实施私有端点。
-
-
目标名称必须少于或等于 1000 个字符,并且不能包含除空格、破折号
-
、点.
、下划线_
和冒号:
以外的任何特殊字符。该名称不得包含任何个人身份信息 (PII)。
目标类型
您可以配置以下任何一种目标类型:
目标 | 类型 | 作用域 | 描述 |
---|---|---|---|
IBM Cloud Monitoring | sysdig-monitor |
Account |
使用此目标将时间序列数据合并到主要操作的区域。 |
IAM 访问权
要管理目标,请确保您拥有 正确的 IAM 权限来配置IBM Cloud Metrics Routing。
要允许IBM Cloud Metrics Routing服务将指标发送到您的Monitoring目的地,您必须在目标所在的帐户中配置服务到服务授权。 有关更多信息,请参阅 管理授权以授予服务之间的访问权限。
IAM 权限
下表列出了 IAM 操作、其范围以及管理路由所需的角色。
任务 | IAM 操作 | IAM 策略范围 | IAM 角色 |
---|---|---|---|
创建目标 | metrics-router.target.create |
区域 | Administrator Editor |
列出所有目标 | metrics-router.target.list |
帐户 | Administrator Editor Operator Viewer |
获取目标的详细信息 | metrics-router.target.read |
区域 | Administrator Editor Operator Viewer |
修改目标 | metrics-router.target.update |
区域 | Administrator Editor |
删除目标 | metrics-router.target.delete |
区域 | Administrator Editor |
当您使用 CLI 时,请注意您需要 metrics-router.target.list
角色来创建、读取、更新或删除目标。
审计事件
下表列出了 IAM 操作、其范围以及管理路由所需的角色。
任务 | 活动跟踪审计事件行动 |
---|---|
创建目标 | metrics-router.target.create |
列出所有目标 | metrics-router.target.list |
获取目标的详细信息 | metrics-router.target.read |
修改目标 | metrics-router.target.update |
删除目标 | metrics-router.target.delete |
使用 UI 管理目标
您可以使用IBM Cloud Metrics Routing UI 管理您的目标定义。 有关更多信息,请参阅 管理目标。
CLI 先决条件
在使用 CLI 管理目标之前,请完成以下步骤:
CLI 命令
下表列出了可以运行的管理目标的操作:
操作 | 命令 |
---|---|
Create a target |
ibmcloud metrics-router target create |
Update a target |
ibmcloud metrics-router target update |
Delete a target |
ibmcloud metrics-router target rm |
Read a target |
ibmcloud metrics-router target get |
List all targets |
ibmcloud metrics-router target ls |
有关更多信息,请参阅 IBM Cloud Metrics Routing v3 CLI。
API 先决条件
在使用 API 管理目标之前,请完成以下步骤:
-
获取 IAM 访问令牌。 有关更多信息,请参阅 检索 IAM 访问令牌。
-
确定您计划配置或管理目标的区域中的 API 端点。 有关更多信息,请参阅 端点。
API 方法
下表列出了可以运行的管理目标的操作:
操作 | REST API 方法 | API_URL |
---|---|---|
Create a target |
POST |
<ENDPOINT>/api/v3/targets |
Update a target |
PATCH |
<ENDPOINT>/api/v3/targets/<TARGET_ID> |
Delete a target |
DELETE |
<ENDPOINT>/api/v3/targets/<TARGET_ID> |
Read a target |
GET |
<ENDPOINT>/api/v3/targets/<TARGET_ID> |
List all targets |
GET |
<ENDPOINT>/api/v3/targets |
有关更多信息,请参阅 IBM Cloud Metrics Routing v3 API。
HTTP 响应代码
在使用 IBM Cloud Metrics Routing REST API 时,您可以获取标准的 HTTP 响应代码,以指示方法是否成功完成。
- 200 响应始终表示成功。
- 4xx响应表示失败。
- 5xx响应通常表示内部系统错误。
有关 HTTP 的一些响应代码,请参见下表:
状态码 | 状态 | 描述 |
---|---|---|
200 |
OK | 请求已成功。 |
201 |
OK | 请求已成功。 资源已创建。 |
204 |
OK | 目标已成功删除。 |
400 |
错误请求 | 请求未成功。 您可能缺少必需的参数。 |
401 |
未授权 | 授权请求失败。 |
403 |
禁止 | 由于权限不足,禁止操作。 |
404 |
找不到 | 请求的资源不存在或已被删除。 |
429 |
请求次数太多 | 太多请求过快命中 API。 |
500 |
内部服务器错误 | IBM Cloud Metrics Routing处理过程中出现错误。 |