アカウント設定の構成

IBM Cloud Logs Routing アカウント設定を構成して、 アカウント内でプラットフォームログを収集、ルーティング、管理する場所と方法を定義できます。 UIからでも、CLI、REST API V3、Terraformスクリプトを使ってもできる。

--private-api-endpoint-only TRUEを設定してパブリック・エンドポイントを無効にする前に、アカウントにプライベート・エンドポイントへのアクセス権限があることを確認してください。 これを行うには、コマンドibmcloud account showを実行します。 VRF Enabledが true で、Service Endpoint Enabledが true の場合は、プライベート・エンドポイントへのアクセス権限があります。 プライベート・エンドポイントへのアクセス権限がない場合は、パブリック・エンドポイントを再度有効にすることができなくなります。パブリック・エンドポイントを再度有効にするには、プライベート・エンドポイントにアクセスする必要があるからです。

詳細は アカウント設定について を参照。

IAM 権限

を持っていることを確認する。 IBM Cloud Logs Routing 設定を構成するための適切な IAM パーミッション。

UIを使用してアカウント設定の詳細を取得する

UI を使用して IBM Cloud Logs Routing のアカウント設定を表示するには、以下の手順を実行します：

  1. IBM Cloud アカウントログイン.

  2. 「メニュー」 アイコン 「メニュー」アイコン > **「可観測性」**をクリックします。

  3. Logging > Routingをクリックする。

  4. **「Settings」**タブをクリックします。

このページでは、以下の設定を見ることができます：

  • メタデータの場所 ：プライマリメタデータ領域とバックアップメタデータ領域を表示します。

  • 許可された対象地域。 プラットフォームログを送信できる対象地域を表示します。

  • デフォルトターゲット ：設定されたデフォルトターゲットを表示します。

  • パブリック・エンドポイント ：パブリックエンドポイントが有効かどうかを表示します。 無効にすると、 IBM Cloud Logs Routing UIにアクセスできなくなる。

  • レポート設定をJSON形式で表示します。

UIを使用したアカウント設定の更新

  1. IBM Cloud アカウントログイン.

  2. 「メニュー」 アイコン 「メニュー」アイコン > **「可観測性」**をクリックします。

  3. Logging >Routing をクリックします。

  4. **「Settings」**タブをクリックします。

  5. 変更する設定の横にある Editをクリックします。 以下の設定を変更できます：

  • メタデータの場所 ：プライマリ・メタデータ領域とバックアップ・メタデータ領域を選択します。

  • 許可されたターゲット地域 ：ターゲットを作成できる地域を選択します。 リージョンが選択されていない場合、すべてのリージョンがプラットフォームログを受け取ることができる。

  • デフォルトターゲット ：ルーティングルールが存在しない、またはマッチしない場合にデフォルトで使用されるターゲットを選択します。

CLI の前提条件

CLI を使用して IBM Cloud Logs Routing アカウント設定を管理する前に、 IBM Cloud Logs Routing CLI をインストールして ください。

IBM Cloud Logs Routing アカウント設定の読み取り、更新、または両方を行う IAM パーミッションがあることを確認します。

CLIを使用してアカウント設定の詳細を取得する

このコマンドを使用して、 IBM Cloud Logs Routing アカウント構成の設定を取得する。

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

コマンド・オプション

--output FORMAT
JSON を指定すると、出力が JSON 形式で返されます。 JSON を指定しない場合は、出力が表形式で返されます。
help | --help | -h
コマンドで使用できるオプションがリストされます。

例

以下は、デフォルトまたは許可されたターゲットが設定されていない例である。

Default Targets             -
Permitted Target Regions    -
Primary Metadata Region
Backup Metadata Region
Private Api Endpoint Only   false
Api Version                 1

CLIを使用したアカウント設定の更新

このコマンドを使用して、デフォルト・ターゲット、許可されたターゲット領域、および 1 次メタデータ領域などの現行アカウント設定を変更します。

ibmcloud logs-router setting update [--default-targets DEFAULT-TARGETS | @DEFAULT-TARGETS-FILE] [--permitted-target-regions PERMITTED-TARGET-REGIONS] [--primary-metadata-region PRIMARY-METADATA-REGION] [--backup-metadata-region BACKUP-METADATA-REGION] [--private-api-endpoint-only=PRIVATE-API-ENDPOINT-ONLY] [--output FORMAT] [--force]

コマンド・オプション

primary-metadata-region

経路定義およびターゲット定義に関連付けられたメタデータが保管される REGION を指定します。

最大長は 256 文字です。 最小文字数は3文字です。

backup-metadata-region

ルートとターゲットの定義に関連するメタデータをバックアップとして保存する REGION を指定します。

最大長は 256 文字です。 最小文字数は3文字です。

private-api-endpoint-only

プライベート・エンドポイントを使用できるかどうかを指定します。 TRUEの場合は、プライベート・エンドポイントのみを使用できます。

default-targets

ターゲット ID のリストです。 ルーティングルールがプラットフォームのログを他のターゲットに送信することを引き起こさない場合、これらのターゲットはプラットフォームのログを受信する。 TARGETS は、ターゲット ID のコンマ区切りリストです。

長さは2項目まで。 最小長は0項目です。

permitted-target-regions

ターゲットを定義するために使用できる領域のリストです。 REGIONS は、領域のコンマ区切りリストです。

最大長さは16項目。 最小長は0項目です。

--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://api.<region>.logs-router.cloud.ibm.com/v3/settings   -H "Authorization:  $ACCESS_TOKEN"

以下のような応答が返されます。

{
  "default_targets":[],
  "permitted_target_regions":[],
  "primary_metadata_region":"",
  "backup_metadata_region":"",
  "private_api_endpoint_only":false,
  "api_version":1
}

ここで、

default_targets
ターゲット ID のリストです。 ルーティングルールがプラットフォームのログを他のターゲットに送信することを引き起こさない場合、これらのターゲットはプラットフォームのログを受信する。
permitted_target_regions
ターゲットを定義するために使用できる領域のリストです。 許可されるターゲット領域は最大 2 つまでです。
primary_metadata_region
経路定義およびターゲット定義に関連付けられたメタデータが保管される領域です。
backup_metadata_region
ルートとターゲット定義に関連するメタデータがバックアップとして保存される領域。
private_api_endpoint_only
プライベート・エンドポイントを使用できるかどうかを指定します。 trueの場合は、プライベート・エンドポイントのみを使用できます。
api_version
このアカウント設定されているAPIのバージョン。

APIを使用したアカウント設定の更新

設定を更新する際には、以下の情報を考慮してください：

  • リクエストのデータセクションに設定情報を含める必要があります。

  • 各設定に設定されているデータを渡す必要がある。

    設定され、更新要求に含まれていないデータは削除される。

  • 変更が必要なフィールドのデータを更新する。

  • API バージョンの変更は、 V1 から V3 への移行プロセスの一部としてのみ許可される。 v1 から v3 への移行を 参照。

以下の cURL コマンドを使用して、設定を更新できます。

curl -X PATCH   https://api.<region>.logs-router.cloud.ibm.com/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
ターゲット ID のリストです。 ルーティングルールがプラットフォームのログを他のターゲットに送信することを引き起こさない場合、これらのターゲットはプラットフォームのログを受信する。
permitted_target_regions
ターゲットを定義するために使用できる領域のリストです。 最大 2 つの許可されたターゲット領域を指定できます。
primary_metadata_region
経路定義およびターゲット定義に関連付けられたメタデータが保管される領域です。
backup_metadata_region
ルートとターゲットの定義に関連するメタデータがバックアップ目的で保存される領域。
private_api_endpoint_only
プライベート・エンドポイントを使用できるかどうかを指定する。 trueの場合は、プライベート・エンドポイントのみを使用できます。