CLI の前提条件

CLI を使用してターゲットを管理する前に、以下の手順を実行します。

1. IBM Cloud CLI をインストールします。

2. IBM Cloud Activity Tracker Event Routing CLI をインストールします。

3. IBM Cloud にログインします。 次のコマンドを実行します。 ibmcloud login

同じアカウント内でUIを使用して S2S の認証を設定する

IBM Cloud UI を使用してサービス間許可を構成するには、以下の手順を実行します。

1. IBM Cloud Activity Tracker Event Routing ターゲットを構成するアカウント所有者として IBM Cloud アカウントにログインします。

   ユーザー ID とパスワードを使用してログインすると、IBM Cloud ダッシュボードが開きます。

2. [管理] > [アクセス (IAM)] > [権限] を選択します。

3. 「作成」 をクリックします。

4. 「 ソースサービス 」では、 Activity Tracker を選択し、「 アクセスの範囲をどのように設定しますか？」 では、「 すべてのリソース 」を選択します。

5. 「 対象サービス 」では、以下を選択してください App Configuration、「 アクセスの範囲をどのように設定しますか？」 では、「 選択した属性に基づくリソース 」を選択します。

6. 「 サービスインスタンス 」を選択し、「 文字列が等しい 」を選択します。 IBM Cloud App Configuration インスタンスの名前を設定してください。

7. サービスへのアクセスについては、「 マネージャー 」および「 構成更新レポーター 」のロールを選択してください。

8. 「許可」 をクリックします。 新しいサービス間許可が「許可の管理」ビューにリストされます。

CLI を使用した S2S の認証設定

IBM Cloud CLI を使用してサービス間許可を構成するには、以下の手順を実行します。

1. IBM Cloud アカウントにログインしてください IBM Cloud Activity Tracker Event Routing の認証設定を行うアカウントの所有者として。

2. サービス間許可を定義する許可ポリシーを作成します。

   ibmcloud iam authorization-policy-create atracker apprapp "ConfigurationUpdateReporter" [--target-service-instance-id <APPCONFIG_SERVICE_INSTANCE>
   

API を使用した「 S2S 」の認証設定

IBM Cloud API を使用してサービス間許可を構成するには、以下の手順を実行します。

1. IBM Cloud Activity Tracker Event Routing IAM 許可を構成するアカウント所有者として IBM Cloud アカウントにログインします。

2. サービス間許可を定義するauthorization_policy_resource.jsonファイルを作成します。

   {
       "type": "authorization",
       "subjects": [
           {
               "attributes": [
                 {
                      "name": "accountId",
                      "value": "CUSTOMER_ACCOUNT_ID"
                  },
                  {
                       "name": "serviceName",
                       "value": "atracker"
                   }
               ]
           }
       ],
       "roles": [
           {
               "role_id": "crn:v1:bluemix:public:iam::::serviceRole:ConfigurationUpdateReporter"
           }
       ],
       "resources": [
           {
               "attributes": [
                 {
                      "name": "accountId",
                      "value": "CUSTOMER_ACCOUNT_ID"
                  },
                  {
                       "name": "serviceName",
                       "value": "apprapp"
                   },
                   {
                       "name": "serviceInstance",
                       "value": "APPCONFIG_SERVICE_INSTANCE"
                   }
               ]
           }
       ]
   }
   

   ここで、

   CUSTOMER_ACCOUNT_IDは、ターゲットを構成するアカウントのアカウント GUID です。 これは、ibmcloud account listコマンドを使用して見つけることができます。

   APPCONFIG_SERVICE_INSTANCE IBM Cloud App Configuration インスタンスのインスタンスIDです。

3. IAM アクセス・トークンを取得します。 詳しくは、IAM アクセス・トークンの取得を参照してください。

4. 以下のコマンドを実行して、サービス間許可を構成します。

   curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header "Authorization: $ACCESS_TOKEN" -d @authorization_policy_resource.json "https://iam.cloud.ibm.com/v1/policies"
   

CLI を使用して「 IBM Cloud App Configuration 」ターゲットを作成する

このコマンドを使用して、アクティビティイベントの送信先を設定するために使用する「 IBM Cloud App Configuration 」ターゲットを作成します。

 ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file APPCONFIG_ENDPOINT_DEFINITION_JSON_FILE] | ( [--target-crn APPCONFIG_TARGET_CRN] ) ) [--region REGION] [--output FORMAT]

OK
Target
Name:                         my-target
ID:                           000000000-00000000-0000-0000-00000000
CRN:                          crn:v1:bluemix:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                       us-south
Type:                         app_config
App Configuration Target CRN: crn:v1:bluemix:public:apprapp:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Write Status:                 success
CreatedAt:                    2024-05-31T19:03:35.427Z
UpdatedAt:                    2024-05-31T19:03:35.427Z

CLI を使用して IBM Cloud App Configuration ターゲットを更新する

このコマンドを使用して、 IBM Cloud Activity Tracker Event Routing リージョンの IBM Cloud App Configuration ターゲットを更新します。 ターゲットが最初に作成された時の値とは異なる値をコマンドで指定すると、その値がコマンドの指定値に更新されます。

ibmcloud atracker target update --target TARGET [--name TARGET_NAME] [ [--file APPCONFIG_ENDPOINT_DEFINITION_JSON_FILE] | [--target-crn APPCONFIG_TARGET_CRN]] [--output FORMAT]

OK
Target
Name:                         new-target-name
ID:                           000000000-00000000-0000-0000-00000000
CRN:                          crn:v1:bluemix:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                       us-south
Type:                         app_config
App Configuration Target CRN: crn:v1:bluemix:public:apprapp:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Write Status:                 success
Created:                      2024-05-31T19:03:35.427Z
Updated:                      2024-05-31T19:03:35.427Z

CLI を使用したターゲットの削除

このコマンドは、ターゲットを削除するために使用します。

ibmcloud atracker target rm --target TARGET [--force]

Are you sure you want to remove the target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx? [y/N]>y
OK
Target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx was successfully removed.

Are you sure you want to remove the Target bearing Target ID 33333333-3333-3333-3333-333333333333? [y/N]> y
FAILED
Something went wrong. Error:
 Status Code:  404
 Incident ID:  67a33257-d5a4-46ec-94d9-14eb70e94f3d
 Code:         not_found
 Message:      The target id specified in `target_id` field is not found.

CLI を使用したターゲットの検証

このコマンドを使用して、IBM Cloud Activity Tracker Event Routing リージョンのターゲットが正しく構成されていることを確認します。

ibmcloud atracker target validate --target TARGET [--region REGION] [--output FORMAT]

Target
Name:                            new-target-name
ID:                              xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN:                             crn:v1:bluemix:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type:                            app_config
App Configuration Target CRN:    crn:v1:bluemix:public:apprapp:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Service to Service Enabled:      true
Write Status:                    success
Created:                         2021-07-21T16:04:15.174Z
Updated:                         2021-07-21T17:49:56.452Z

CLI を使用したターゲットに関する情報の取得

このコマンドを使用して、IBM Cloud Activity Tracker Event Routing リージョンのターゲットに関する情報を取得します。

ibmcloud atracker target get --target TARGET [--output FORMAT]

Target
Name:                            new-target-name
ID:                              xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN:                             crn:v1:bluemix:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                          us-east
Type:                            app_config
App Configuration Target CRN:    crn:v1:bluemix:public:apprapp:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Write Status:                    success
Created:                         2024-06-02T16:04:15.174Z
Updated:                         2024-06-05T17:49:56.452Z

リージョン内のすべてのターゲットのリスト

このコマンドを使用して、IBM Cloud Activity Tracker Event Routing リージョンの構成済みターゲットを表示します。

ibmcloud atracker target ls [--output FORMAT]

Name                       ID                                     Region     Type                Created
target-01                  xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx   us-south   app_config   2020-11-18T03:52:08.603Z

API のターゲットとアクション

次の表は、ターゲットを管理するために実行できるアクションのリストです。

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

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

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

• アカウント設定を更新することで、パブリック・エンドポイントを無効にすることができます。 詳しくは、ターゲットとリージョンの設定の構成を参照してください。

REST API について詳しくは、ターゲットを参照してください。

API の前提条件

ターゲットを管理するための API 呼び出しを行うには、以下のステップを実行します。

1. IAM アクセス・トークンを取得します。 詳しくは、IAM アクセス・トークンの取得を参照してください。
2. ターゲットを構成または管理する予定のリージョン内の API エンドポイントを特定します。 詳しくは、エンドポイントを参照してください。

API を使用して「 IBM Cloud App Configuration 」ターゲットを作成する

次の cURL コマンドを使用して、 IBM Cloud App Configuration ターゲットを作成できます：

curl -X POST  <ENDPOINT>/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "TARGET_NAME",
    "target_type": "app_config",
    "app_config_endpoint": {
      "target_crn": "APPCONFIG_CRN"
    }
  }'

説明

• <ENDPOINT>は、ターゲットを構成または管理する予定の地域の API エンドポイントです。 詳しくは、エンドポイントを参照してください。

• TARGET_NAME は、ターゲットの名前です。 この名前の最大長は 256 文字です。

  リソース名に個人識別情報 (PII) を含めないでください。

• TARGET_TYPE は、ターゲットのタイプです。

• app_config_endpointには、ターゲットに関する情報が含まれます。

APPCONFIG_CRN IBM Cloud App Configuration インスタンスの CRN を示します。

例えば、次の cURL 要求を使用して、ダラスにターゲットを作成できます。

curl -X POST   https://private.us-south.atracker.cloud.ibm.com/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "My App Configuration target",
    "target_type": "app_config",
    "app_config_endpoint": {
      "target_crn": "crn:v1:bluemix:public:apprapp:us-south:a/<account-id>:<instance-id>::"
    }
  }'

応答では、ターゲットの GUID を示す id やターゲットの CRN を示す crn など、ターゲットに関する情報が得られます。

API を使用して IBM Cloud App Configuration ターゲットを更新する

IBM Cloud App Configuration ターゲットを更新する際は、リクエストのデータセクションにターゲット情報を含める必要があります。

• すべてのフィールドを渡す必要があります。
• 変更する必要があるフィールドを更新します。
• 作成したターゲットのtarget_typeを変更することはできません。

以下の cURL コマンドを使用して、ターゲットを更新できます。

curl -X PUT  <ENDPOINT>/api/v2/targets/TARGET_ID  -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "TARGET_NAME",
    "target_type": "app_config",
    "app_config_endpoint": {
      "target_crn": "APPCONFIG_CRN"
    }
  }'

説明

• <ENDPOINT>は、ターゲットを構成または管理する予定の地域の API エンドポイントです。 詳しくは、エンドポイントを参照してください。

• TARGET_IDはターゲットの ID です。

• TARGET_NAME は、ターゲットの名前です。 この名前の最大長は 256 文字です。

  リソース名に個人識別情報 (PII) を含めないでください。

• TARGET_TYPE は、ターゲットのタイプです。 IBM Cloud App Configuration ターゲットの場合は、値を app_config に設定してください。

• app_config_endpointには、ターゲットに関する情報が含まれます。

APPCONFIG_CRN IBM Cloud App Configuration インスタンスの CRN を示します。

例えば、以下の cURL 要求を使用して、ダラスのターゲットを更新できます。

curl -X PUT   https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/TARGET_ID   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "My new App Configuration target name",
    "target_type": "app_config",
    "app_config_endpoint": {
      "target_crn": "crn:v1:bluemix:public:apprapp:us-south:a/<account-id>:<instance-id>::"
    }
  }'

API を使用したターゲットの削除

以下の cURL コマンドを使用して、ターゲットを削除できます。

curl -X DELETE <ENDPOINT>/api/v2/targets/<TARGET_ID> -H "Authorization:  $ACCESS_TOKEN" -H "content-type: application/json"

説明

• <ENDPOINT>は、ターゲットを構成または管理する予定の地域の API エンドポイントです。 詳しくは、エンドポイントを参照してください。
• <TARGET_ID>はターゲットの ID です。

例えば、以下の cURL 要求を使用して、00000000-0000-0000-0000-000000000000という ID を持つ米国南部のターゲットを削除できます。

curl -X DELETE https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

削除が成功した場合、応答で空の結果が返されます。

{}

API を使用したターゲットの検証

以下の cURL コマンドを使用して、ターゲットに書き込む資格情報をチェックすることにより、ターゲットを検証できます。

curl -X POST <ENDPOINT>/api/v2/targets/<TARGET_ID>/validate -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

説明

• <ENDPOINT>は、ターゲットを構成または管理する予定の地域の API エンドポイントです。 詳しくは、エンドポイントを参照してください。
• <TARGET_ID>はターゲットの ID です。

例えば、以下の cURL 要求を使用して、ID 00000000-0000-0000-0000-000000000000を持つ米国南部のターゲットを検証できます。

curl -X POST https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/<TARGETID>/validate -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

応答の「 write_status 」セクションに情報が表示されます。例えば、次のようなものです：

"write_status": {
    "status": "success"
  },

API を使用したターゲットの表示

次の cURL コマンドを使用して、1 つのターゲットの構成の詳細を表示することができます。

curl -X GET <ENDPOINT>/api/v2/targets/<TARGET_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

説明

• <ENDPOINT>は、ターゲットを構成または管理する予定の地域の API エンドポイントです。 詳しくは、エンドポイントを参照してください。
• <TARGET_ID>はターゲットの ID です。

例えば、以下の cURL 要求を実行して、ID 00000000-0000-0000-0000-000000000000のターゲットに関する情報を取得できます。

curl -X GET https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

結果により、対象がCOS（"target_type": "cloud_object_storage" ）、 IBM Cloud Logs のサービス（"target_type": "cloud_logs" ）、あるいは IBM Cloud App Configuration （"target_type": "app_config" ）のいずれであるかが判明します

API を使用したすべてのターゲットのリスト表示

次の cURL コマンドを使用して、すべてのターゲットを表示できます。

curl -X GET <ENDPOINT>/api/v2/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

説明

• <ENDPOINT>は、ターゲットを構成または管理する予定の地域の API エンドポイントです。 詳しくは、エンドポイントを参照してください。

例えば、以下の cURL 要求を実行して、ダラスで定義されているターゲットに関する情報を取得できます。

curl -X GET https://private.us-south.atracker.cloud.ibm.com/api/v2/targets -H "Authorization:  $ACCESS_TOKEN" -H "content-type: application/json"

結果により、対象がCOS（"target_type": "cloud_object_storage" ）、 IBM Cloud Logs のサービス（"target_type": "cloud_logs" ）、あるいは IBM Cloud App Configuration （"target_type": "app_config" ）のいずれであるかが判明します

HTTP 応答コード

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

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

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