IBM Cloud Docs
配置帐户设置

配置帐户设置

您可以使用 IBM Cloud Metrics Routing UI、IBM Cloud Metrics Routing CLI、IBM Cloud Metrics Routing REST API 和 Terraform 脚本配置 IBM Cloud® Metrics Routing 的账户设置。 设置这些设置以定义在帐户中收集,路由和管理度量的位置和方式。

在通过设置 --private-api-endpoint-only TRUE 来禁用公共端点之前,请确保您的帐户具有对专用端点的访问权。 您可以通过运行命令 ibmcloud account show 来执行此操作。 如果 VRF EnabledtrueService Endpoint Enabledtrue,那么您有权访问专用端点。 如果您无权访问专用端点,那么将无法重新启用公共端点,因为需要专用端点访问才能重新启用公共端点。

有关更多信息,请参阅 关于帐户设置

IAM 许可权

确保您具有 配置 IBM Cloud Metrics Routing 设置的正确 IAM 许可权。

使用用户界面获取账户设置

执行以下操作,使用用户界面查看 IBM Cloud Metrics Routing 的账户设置。

  1. 登录您的 IBM Cloud 账户

  2. 单击 Menu 图标 Menu 图标 > Observability.

  3. 点击监控

  4. 单击 路由

  5. 单击设置选项卡。

在此页面,您可以查看以下设置:

  • 元数据位置:显示主元数据区域和备份元数据区域。

  • 允许的目标区域。 显示可发送指标的目标区域。

  • 默认目标:显示已配置的默认目标。

  • 公共端点:显示是否启用了公共端点。 禁用时,将无法访问 IBM Cloud Metrics Routing 用户界面。

  • 报告:以 JSON 格式显示配置。

使用用户界面更新设置

  1. 登录您的 IBM Cloud 账户

  2. 单击 Menu 图标 Menu 图标 > Observability.

  3. 点击监控

  4. 单击 路由

  5. 单击设置选项卡。

  6. 单击要更改的设置旁边的 Edit。 您可以修改以下设置:

  • 元数据位置:选择所需的主元数据区域和备份元数据区域。

  • 允许的目标区域:选择可以创建目标的区域。 如果没有选择任何区域,则所有区域都可以接收度量指标。

  • 默认目标:选择路由规则不存在或不匹配时默认使用的目标。

CLI 先决条件

在使用 CLI 管理 IBM Cloud Metrics Routing 帐户设置之前,请 安装 IBM Cloud Metrics Routing CLI

检查您是否具有 IAM 许可权来读取和/或更新 IBM Cloud Metrics Routing 帐户设置。

使用 CLI 获取帐户设置

使用此命令可获取 IBM Cloud Metrics Routing 帐户配置的设置。

ibmcloud metrics-router setting get [--output FORMAT]

命令选项

--output FORMAT
如果指定了 JSON,那么将以 JSON 格式返回输出。 如果未指定 JSON,则将以表格格式返回输出。
help | --help | -h
列出可用于该命令的选项。

示例

以下是未设置缺省目标或允许的目标的示例。

Primary metadata region:             us-east
Backup metadata region:              -
Default targets:                     []
Permitted target regions:            []
Private api endpoint only:           false

使用 CLI 更新设置

使用此命令可修改当前帐户设置,例如缺省目标,允许的目标区域和主元数据区域。

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]

命令选项

primary-metadata-region
指定存储与路由和目标定义关联的元数据的 REGION。
backup-metadata-region
指定与路由和目标定义关联的元数据作为备份存储的 REGION。
private-api-endpoint-only
指定是否可以使用专用端点。 如果 TRUE,那么只能使用专用端点。
default-targets
是目标标识的列表。 如果没有路由规则导致将度量值发送到其他目标,那么这些目标将接收到这些度量值。 TARGETS 是以逗号分隔的目标标识列表。
permitted-target-regions
可用于定义目标的区域的列表。 REG才是以逗号分隔的区域列表。
--output FORMAT
如果指定了 JSON,那么将以 JSON 格式返回输出。 如果未指定 JSON,则将以表格格式返回输出。
help | --help | -h
列出可用于该命令的选项。

如果更新成功,那么将显示当前设置。

API 先决条件

要进行 API 调用以管理设置,请完成以下步骤:

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

使用 API 获取设置

可以使用以下 cURL 命令来获取现有设置信息:

curl -X GET  ENDPOINT/api/v3/settings   -H "Authorization:  $ACCESS_TOKEN"

其中:

ENDPOINT
是计划在其中配置或管理目标的区域中的 API 端点。 有关更多信息,请参阅 端点

例如,您可以使用以下 cURL 请求来获取帐户设置信息:

curl -X GET   https://private.us-south.metrics_router.cloud.ibm.com/api/v2/settings   -H "Authorization:  $ACCESS_TOKEN"

返回类似以下内容的响应:


{
  "default_targets": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "crn": "crn:v1:bluemix:public:metrics-router:us-south:a/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::target:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "default-us-south-target",
      "target_type": "sysdig_monitor"
    },
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "crn": "crn:v1:bluemix:public:metrics-router:au-syd:a/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::target:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "default-au-syd-south-target",
      "target_type": "sysdig_monitor"
    }
  ],
  "permitted_target_regions": [
    "us-south",
    "us-east"
  ],
  "primary_metadata_region": "us-south",
  "private_api_endpoint_only": false
}

其中:

default_targets
是目标标识的列表。 如果没有路由规则导致将度量值发送到其他目标,那么这些目标将接收到这些度量值。
permitted_target_regions
可用于定义目标的区域的列表。 最多允许两个允许的目标区域。
primary_metadata_region
存储与路由和目标定义关联的元数据的区域。
backup_metadata_region
与路由和目标定义关联的元数据作为备份存储的区域。
private_api_endpoint_only
指定是否可以使用专用端点。 如果 true,那么只能使用专用端点。

使用 API 更新设置

更新设置时,请考虑以下信息:

  • 必须在请求的数据部分中包含设置信息。

  • 必须传递为每个设置配置的数据。

    将删除已配置且未包含在更新请求中的数据。

  • 更新需要更改的字段的数据。

您可以使用以下 cURL 命令来更新设置:

curl -X PATCH   https://<ENDPOINT>/api/v3/settings
-H "Authorization: Bearer <IAM_TOKEN>"
-H 'accept: application/json'
-d '{
  "default_targets": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  ],
  "permitted_target_regions": ["us-south", "us-east"],
  "primary_metadata_region": "us-south",
  "backup_metadata_region": "us-east",
  "private_api_endpoint_only": false
}'

其中:

ENDPOINT
是计划在其中配置或管理目标的区域中的 API 端点。 有关更多信息,请参阅 端点
default_targets
是目标标识的列表。 如果没有路由规则导致将度量值发送到其他目标,那么这些目标将接收到这些度量值。
permitted_target_regions
可用于定义目标的区域的列表。 最多可以指定两个允许的目标区域。
primary_metadata_region
存储与路由和目标定义关联的元数据的区域。
backup_metadata_region
存储与路由和目标定义关联的元数据以进行备份的区域。
private_api_endpoint_only
指定是否可以使用专用端点。 如果 true,那么只能使用专用端点。