COS-Ziele verwalten
Sie können „ IBM Cloud Object Storage “ (COS)-Ziele in Ihrem Konto mithilfe der CLI unter IBM Cloud Activity Tracker Event Routing, der REST-API unter IBM Cloud Activity Tracker Event Routing und Terraform-Skripten verwalten. Ein Ziel ist eine Ressource, in der Sie Prüfereignisse sammeln können.
Weitere Informationen zu IBM Cloud Activity Tracker Event Routing-Zielen finden Sie unter Ziele.
Informationen zu COS-Zielen
Wenn Sie ein „ IBM Cloud Object Storage “ (COS)-Ziel verwenden, können Sie denselben COS-Bucket nutzen, um Audit-Ereignisse in Ihrem Konto über mehrere Regionen hinweg zu erfassen. In diesem Szenario werden Ereignisse an die Zielregion weitergeleitet, bevor sie in das COS-Bucket geschrieben werden. Sie können ein Bucket in jeder Region definieren, um die Leistung zu verbessern und die Netzlatenz zu reduzieren.
Wenn Sie ein Ziel in IBM Cloud Object Storage (COS) definieren, beachten Sie die folgenden Informationen:
-
Sie können den Protokollbereich an jeglichem Standort erstellen. Weitere Informationen finden Sie unter Verwalten IBM Cloud Object Storage von (COS)-Protokollbereichen.
-
Für ein Ziel kann nur ein Bucket konfiguriert werden.
-
Wenn Sie regulatorische Anforderungen und Compliance-Anforderungen haben, überprüfen Sie die Standorte, an denen Sie einen Protokollbereich erstellen können. Wenn die Leistung kritisch ist, sollten Sie dann den COS-Protokollbereich in derselben Region erstellen, in der die Prüfereignisse generiert werden.
IAM-Zugriff
Sie müssen Benutzern IAM-Berechtigungen, um Ziele zu verwalten. Weitere Informationen finden Sie unter Zugriff auf Ressourcen zuweisen.
Wenn Sie eine Richtlinie definieren, können Sie den Geltungsbereich der Berechtigungen angeben. Sie können Berechtigungen für eine bestimmte Region oder für das gesamte Konto erteilen.
Wenn Sie über die IAM-Berechtigung zum Erstellen von Richtlinien und Berechtigungen verfügen, können Sie nur die Zugriffsebene gewähren, die Sie als Benutzer des Zieldienstes haben. Wenn Sie beispielsweise über Leserechte für den Zieldienst verfügen, können Sie für die Autorisierung ausschließlich die Rolle „Leser“ zuweisen. Wenn Sie versuchen, eine höhere Berechtigung, wie z. B. Administrator, zuzuweisen, sieht es so aus, als ob die Berechtigung erteilt wird, jedoch wird nur die höchste Berechtigungsstufe, die Sie für den Zieldienst haben, d. h. Viewer, zugewiesen.
Benutzer mit regionalem Zugriffsbereich können nur auf Ziele in ihrer autorisierten Region zugreifen.
| IAM-AKTION | Geltungsbereich der IAM-Richtlinie | IAM-Rollen | Beschreibung |
|---|---|---|---|
atracker.target.read |
Bereich | AdministratorEditorViewerOperator |
Informationen zu einem Ziel lesen (anzeigen) |
atracker.target.create |
Bereich | AdministratorEditor |
Ziel erstellen |
atracker.target.update |
Bereich | AdministratorEditor |
Ziel aktualisieren |
atracker.target.delete |
Bereich | AdministratorEditor |
Ziel löschen |
atracker.target.list |
Konto | AdministratorEditorViewerOperator |
Alle Ziele auflisten |
Authentifizierungsoptionen
Beim Schreiben in ein COS-Ziel können Sie die folgenden Optionen verwenden, um sich bei einem IBM Cloud Object Storage (COS)-Bucket zu authentifizieren:
- Durch Konfiguration der Autorisierung „serviconfigre-to-service“ ( S2S ) (empfohlen).
- Durch die Bereitstellung eines API-Schlüssels beim Konfigurieren des Ziels.
Sie können die Service-zu-Service-Autorisierung für Ihr COS-Bucket konfigurieren, sodass Sie keine API-Schlüssel übergeben müssen, wenn Sie Ihre verschlüsselten Daten in das COS-Bucket schreiben.
CLI-Voraussetzungen
Bevor Sie die Befehlszeilenschnittstelle zum Verwalten von Zielen verwenden, führen Sie die folgenden Schritte aus:
-
Installieren Sie die IBM Cloud Activity Tracker Event Routing CLI.
-
Melden Sie sich bei IBM Cloud an. Führen Sie den folgenden Befehl aus: ibmcloud login
API-Schlüssel für COS-Bucket abrufen
Informationen zum Abrufen des API-Schlüssels für das COS-Bucket finden Sie unter API-Schlüssel für den Zugriff auf ein Bucket generieren.
Konfiguration 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.
-
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.
-
Klicken Sie auf „Verwalten“ > Zugriff (IAM). „ Zugriff und Benutzer verwalten “ wird angezeigt.
-
Klicken Sie auf Autorisierungen.
-
Klicken Sie auf Erstellen.
-
Wählen Sie unter „Quelldienst“ Activity Tracker und wählen Sie unter „Wie möchten Sie den Zugriff einschränken?“ die Option „Alle Ressourcen “ aus.
-
Wählen Sie für Zielservice die Option Cloud Object Storage und für Wie möchten Sie den Zugriff festlegen? die Option Ressourcen basierend auf ausgewählten Attributen aus.
-
Wählen Sie Serviceinstanz aus und geben Sie für Zeichenfolge gleich den Namen Ihrer COS-Instanz an.
-
Wählen Sie für Servicezugriff die Option Objektschreibberechtigter aus.
-
Klicken Sie auf Autorisieren. Ihre neue Service-zu-Service-Autorisierung wird in der Ansicht Berechtigungen verwalten aufgelistet.
Die Autorisierung für die IBM Cloud Object Storage-Instanz kann nur über die Benutzerschnittstelle erfolgen. Wenn Sie die Autorisierung auf ein bestimmtes IBM Cloud Object Storage-Bucket beschränken wollen, müssen Sie die Autorisierung mithilfe der API konfigurieren.
Konfiguration 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.
-
[Melden Sie sich bei Ihrem IBM Cloud-Konto] (/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_login) als Kontoeigner an, der die IBM Cloud Activity Tracker Event Routing-Autorisierung konfigurieren soll.
-
Erstellen Sie eine Autorisierungsrichtlinie, die Ihre Service-zu-Service-Autorisierung definiert.
ibmcloud iam authorization-policy-create atracker cloud-object-storage "Object Writer" [--target-service-instance-id <COS_SERVICE_INSTANCE>Dabei gilt:
COS_SERVICE_INSTANCEist der CRN der Bucketinstanz der zu autorisierenden COS-Instanz.
Konfiguration 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.
-
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.
-
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:ObjectWriter" } ], "resources": [ { "attributes": [ { "name": "accountId", "value": "CUSTOMER_ACCOUNT_ID" }, { "name": "serviceName", "value": "cloud-object-storage" }, { "name": "serviceInstance", "value": "COS_SERVICE_INSTANCE" } ] } ] }Dabei gilt:
CUSTOMER_ACCOUNT_IDist die Konto-GUID für das Konto, über das Ziele konfiguriert werden. Diese kann mit dem Befehlibmcloud account listermittelt werden.COS_SERVICE_INSTANCEist der CRN der Bucketinstanz der zu autorisierenden COS-Instanz. -
Rufen Sie ein IAM-Zugriffstoken ab. Weitere Informationen finden Sie unter Abrufen von IAM-Zugriffstokens.
-
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"
COS-Ziel über die Befehlszeilenschnittstelle erstellen
Verwenden Sie diesen Befehl, um ein IBM Cloud Object Storage-Ziel zu erstellen, das zum Konfigurieren eines Ziels für Aktivitätsereignisse verwendet werden soll.
ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file COS_ENDPOINT_DEFINITION_JSON_FILE] | ( [--endpoint COS_ENDPOINT] [--bucket COS_BUCKET] [--target-crn COS_TARGET_CRN] ( [--api-key ( COS_API_KEY | @COS_API_KEY_FILE )] | [--service-to-service-enabled ( TRUE | FALSE )] ) ) ) [--region REGION] [--output FORMAT]
Befehlsoptionen
--region REGION|-r REGION-
Name der Region, z. B.
us-southodereu-gb. Wenn nicht angegeben, wird die Region verwendet, die protokolliert oder als Ziel verwendet wird. --name TARGET_NAME-
Der Name, der für das Ziel angegeben werden soll.
Schließen Sie keine personenbezogenen Daten in Ressourcennamen ein.
--type TARGET_TYPE-
Setzen Sie den Zieltyp (
TARGET_TYPE) für ein COS-Ziel aufcloud_object_storage. --file @COS_ENDPOINT_DEFINITION_JSON_FILE-
Eine Datei, die eine Endpunktdefinition im folgenden Format enthält:
{ "endpoint": "aaaaa", "target_crn": "yyyyy", "bucket": "zzzzzz", "api_key": "xxxxxx" } --endpoint COS_ENDPOINT-
Der IBM Cloud Object Storage Endpunkt, der dem IBM Cloud Object Storage-Protokollbereich zugeordnet werden soll.
--bucket BUCKET-
Der Name des IBM Cloud Object Storage Protokollbereichs, der dem Ziel zugeordnet werden soll.
--target-crn COS_TARGET_CRN-
Die CRN der IBM Cloud Object Storage-Instanz.
--api-key COS_API_KEY|@COS_API_KEY_FILE-
Der Wert für Ihren API-Schlüssel oder eine Referenz auf die API-Schlüsseldatei, die für den Zugriff verwendet wird. Beispiel:
ibmcloud login --apikey $KEYFILE --service-to-service-enabled-
Gibt an, ob die Service-zu-Service-Autorisierung für das Bucket aktiviert wurde. Geben Sie
TRUEan, wenn die Service-zu-Service-Autorisierung aktiviert ist, undFALSE, wenn die Service-zu-Service-Autorisierung nicht aktiviert ist. Standardmäßig istservice_to_service_enabledaufFALSEfestgelegt. --output FORMAT-
Das derzeit unterstützte Format ist JSON. Falls angegeben, wird die Ausgabe im JSON-Format zurückgegeben. Wenn
JSONnicht angegeben ist, wird die Ausgabe in einem Tabellenformat zurückgegeben. help|--help|-h-
Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.
Beispiel
Im Folgenden sehen Sie ein Beispiel für die Verwendung des Befehls ibmcloud atracker target create --name my-target --type cloud_object_storage --endpoint s3.us-west.cloud-object-storage.appdomain.cloud --bucket cloud-object-storage-my-cos --target-crn crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:: --api-key yyyyyyyyyyyyyyyyyyyyyyyyyyyyy.
Dieses Beispiel zeigt ein Beispiel für eine erfolgreiche Zielerstellung.
Target
Name: my-target
ID: 000000000-00000000-0000-0000-00000000
CRN: crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type: cloud_object_storage
COS Endpoint: s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN: crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket: cloud-object-my-target
Service to Service Enabled: true
Write Status: success
Created: 2021-07-21T16:04:15.174Z
Updated: 2021-07-21T16:04:15.174Z
COS-Ziel über die Befehlszeilenschnittstelle aktualisieren
Mit diesem Befehl können Sie ein COS-Ziel für eine IBM Cloud Activity Tracker Event Routing-Region 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 COS_ENDPOINT_DEFINITION_JSON_FILE] | ( [--endpoint COS_ENDPOINT] [--bucket COS_BUCKET] [--target-crn COS_TARGET_CRN] ( [--api-key ( COS_API_KEY | @COS_API_KEY_FILE )] | [--service-to-service-enabled ( TRUE | FALSE )]))] [--output FORMAT]
Befehlsoptionen
--target TARGET-
Die ID oder der aktuelle Zielname.
--region REGION|-r REGION-
Name der Region, z. B.
us-southodereu-gb. Wenn nicht angegeben, wird die Region verwendet, die protokolliert oder als Ziel verwendet wird. --name TARGET_NAME-
Der Name, der für das Ziel angegeben werden soll.
Schließen Sie keine personenbezogenen Daten in Ressourcennamen ein.
--file @COS_ENDPOINT_DEFINITION_JSON_FILE-
Eine Datei, die eine Endpunktdefinition im folgenden Format enthält:
{ "endpoint": "aaaaa", "target_crn": "yyyyy", "bucket": "zzzzzz", "api_key": "xxxxxx" }oder für ein Szenario, bei dem die Service-zu-Service-Authentifizierung aktiviert ist:
{ "endpoint": "aaaaa", "target_crn": "yyyyy", "bucket": "zzzzzz", "service_to_service_enabled": true } --endpoint COS_ENDPOINT-
Der IBM Cloud Object Storage Endpunkt, der dem IBM Cloud Object Storage-Protokollbereich zugeordnet werden soll.
--bucket COS_BUCKET-
Der Name des IBM Cloud Object Storage Protokollbereichs, der dem Ziel zugeordnet werden soll.
--target-crn COS_TARGET_CRN-
Die CRN der IBM Cloud Object Storage-Instanz.
--api-key COS_API_KEY|@COS_API_KEY_FILE-
Der Wert für Ihren API-Schlüssel oder eine Referenz auf die API-Schlüsseldatei, die für den Zugriff verwendet wird. Beispiel:
ibmcloud login --apikey $KEYFILE --service-to-service-enabled (TRUE | FALSE)-
Gibt an, ob die Service-zu-Service-Autorisierung für das Bucket aktiviert wurde. Geben Sie
TRUEan, wenn die Service-zu-Service-Autorisierung aktiviert ist, undFALSE, wenn die Service-zu-Service-Autorisierung nicht aktiviert ist. Die Service-zu-Service-Autorisierung ist standardmäßig aufFALSEgesetzt. --output FORMAT-
Das derzeit unterstützte Format ist JSON. Falls angegeben, wird die Ausgabe im JSON-Format zurückgegeben. Wenn
JSONnicht angegeben ist, wird die Ausgabe in einem Tabellenformat zurückgegeben. help|--help|-h-
Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.
Beispiel
Im Folgenden sehen Sie ein Beispiel für die Verwendung des Befehls ibmcloud atracker target update --target my-target --name new-target-name.
Target
Name: new-target-name
ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN: crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type: cloud_object_storage
COS Endpoint: s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN: crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket: cloud-object-my-target
Service to Service Enabled: true
Write Status: success
Created: 2021-07-21T16:04:15.174Z
Updated: 2021-07-21T17:49:56.452Z
Ziel über die Befehlszeilenschnittstelle löschen
Verwenden Sie diesen Befehl, um ein Ziel zu löschen.
ibmcloud atracker target rm --target TARGET [--force]
Befehlsoptionen
--target TARGET- Die ID oder der Name des Ziels.
--force|-f- Das Ziel wird gelöscht, ohne dass dem Benutzer eine zusätzliche Eingabeaufforderung zur Verfügung gestellt wird.
help|--help|-h- Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.
Beispiel
Im Folgenden sehen Sie ein Beispiel für die Verwendung des Befehls ibmcloud atracker target rm --target xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
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.
Im Folgenden sehen Sie ein Beispiel für die Verwendung des Befehls ibmcloud atracker target rm --target xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -force.
Dieses Beispiel zeigt einen fehlgeschlagenen Befehl, bei dem das angegebene Ziel nicht gefunden werden konnte.
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]
Befehlsoptionen
--target TARGET- Die ID oder der Name des Ziels.
--region REGION|-r REGION- Name der Region, z. B.
us-southodereu-gb. Wenn nicht angegeben, wird die Region verwendet, die protokolliert oder als Ziel verwendet wird. --output FORMAT- Das derzeit unterstützte Format ist JSON. Falls angegeben, wird die Ausgabe im JSON-Format zurückgegeben. Wenn
JSONnicht angegeben ist, wird die Ausgabe in einem Tabellenformat zurückgegeben. help|--help|-h- Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.
Beispiel
Im Folgenden sehen Sie ein Beispiel für die Verwendung des Befehls ibmcloud atracker target validate --target new-target-name.
Dieses Beispiel zeigt ein erfolgreich validiertes COS-Ziel.
Target
Name: new-target-name
ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN: crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type: cloud_object_storage
COS Endpoint: s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN: crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket: cloud-object-my-target
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]
Befehlsoptionen
--target TARGET- Die ID oder der Name des Ziels.
--output FORMAT- Das derzeit unterstützte Format ist JSON. Falls angegeben, wird die Ausgabe im JSON-Format zurückgegeben. Wenn
JSONnicht angegeben ist, wird die Ausgabe in einem Tabellenformat zurückgegeben. help|--help|-h- Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.
Beispiel
Das folgende Beispiel zeigt die Verwendung des Befehls ibmcloud atracker target get --target new-target-name mit einem COS-Ziel.
Target
Name: new-target-name
ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN: crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type: cloud_object_storage
COS Endpoint: s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN: crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket: cloud-object-my-target
Service to Service Enabled: true
Write Status: success
Created: 2021-07-21T16:04:15.174Z
Updated: 2021-07-21T17: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]
Befehlsoptionen
--output FORMAT- Das derzeit unterstützte Format ist JSON. Falls angegeben, wird die Ausgabe im JSON-Format zurückgegeben. Wenn
JSONnicht angegeben ist, wird die Ausgabe in einem Tabellenformat zurückgegeben. help|--help|-h- Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.
Beispiel
Im Folgenden sehen Sie ein Beispiel für die Verwendung des Befehls ibmcloud atracker target ls.
Name ID Region Type Service to Service Enabled Created
target-01 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx us-south cloud_object_storage true 2020-11-18T03:52:08.603Z
target-02 yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy us-south cloud_object_storage true 2020-11-18T03:52:01.592Z
target-02-backup zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz us-east cloud_object_storage false 2021-02-26T06:53:13.466Z
API-Ziele und -Aktionen
In der folgenden Tabelle sind die Aktionen aufgelistet, die Sie ausführen können, um Ziele zu verwalten:
| Aktion | REST-API-Methode | API_URL |
|---|---|---|
| Ziel erstellen | POST |
<ENDPOINT>/api/v2/targets |
| Ziel aktualisieren | PUT |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| Ziel löschen | DELETE |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| Ziel lesen | GET |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| Alle Ziele auflisten | GET |
<ENDPOINT>/api/v2/targets |
| Ziel validieren | POST |
<ENDPOINT>/api/v2/targets/{id}/validate |
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:
- Rufen Sie ein IAM-Zugriffstoken ab. Weitere Informationen finden Sie unter Abrufen von IAM-Zugriffstokens.
- Ermitteln Sie den API-Endpunkt in der Region, in der Sie ein Ziel konfigurieren oder verwalten möchten. Weitere Informationen finden Sie unter Endpunkte.
COS-Ziel über die API erstellen
Mit dem folgenden cURL-Befehl können Sie ein IBM Cloud Object Storage-Ziel (COS) erstellen:
curl -X POST <ENDPOINT>/api/v2/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
"name": "TARGET_NAME",
"target_type": "cloud_object_storage",
"cos_endpoint": {
"endpoint": "PRIVATE_COS_ENDPOINT",
"target_crn": "COS_CRN",
"bucket": "BUCKET_NAME",
"api_key": "API_KEY",
"service_to_service_enabled": SERVICE_TO_SERVICE
}
}'
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_NAMEist 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_TYPEist der Typ des Ziels. Der gültige Typ istcloud_object_storage. -
cos_endpointenthält Informationen zum Ziel. Weitere Informationen zum Abrufen der Protokollbereichdetails finden Sie unter Details zu den Protokollbereichkonfigurationen abrufen.
PRIVATE_COS_ENDPOINT gibt den IBM Cloud Activity Tracker Event Routing-Endpunkt für die Suche nach diesem Bucket an. Verwenden Sie den privaten Endpunkt.
COS_CRN gibt den CRN der COS-Instanz an, in der Sie das Bucket bereitgestellt haben.
BUCKET_NAME gibt den Namen des Buckets an.
API_KEY enthält den API-Schlüssel, der Berechtigungen zum Hochladen von Objekten in das Bucket umfasst. Dieser Wert wird ignoriert, wenn service_to_service_enabled auf true gesetzt ist.
SERVICE_TO_SERVICE gibt an, ob die Service-zu-Service-Autorisierung für das Bucket aktiviert wurde. Geben Sie true an,
wenn die Service-zu-Service-Autorisierung aktiviert ist, und false, wenn die Service-zu-Service-Autorisierung nicht aktiviert ist. Die Service-zu-Service-Autorisierung ist standardmäßig auf false gesetzt.
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 COS target",
"target_type": "cloud_object_storage",
"cos_endpoint": {
"endpoint": "s3.private.us-south.cloud-object-storage.appdomain.cloud",
"target_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/<account-id>:<instance-id>::",
"bucket": "my-activity-tracking-bucket",
"api_key": "xxxxxxxxxxxxxxxxxx",
"service_to_service_enabled": false
}
}'
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.
COS-Ziel über die API aktualisieren
Wenn Sie ein IBM Cloud Object Storage (COS)-Ziel aktualisieren, müssen die Zielinformationen im Datenabschnitt der Anforderung enthalten sein.
- 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": "TARGET_TYPE",
"cos_endpoint": {
"endpoint": "PRIVATE_COS_ENDPOINT",
"target_crn": "COS_CRN",
"bucket": "BUCKET_NAME",
"api_key": "API_KEY",
"service_to_service_enabled": SERVICE_TO_SERVICE
}
}'
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_IDist die ID des Ziels. -
TARGET_NAMEist 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_TYPEist der Typ des Ziels. Setzen Sie den Wert für ein COS-Ziel aufcloud_object_storage. -
cos_endpointenthält Informationen zum Ziel. Weitere Informationen zum Abrufen der Protokollbereichdetails finden Sie unter Details zu den Protokollbereichkonfigurationen abrufen.
PRIVATE_COS_ENDPOINT gibt den IBM Cloud Activity Tracker Event Routing-Endpunkt für die Suche nach diesem Bucket an. Verwenden Sie den privaten Endpunkt.
COS_CRN gibt den CRN der COS-Instanz an, in der Sie das Bucket bereitgestellt haben.
BUCKET_NAME gibt den Namen des Buckets an.
API_KEY enthält den API-Schlüssel, der Berechtigungen zum Hochladen von Objekten in das Bucket umfasst. Dieser Wert wird ignoriert, wenn service_to_service_enabled auf true gesetzt ist.
SERVICE_TO_SERVICE gibt an, ob die Service-zu-Service-Autorisierung für das Bucket aktiviert wurde. Geben Sie true an,
wenn die Service-zu-Service-Autorisierung aktiviert ist, und false, wenn die Service-zu-Service-Autorisierung nicht aktiviert ist. Die Service-zu-Service-Autorisierung ist standardmäßig auf false gesetzt.
Sie können zum Beispiel die folgende cURL-Anforderung verwenden, um ein Ziel in Dallas zu erstellen:
curl -X PUT https://private.us-south.atracker.cloud.ibm.com/api/v2/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
"name": "My COS target",
"target_type": "cloud_object_storage",
"cos_endpoint": {
"endpoint": "s3.private.us-south.cloud-object-storage.appdomain.cloud",
"target_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/<account-id>:<instance-id>::",
"bucket": "my-activity-tracking-bucket",
"service_to_service_enabled": true
}
}'
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 in dem Abschnitt cos_write_status, z. B.:
"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 das Ziel COS ist ("target_type": "cloud_object_storage").
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 der Zielscheibe um eine COS-Zielscheibe ("target_type": "cloud_object_storage") 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:
| Statuscode | Status | Beschreibung |
|---|---|---|
200 |
OK | Die Anforderung war erfolgreich. |
201 |
OK | Die Anforderung war erfolgreich. Eine Ressource wird erstellt. |
400 |
Ungültige Anforderung | Die Anforderung war nicht erfolgreich. Möglicherweise fehlt ein Parameter, der erforderlich ist. |
401 |
Nicht berechtigt | Das IAM-Token, das in der API-Anforderung verwendet wird, ist ungültig oder abgelaufen. |
403 |
Nicht zulässig | Die Operation ist aufgrund unzureichender Berechtigungen nicht zulässig. |
404 |
Nicht gefunden | Die angeforderte Ressource ist nicht vorhanden oder wurde bereits gelöscht. |
429 |
Zu viele Anforderungen | Zu viele Anforderungen haben die API zu schnell getroffen. |
500 |
Interner Serverfehler | In der IBM Cloud Activity Tracker Event Routing Verarbeitung ist etwas schief gelaufen. |
IBM Cloud Object Storage-Ziel über die Benutzerschnittstelle erstellen
Nur Ressourcen in Ihrem Konto werden aufgelistet und können ausgewählt werden. Um eine Ressource in einem anderen Account anzugeben, wählen Sie CRN angeben unter Ziel auswählen aus.
- Melden Sie sich bei Ihrem IBM Cloud-Konto an.
- Klicken Sie auf das Menüsymbol
> Beobachtbarkeit.
- Wählen Sie „ Aktivitätsaufzeichnung “ aus.
- Klicken Sie auf Erstellen, um die Erstellungsanzeige zu öffnen.
- Typ auswählen: Klicken Sie auf Object Storage.
- Serviceautorisierung erforderlich: Die Serviceautorisierung ist erforderlich, damit IBM Cloud Activity Tracker Event Routing mit IBM Cloud Object Storagekommunizieren kann. Klicken Sie auf Jetzt autorisieren, um die Richtlinie automatisch zu erstellen oder auf Zugriff in IAM erteilen.
- Ziel auswählen: Wählen Sie Nach Instanz suchen oder CRN angeben aus.
- Nach Instanz suchen: Wählen Sie eine IBM Cloud Object Storage-Instanz in der Tabelle aus oder klicken Sie auf Erstellen, um eine neue IBM Cloud Object Storage-Instanz zu erstellen. Wählen Sie nach der Auswahl einer Instanz ein IBM Cloud Object Storage-Bucket aus.
- CRN angeben: Geben Sie den Cloudressourcennamen (CRN) des Buckets IBM Cloud Object Storage ein. Dadurch können Sie einen CRN aus einem anderen Konto eingeben.
- Bucketendpunkt: Verwenden Sie den Standardbucketendpunkt oder ändern Sie ihn.
- Zielname: Geben Sie einen aussagekräftigen Namen für das Ziel ein.
- Zielregion: Wählen Sie die Region aus, die die Ereignisdaten verarbeiten soll.
- Aktivieren Sie die Option Als Standardziel festlegen, um Ihr neues Ziel automatisch als Standardziel in Ihren IBM Cloud Activity Tracker Event Routing-Einstellungen festzulegen. Weitere Informationen finden Sie in der Dokumentation zu Standardzielen.
- Klicken Sie auf Ziel erstellen.
IBM Cloud Object Storage-Ziel über die Benutzerschnittstelle aktualisieren
Nur Ressourcen in Ihrem Konto werden aufgelistet und können ausgewählt werden. Um eine Ressource in einem anderen Account anzugeben, wählen Sie CRN angeben unter Ziel auswählen aus.
- Melden Sie sich bei Ihrem IBM Cloud-Konto an.
- Klicken Sie auf das Menüsymbol
> Beobachtbarkeit.
- Wählen Sie „ Aktivitätsaufzeichnung “ aus.
- Wählen Sie das zu aktualisierende Ziel aus und klicken Sie auf das
“.
- Klicken Sie auf Festlegung als Standard aufheben, wenn Sie Ihr Ziel als Standardziel in Ihren IBM Cloud Activity Tracker Event Routing-Einstellungen entfernen wollen. Weitere Informationen finden Sie in der Dokumentation zu Standardzielen.
- Klicken Sie auf Bearbeiten, um die Aktualisierungsanzeige zu öffnen.
- Details: Auf Bearbeiten klicken, um den Namen oder die Region Ihres Ziels zu aktualisieren. Sie können auch die Option Standardziel umschalten, um Ihr Ziel als Standardziel in Ihren IBM Cloud Activity Tracker Event Routing-Einstellungen hinzuzufügen oder zu entfernen.
- Klicken Sie auf Speichern, um Ihr Ziel zu aktualisieren.
- Ziel: Klicken Sie auf Bearbeiten, wenn Sie die IBM Cloud Object Storage-Instanz oder Buckets ändern möchten, die Ihrem Ziel zugeordnet sind.
- Klicken Sie auf Speichern, um Ihr Ziel zu aktualisieren.
Ein Ziel über die Benutzeroberfläche löschen
Ein „ IBM Cloud Activity Tracker Event Routing “-Ziel kann nicht gelöscht werden, wenn es in einer Route oder als Standardziel verwendet wird.
- Melden Sie sich bei Ihrem IBM Cloud-Konto an.
- Klicken Sie auf das Menüsymbol
> Beobachtbarkeit.
- Wählen Sie „ Aktivitätsaufzeichnung “ aus.
- Legen Sie fest, welches Ziel gelöscht werden soll, und klicken Sie auf das Symbol
.
- Klicken Sie auf Löschen und anschließend in der Bestätigungsanzeige auf Löschen.
Alle Ziele in einer Region über die Benutzeroberfläche auflisten
- Melden Sie sich bei Ihrem IBM Cloud-Konto an.
- Klicken Sie auf das Menüsymbol
> Beobachtbarkeit.
- Wählen Sie „ Aktivitätsaufzeichnung “ aus.
In der Tabelle sind die Details zu den Zielen aufgeführt:
- Zieltyp
- Zielname
- Zielregion
- Routen: Bei Verwendung in Routen
- Zielstatus:
- Aktiv: Das Ziel funktioniert wie erwartet.
- Fehler: Das Ziel ist fehlerhaft konfiguriert und Ereignisse werden nicht an das Ziel weitergeleitet. Aktualisieren Sie die Zieldetails oder das Ziel, um die Zielkonfiguration zu korrigieren, oder löschen Sie das Ziel, wenn es nicht mehr benötigt wird