CLI-Voraussetzungen

Bevor Sie die Befehlszeilenschnittstelle zum Verwalten von Zielen verwenden, führen Sie die folgenden Schritte aus:

1. Installieren Sie die IBM Cloud-Befehlszeilenschnittstelle.

2. Installieren Sie die IBM Cloud Activity Tracker Event Routing CLI.

3. Melden Sie sich bei IBM Cloud an. Führen Sie den folgenden Befehl aus: ibmcloud login

Konfigurieren der S2S-Autorisierung über die Benutzeroberfläche innerhalb desselben Kontos

Gehen Sie wie folgt vor, um eine Service-zu-Service-Autorisierung über die Benutzerschnittstelle von IBM Cloud zu konfigurieren.

1. Melden Sie sich bei Ihrem IBM Cloud-Konto als Kontoeigner an, der IBM Cloud Activity Tracker Event Routing-Ziele konfigurieren möchte.

   Nach der Anmeldung mit Ihrer Benutzer-ID und Ihrem Kennwort wird das IBM Cloud-Dashboard geöffnet.

2. Wählen Sie Verwalten > Zugriff (IAM) > Berechtigungen.

3. Klicken Sie auf Erstellen.

4. Wählen Sie für **den Quelldienst **Activity Tracker aus und für Wie möchten Sie den Zugriff eingrenzen? die Option Alle Ressourcen.

5. Wählen Sie unter Ziel-Service die Option App Configuration aus und unter Wie möchten Sie den Zugriff eingrenzen? die Option Ressourcen basierend auf ausgewählten Attributen.

6. Wählen Sie „Service-Instanz“ und „ Zeichenfolge ist gleich “ aus. Legen Sie den Namen Ihrer „ IBM Cloud App Configuration “-Instanz fest.

7. Wählen Sie für den Servicezugriff die Rollen „Manager“ und „Configuration Update Reporter“ aus.

8. Klicken Sie auf Autorisieren. Ihre neue Service-zu-Service-Autorisierung wird in der Ansicht Berechtigungen verwalten aufgelistet.

Konfigurieren der S2S-Autorisierung über die CLI

Gehen Sie wie folgt vor, um eine Service-zu-Service-Autorisierung über die Befehlszeilenschnittstelle von IBM Cloud zu konfigurieren.

1. Melden Sie sich bei Ihrem IBM Cloud-Konto als der Kontoinhaber an, der die Autorisierung für IBM Cloud Activity Tracker Event Routing konfigurieren wird.

2. Erstellen Sie eine Autorisierungsrichtlinie, die Ihre Service-zu-Service-Autorisierung definiert.

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

Konfigurieren der S2S-Autorisierung über die API

Gehen Sie wie folgt vor, um eine Service-zu-Service-Autorisierung über die API von IBM Cloud zu konfigurieren.

1. Melden Sie sich bei Ihrem IBM Cloud-Konto als Kontoeigner an, der die IAM-Autorisierung fü IBM Cloud Activity Tracker Event Routing konfigurieren möchte.

2. Erstellen Sie die Datei authorization_policy_resource.json, die Ihre Service-zu-Service-Autorisierung definiert.

   {
       "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"
                   }
               ]
           }
       ]
   }
   

   Dabei gilt:

   CUSTOMER_ACCOUNT_ID ist die Konto-GUID für das Konto, über das Ziele konfiguriert werden. Diese kann mit dem Befehl ibmcloud account list ermittelt werden.

   APPCONFIG_SERVICE_INSTANCE ist die Instanz-ID der Instanz „ IBM Cloud App Configuration “.

3. Rufen Sie ein IAM-Zugriffstoken ab. Weitere Informationen finden Sie unter Abrufen von IAM-Zugriffstokens.

4. Führen Sie den folgenden Befehl aus, um Ihre Service-zu-Service-Autorisierung zu konfigurieren:

   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"
   

Erstellen eines „ IBM Cloud App Configuration “-Ziels über die Befehlszeilenschnittstelle (CLI)

Verwenden Sie diesen Befehl, um ein IBM Cloud App Configuration-Ziel zu erstellen, mit dem ein Ziel für Aktivitätsereignisse konfiguriert werden kann.

 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

Aktualisieren eines „ IBM Cloud App Configuration “-Ziels über die Befehlszeilenschnittstelle (CLI)

Verwenden Sie diesen Befehl, um ein IBM Cloud App Configuration-Ziel für eine IBM Cloud Activity Tracker Event Routing-Region zu aktualisieren. Jeder angegebene Wert, der sich von dem Zeitpunkt, zu dem das Ziel ursprünglich erstellt wurde, unterscheidet, wird auf den im Befehl angegebenen Wert aktualisiert.

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

Ziel über die Befehlszeilenschnittstelle löschen

Verwenden Sie diesen Befehl, um ein Ziel zu löschen.

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.

Ziel über die Befehlszeilenschnittstelle validieren

Verwenden Sie diesen Befehl, um zu prüfen, ob ein Ziel ordnungsgemäß für eine IBM Cloud Activity Tracker Event Routing-Region konfiguriert ist.

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

Informationen zu einem Ziel über die Befehlszeilenschnittstelle abrufen

Verwenden Sie diesen Befehl, um Informationen zu einem Ziel für eine IBM Cloud Activity Tracker Event Routing-Region abzurufen.

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

Alle Ziele in einer Region auflisten

Verwenden Sie diesen Befehl, um die konfigurierten Ziele für eine IBM Cloud Activity Tracker Event Routing-Region aufzulisten.

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-Ziele und -Aktionen

In der folgenden Tabelle sind die Aktionen aufgelistet, die Sie ausführen können, um Ziele zu verwalten:

Sie können private und öffentliche Endpunkte verwenden, um Ziele zu verwalten. Weitere Informationen zu der Liste der verfügbaren ENDPOINTS finden Sie unter Endpunkte.

• Sie können Ziele aus dem privaten Netz mithilfe eines API-Endpunkts im folgenden Format verwalten: https://private.REGION.atracker.cloud.ibm.com

• Sie können Ziele über das öffentliche Netz mithilfe eines API-Endpunkts im folgenden Format verwalten: https://REGION.atracker.cloud.ibm.com

• Sie können die öffentlichen Endpunkte inaktivieren, indem Sie die Kontoeinstellungen aktualisieren. Weitere Informationen finden Sie unter Ziel- und Regionseinstellungen konfigurieren.

Weitere Informationen zu der REST-API finden Sie unter Ziele.

API-Voraussetzungen

Führen Sie die folgenden Schritte aus, um API-Aufrufe zum Verwalten von Zielen zu erstellen:

1. Rufen Sie ein IAM-Zugriffstoken ab. Weitere Informationen finden Sie unter Abrufen von IAM-Zugriffstokens.
2. Ermitteln Sie den API-Endpunkt in der Region, in der Sie ein Ziel konfigurieren oder verwalten möchten. Weitere Informationen finden Sie unter Endpunkte.

Erstellen eines „ IBM Cloud App Configuration “-Ziels mithilfe der API

Mit dem folgenden Befehl cURL können Sie ein IBM Cloud App Configuration-Ziel erstellen:

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"
    }
  }'

Wo

• <ENDPOINT> ist der API-Endpunkt in der Region, in der Sie ein Ziel konfigurieren oder verwalten wollen. Weitere Informationen finden Sie unter Endpunkte.

• TARGET_NAME ist der Name des Ziels. Der Name hat eine maximal zulässige Länge von 256 Zeichen.

  Schließen Sie keine personenbezogenen Daten in Ressourcennamen ein.

• TARGET_TYPE ist der Typ des Ziels.

• app_config_endpoint enthält Informationen zum Ziel.

APPCONFIG_CRN gibt die CRN der „ IBM Cloud App Configuration “-Instanz an.

Sie können zum Beispiel die folgende cURL-Anforderung verwenden, um ein Ziel in Dallas zu erstellen:

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>::"
    }
  }'

In der Antwort erhalten Sie Informationen zu dem Ziel, wie z. B. id, das die GUID des Ziels angibt, und crn, das die CRN des Ziels angibt.

Ein „ IBM Cloud App Configuration “-Ziel über die API aktualisieren

Wenn Sie ein IBM Cloud App Configuration-Ziel aktualisieren, müssen Sie die Zielinformationen im Datenabschnitt der Anfrage angeben.

• Sie müssen alle Felder übergeben.
• Aktualisieren Sie die Felder, die geändert werden müssen.
• Sobald es erstellt wurde, können Sie den Typ (target_type) eines Ziels nicht mehr ändern.

Mit dem folgenden cURL-Befehl können Sie ein Ziel aktualisieren:

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"
    }
  }'

Wo

• <ENDPOINT> ist der API-Endpunkt in der Region, in der Sie ein Ziel konfigurieren oder verwalten wollen. Weitere Informationen finden Sie unter Endpunkte.

• TARGET_ID ist die ID des Ziels.

• TARGET_NAME ist der Name des Ziels. Der Name hat eine maximal zulässige Länge von 256 Zeichen.

  Schließen Sie keine personenbezogenen Daten in Ressourcennamen ein.

• TARGET_TYPE ist der Typ des Ziels. Setzen Sie den Wert für ein „ IBM Cloud App Configuration “-Ziel auf „ app_config “.

• app_config_endpoint enthält Informationen zum Ziel.

APPCONFIG_CRN gibt die CRN der „ IBM Cloud App Configuration “-Instanz an.

Sie können beispielsweise die folgende cURL-Anforderung verwenden, um ein Ziel in der Region 'Dallas' zu aktualisieren:

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>::"
    }
  }'

Ziel mit der API löschen

Mit dem folgenden cURL-Befehl können Sie ein Ziel löschen:

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

Wo

• <ENDPOINT> ist der API-Endpunkt in der Region, in der Sie ein Ziel konfigurieren oder verwalten wollen. Weitere Informationen finden Sie unter Endpunkte.
• <TARGET_ID> ist die ID des Ziels.

Sie können beispielsweise die folgende cURL-Anforderung verwenden, um ein Ziel in der Region 'USA (Süden)' mit der ID 00000000-0000-0000-0000-000000000000 zu löschen:

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"

Wenn der Löschvorgang erfolgreich war, wird als Antwort ein leeres Ergebnis zurückgegeben:

{}

Ziel mit der API validieren

Sie können den folgenden cURL-Befehl verwenden, um ein Ziel zu validieren, indem Sie die Berechtigungsnachweise zum Schreiben in das Ziel überprüfen.

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

Wo

• <ENDPOINT> ist der API-Endpunkt in der Region, in der Sie ein Ziel konfigurieren oder verwalten wollen. Weitere Informationen finden Sie unter Endpunkte.
• <TARGET_ID> ist die ID des Ziels.

Sie können beispielsweise die folgende cURL-Anforderung verwenden, um ein Ziel in der Region 'USA (Süden)' mit der ID 00000000-0000-0000-0000-000000000000 zu validieren:

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"

In der Antwort erhalten Sie Informationen im Abschnitt write_status, zum Beispiel:

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

Ziel über die API anzeigen

Sie können den folgenden cURL-Befehl verwenden, um die Konfigurationsdetails von 1 Ziel anzuzeigen:

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

Wo

• <ENDPOINT> ist der API-Endpunkt in der Region, in der Sie ein Ziel konfigurieren oder verwalten wollen. Weitere Informationen finden Sie unter Endpunkte.
• <TARGET_ID> ist die ID des Ziels.

Sie können beispielsweise die folgende cURL-Anfrage ausführen, um Informationen über ein Ziel mit der ID 00000000-0000-0000-0000-000000000000 abzurufen:

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"

Die Ergebnisse zeigen, ob es sich bei dem Ziel um COS ("target_type": "cloud_object_storage"), das Angebot von IBM Cloud Logs ("target_type": "cloud_logs") oder IBM Cloud App Configuration ("target_type": "app_config") handelt

Alle Ziele über die API auflisten

Sie können den folgenden cURL-Befehl verwenden, um alle Ziele anzuzeigen:

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

Wo

• <ENDPOINT> ist der API-Endpunkt in der Region, in der Sie ein Ziel konfigurieren oder verwalten wollen. Weitere Informationen finden Sie unter Endpunkte.

Sie können beispielsweise die folgende cURL-Anforderung ausführen, um Informationen zu den in der Region 'Dallas' definierten Zielen abzurufen:

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

Die Ergebnisse zeigen, ob es sich bei dem Ziel um COS ("target_type": "cloud_object_storage"), das Angebot von IBM Cloud Logs ("target_type": "cloud_logs") oder IBM Cloud App Configuration ("target_type": "app_config") handelt

HTTP-Antwortcodes

Wenn Sie die IBM Cloud Activity Tracker Event Routing REST-API verwenden, können Sie Standard-HTTP-Antwortcodes abrufen, um anzugeben, ob eine Methode erfolgreich abgeschlossen wurde.

• Eine Antwort von 200 zeigt immer Erfolg an.
• Eine 4xx-Antwort weist auf einen Fehler hin.
• Eine 5xx-Antwort weist normalerweise auf einen internen Systemfehler hin.

In der folgenden Tabelle finden Sie einige HTTP-Antwortcodes: