アカウント設定の構成

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

IBM Cloud Logs Routing アカウント設定を構成または変更する場合は、以下の情報を考慮してください：

IBM Cloud Logs Routing アカウント設定を変更するたびに、新しいリクエストで渡されるデータは、既存の設定データを置き換えます。 アカウント設定の更新を実行するときに、既存のデータが新しい要求に含まれて削除されないようにする必要があります。

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

プライベート・エンドポイントとパブリック・エンドポイントを使用して、設定を管理できます。 使用可能な ENDPOINTS のリストについて詳しくは、エンドポイントを参照してください。

  • プライベート・ネットワーク経由では、以下の形式のAPIエンドポイントを使用する必要がある： https://api.private.<region>.logs-router.cloud.ibm.com

  • パブリック・ネットワーク経由では、以下の形式のAPIエンドポイントを使用する必要がある： https://api.<region>.logs-router.cloud.ibm.com

IBM Cloud Logs Routing アカウント どのようなデータを設定できますか？

以下のいずれかの情報を定義できます。

  • IBM Cloud Logs Routing アカウント構成メタデータが保存されている IBM Cloud アカウント場所。

    メタデータでは、任意のリージョンのアカウント全体で使用可能なターゲット/ルーティング/設定データを参照します。

    IBM Cloud Logs Routing が利用可能な、サポートされている場所のいずれかを選択できます。 詳しくは、ロケーションを参照してください。

    メタデータを保存する場所を選ぶことができる。 また、復旧のためにメタデータを保存するバックアップ場所を設定することもできる。

    金融サービスの検証済みロケーションや EU 管理地域など、企業または業界のコンプライアンス要件を考慮します。

    ターゲットとルートを作成する前に、プライマリメタデータ領域を構成する必要があります。

  • アカウント IBM Cloud Logs Routing アカウント構成を管理することを許可されるエンドポイントのタイプ。

    デフォルトでは、パブリック・エンドポイントとプライベート・エンドポイントが有効になっている。

    プライベート・エンドポイントのみによる管理を制限するようにアカウント設定することができます。

  • アカウント管理者がログを収集するターゲットを定義できる場所。

    IBM Cloud Logs Routing が利用可能な、サポートされている場所のいずれかを選択できます。 詳しくは、ロケーションを参照してください。

    金融サービスの検証済みロケーションや EU 管理地域など、企業または業界のコンプライアンス要件を考慮します。

  • デフォルトのターゲット場所、つまり、ログを収集する方法を設定していない、サポートされている IBM Cloud Logs Routing 場所からログを収集する、 アカウント内の 1 つ以上のターゲット。

    複数のターゲットを定義した場合、すべてのデフォルトターゲットは、 アカウント内の配信先を示すルーティングルールを持たないログのコピーを取得する。 アカウントごとに最大 2 つのデフォルト・ターゲットを定義できます。

  • IBM Cloud Logs Routing のアカウント有効になっている API バージョン。 有効な値は 1 または 3。

IAM 権限

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

UIを使った設定の管理

IBM Cloud Logs Routing UIを使って設定定義を管理できます。 詳細は アカウント設定の構成 を参照。

CLI コマンド

以下の表に、設定を管理するために実行できるアクションをリストします。

IBM Cloud Logs Routing CLIを使用した設定アクション
アクション コマンド
設定情報の取得 ibmcloud logs-router setting get
設定の更新 ibmcloud logs-router setting update

詳しくは、IBM Cloud Logs Routing CLI を参照してください。

API メソッド

以下の表に、設定を管理するために実行できるアクションをリストします。

IBM Cloud Logs Routing REST APIを使用した設定アクション
アクション REST API メソッド API_URL
設定情報の取得 GET <ENDPOINT>/v3/settings
設定の更新 PATCH <ENDPOINT>/v3/settings

プライベート・エンドポイントとパブリック・エンドポイントを使用してターゲットを管理することができます。 使用可能な ENDPOINTS のリストについて詳しくは、エンドポイントを参照してください。

  • https://api.private.REGION.logs-router.cloud.ibm.comという形式の API エンドポイントを使用して、プライベート・ネットワークからターゲットを管理できます。
  • https://api.REGION.logs-router.cloud.ibm.comという形式の API エンドポイントを使用して、パブリック・ネットワークからターゲットを管理できます。

REST APIの詳細については、 設定APIを参照してください。

HTTP 応答コード

IBM Cloud Logs Routing REST API を使用すると、メソッドが正常に完了したかどうかを示す標準 HTTP 応答コードを取得できます。

  • 200 応答は、どのような場合でも成功を示しています。
  • 4xx 応答は、失敗を示しています。
  • 5xx 応答は通常、内部システム・エラーを示しています。

いくつかの HTTP 応答コードについては、以下の表を参照してください。

HTTP 応答コード一覧
状況コード ステータス 説明
200 OK 要求は正常に終了しました。
201 OK 要求は正常に終了しました。 リソースが作成されます。
400 誤った要求 要求は失敗しました。 必要なパラメーターが欠落している可能性があります。
401 無許可 API 要求で使用されている IAM トークンは無効であるか、有効期限が切れています。
403 禁止 権限が不十分なため、操作は禁止されました。
404 見つかりません 要求されたリソースは存在しないか、既に削除されています。
409 競合 リクエストデータとシステム内のリソースの状態に矛盾がある。
429 要求が多すぎる API に到達する要求の数が多すぎるうえに各要求の間隔が短すぎます。
500 内部サーバー・エラー 何らかの問題が発生しました。 要求を処理できませんでした。 後でもう一度試してください。 問題が解決しない場合は、レスポンスヘッダのトランザクションIDを記録し、 IBM Cloud サポートに 連絡する。