ターゲットについて
IBM Cloud Metrics Routing UI、 IBM Cloud Metrics Routing CLI、 IBM Cloud Metrics Routing REST API、 IBM Cloud Metrics Routing Terraform プロバイダ、 Terraform IBM Modules(TIM)for IBM Cloud Metrics Routing を使用して、 アカウント内の Monitoring ターゲットを管理できます。 ターゲットは、メトリクスを収集できるリソースです。 リソースは、メトリッ クが生成されるのと同じ IBM Cloud アカウント置くことも、別のアカウント置くこともできます。
アカウントでターゲットがどのように機能するかを理解する
ターゲットに関する以下の情報に注意してください。
-
ターゲットはアカウントの下の地域であり、任意の地域の IBM Cloud Metrics Routing API エンドポイントからアクセスできます。
-
IBM Cloud Metrics Routing が使用可能な任意のサポート対象ロケーションでターゲットを定義できます。 詳しくは、ロケーションを参照してください。
-
アカウント最大16のターゲットを設定できる。
-
IBM Cloud アカウントごとに最大 2 つのデフォルト・ターゲットを構成できます。
デフォルト・ターゲットは、そのロケーションで生成されるメトリックをルーティングする場所をアカウントに指定していないロケーションからメトリックを収集します。
-
ターゲットに関する情報は、 IBM Cloud アカウントに設定したプライマリー・ロケーションとバックアップ・ロケーションにメタデータとして保管されます。 保管される情報には、宛先リソースに関する詳細と、メトリックを送信するための資格情報が含まれます。
プライマリ・メタデータの場所は、ターゲットを設定する前に設定する必要がある。
1 次メタデータ・ロケーションを構成しない場合、ロケーションは、アカウント内の最初のターゲットを定義したロケーションに設定されます。 詳しくは、 アカウント設定の構成 を参照してください。
-
プライベート・エンドポイントとパブリック・エンドポイントを使用してターゲットを管理することができます。 利用可能なエンドポイントのリストについては、「 エンドポイント 」を参照のこと。
-
以下の形式の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 |
このターゲットを使用して、時系列データを 1 次操作の領域に統合します。 |
IAM アクセス権限
ターゲットを管理するには、 IBM Cloud Metrics Routingを構成するための正しい IAM 許可 があることを確認します。
IBM Cloud Metrics Routing サービスがメトリックを Monitoring 宛先に送信できるようにするには、ターゲットが配置されているアカウントでサービス許可が構成されている必要があります。 詳しくは、 サービス間のアクセス権限を付与するための許可の管理 を参照してください。
IAM 権限
以下の表に、IAM アクション、そのスコープ、および経路の管理に必要な役割をリストします。
| タスク | IAM アクション | IAM ポリシー・スコープ | IAM 役割 |
|---|---|---|---|
| ターゲットの作成 | metrics-router.target.create |
リージョン | AdministratorEditor |
| すべてのターゲットのリスト | metrics-router.target.list |
アカウント | AdministratorEditorOperatorViewer |
| ターゲットの詳細を取得する | metrics-router.target.read |
リージョン | AdministratorEditorOperatorViewer |
| ターゲットの変更 | metrics-router.target.update |
リージョン | AdministratorEditor |
| ターゲットの削除 | metrics-router.target.delete |
リージョン | AdministratorEditor |
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 の処理で何らかの問題が発生しました。 |