Gestione degli obiettivi COS
È possibile gestire le destinazioni COS ( IBM Cloud Object Storage ) nel proprio account utilizzando la CLI di IBM Cloud Activity Tracker Event Routing, l'API REST di IBM Cloud Activity Tracker Event Routing e gli script Terraform. Un target è una risorsa in cui è possibile raccogliere eventi di auditing.
Per maggiori informazioni sugli obiettivi IBM Cloud Activity Tracker Event Routing, vedere Obiettivi.
Informazioni sugli obiettivi COS
Se si utilizza un target COS ( IBM Cloud Object Storage ), è possibile utilizzare lo stesso bucket COS per raccogliere gli eventi di auditing nel proprio account in più regioni. In questo scenario gli eventi vengono inoltrati alla regione di destinazione prima di essere scritti nel bucket COS. Per migliorare le prestazioni e ridurre la latenza della rete, potresti valutare di definire un bucket in ogni regione.
Quando si definisce un target in IBM Cloud Object Storage (COS), tenere in considerazione le seguenti informazioni:
-
Puoi creare il bucket in qualsiasi posizione. Per ulteriori informazioni, vedere Gestione dei bucket IBM Cloud Object Storage(COS).
-
È possibile configurare solo 1 bucket per destinazione.
-
Se hai requisiti normativi e di conformità, controlla le posizioni in cui puoi creare un bucket. Quindi, se le prestazioni sono fondamentali, si può prendere in considerazione la possibilità di creare il bucket COS nella stessa regione in cui vengono generati gli eventi di controllo.
Accesso IAM
È necessario concedere agli utenti le autorizzazioni IAM per gestire le destinazioni. Per ulteriori informazioni, vedere Assegnare l'accesso alle risorse.
Quando si definisce una policy, è possibile indicare l'ambito delle autorizzazioni. Puoi scegliere di concedere le autorizzazioni per una regione specifica o per l'intero account.
Se disponi dell'autorizzazione IAM per creare policy e autorizzazioni, puoi concedere solo il livello di accesso di cui disponi come utente del servizio di destinazione. Ad esempio, se si dispone dell'accesso come visualizzatore per il servizio di destinazione, è possibile assegnare solo il ruolo di visualizzatore ai fini dell'autorizzazione. Se si tenta di assegnare un'autorizzazione superiore, ad esempio amministratore, potrebbe sembrare che l'autorizzazione sia concessa, tuttavia verrà assegnata solo l'autorizzazione di livello più alto disponibile per il servizio di destinazione, ovvero visualizzatore.
Gli utenti con ambito regionale potranno accedere solo agli obiettivi nella loro regione autorizzata.
| Azione IAM | Ambito della politica IAM | Ruoli IAM | Descrizione |
|---|---|---|---|
atracker.target.read |
Regione | AdministratorEditorViewerOperator |
Leggi (visualizza) informazioni su un target |
atracker.target.create |
Regione | AdministratorEditor |
Crea un obiettivo |
atracker.target.update |
Regione | AdministratorEditor |
Aggiorna un obiettivo |
atracker.target.delete |
Regione | AdministratorEditor |
Elimina un obiettivo |
atracker.target.list |
Account | AdministratorEditorViewerOperator |
Elenca tutti gli obiettivi |
Opzioni di autenticazione
Quando si scrive su una destinazione COS, è possibile utilizzare le seguenti opzioni per autenticarsi in un bucket IBM Cloud Object Storage (COS).
- Configurando l'autorizzazione serviconfigre-to-service ( S2S ) (consigliato).
- Fornendo una chiave API durante la configurazione della destinazione.
Puoi configurare l'autorizzazione da servizio a servizio nel tuo bucket COS in modo da non dover passare una chiave API quando scrivi i tuoi dati crittografati nel bucket COS.
Prerequisiti CLI
Prima di utilizzare la CLI per gestire le destinazioni, completare i seguenti passaggi:
-
Installa la CLI IBM Cloud Activity Tracker Event Routing.
-
Accedi a IBM Cloud. Esegui il seguente comando: ibmcloud login
Ottenere la chiave API del bucket COS
Per informazioni su come ottenere la chiave API del bucket COS, vedere Generazione di una chiave API per accedere a un bucket.
Configurazione dell'autorizzazione S2S tramite l'interfaccia utente nello stesso account
Per configurare un'autorizzazione da servizio a servizio utilizzando l'interfaccia utente di IBM Cloud procedere come segue.
-
Accedi al tuo account IBM Cloud come proprietario dell'account che configurerà i target IBM Cloud Activity Tracker Event Routing.
Dopo che hai eseguito l'accesso con il tuo ID utente e la tua password, viene aperto il dashboard IBM Cloud.
-
Fai clic su Gestisci > Access (IAM). Viene visualizzata la schermata " Gestisci accessi e utenti ".
-
Fare clic su Autorizzazioni.
-
Fai clic su Crea.
-
Per il servizio Origine seleziona Activity Tracker e per Come desideri definire l'ambito dell'accesso? seleziona Tutte le risorse.
-
Per il servizio di destinazione seleziona Cloud Object Storage Per Come desideri definire l'ambito dell'accesso? seleziona Risorse in base agli attributi selezionati.
-
Seleziona l'istanza del servizio e la stringa corrisponde al nome della tua istanza COS.
-
Per l'accesso al servizio selezionare Scrittore oggetto.
-
Fai clic su Autorizza. La nuova autorizzazione da servizio a servizio verrà elencata nella vista Gestisci autorizzazioni.
Potrai effettuare l'autorizzazione all'istanza di IBM Cloud Object Storage solo tramite l'interfaccia utente. Se desideri limitare l'autorizzazione a un bucket specifico di IBM Cloud Object Storage, devi configurare l'autorizzazione tramite l'API.
Configurazione dell'autorizzazione S2S tramite CLI
Per configurare un'autorizzazione da servizio a servizio utilizzando la CLI IBM Cloud procedere come segue.
-
Accedi al tuo account IBM Cloud come proprietario dell'account che configurerà l'autorizzazione IBM Cloud Activity Tracker Event Routing.
-
Crea una policy di autorizzazione che definisca l'autorizzazione da servizio a servizio.
ibmcloud iam authorization-policy-create atracker cloud-object-storage "Object Writer" [--target-service-instance-id <COS_SERVICE_INSTANCE>Dove:
COS_SERVICE_INSTANCEè il CRN dell'istanza bucket dell'istanza COS da autorizzare.
Configurazione dell'autorizzazione S2S tramite API
Per configurare un'autorizzazione da servizio a servizio utilizzando l'API IBM Cloud, procedere come segue.
-
Accedi al tuo account IBM Cloud come proprietario dell'account che configurerà l'autorizzazione IAM IBM Cloud Activity Tracker Event Routing.
-
Crea un file
authorization_policy_resource.jsonche definisca l'autorizzazione da servizio a servizio.{ "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" } ] } ] }Dove:
CUSTOMER_ACCOUNT_IDè il GUID dell'account che configurerà i target. Per scoprirlo, utilizzare il comandoibmcloud account list.COS_SERVICE_INSTANCEè il CRN dell'istanza bucket dell'istanza COS da autorizzare. -
Ottenere un token di accesso IAM. Per ulteriori informazioni, vedere Recupero dei token di accesso IAM.
-
Eseguire il seguente comando per configurare l'autorizzazione da servizio a servizio:
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"
Creazione di un target COS tramite CLI
Utilizzare questo comando per creare un target IBM Cloud Object Storage da utilizzare per configurare una destinazione per gli eventi di attività.
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]
Opzioni comando
--region REGION|-r REGION-
Nome della regione, ad esempio
us-southoeu-gb. Se non specificato, verrà utilizzata la regione in cui si è effettuato l'accesso o quella di destinazione. --name TARGET_NAME-
Il nome da dare al bersaglio.
Non includere alcuna informazione di identificazione personale (PII) nei nomi delle risorse.
--type TARGET_TYPE-
Impostare
TARGET_TYPEsucloud_object_storageper un target COS. --file @COS_ENDPOINT_DEFINITION_JSON_FILE-
Un file contenente una definizione di endpoint nel seguente formato:
{ "endpoint": "aaaaa", "target_crn": "yyyyy", "bucket": "zzzzzz", "api_key": "xxxxxx" } --endpoint COS_ENDPOINT-
L'endpoint IBM Cloud Object Storage da associare al bucket IBM Cloud Object Storage.
--bucket BUCKET-
Nome del bucket IBM Cloud Object Storage da associare alla destinazione.
--target-crn COS_TARGET_CRN-
CRN dell'istanza di IBM Cloud Object Storage.
--api-key COS_API_KEY|@COS_API_KEY_FILE-
Il valore della chiave API o un riferimento al file della chiave API utilizzato per ottenere l'accesso. Ad esempio,
ibmcloud login --apikey $KEYFILE --service-to-service-enabled-
Indica se l'autorizzazione da servizio a servizio è stata abilitata per il bucket. Specificare
TRUEse l'autorizzazione da servizio a servizio è abilitata eFALSEse l'autorizzazione da servizio a servizio non è abilitata. Per impostazione predefinita, l'indirizzoservice_to_service_enabledèFALSE. --output FORMAT-
Il formato attualmente supportato è JSON. Se specificato, l'output verrà restituito in formato JSON. Se non viene specificato
JSON, l'output verrà restituito in formato tabellare. help|--help|-h-
Elenca le opzioni disponibili per il comando.
Esempio
Di seguito è riportato un esempio che utilizza il comando 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.
Questo esempio mostra un esempio di creazione di un target riuscita.
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
Aggiornamento di un target COS tramite CLI
Utilizzare questo comando per aggiornare un target COS per una regione IBM Cloud Activity Tracker Event Routing. Qualsiasi valore specificato diverso da quello impostato al momento della creazione originale della destinazione verrà aggiornato al valore specificato nel comando.
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]
Opzioni comando
--target TARGET-
ID o nome della destinazione corrente.
--region REGION|-r REGION-
Nome della regione, ad esempio
us-southoeu-gb. Se non specificato, verrà utilizzata la regione in cui si è effettuato l'accesso o quella di destinazione. --name TARGET_NAME-
Il nome da dare al bersaglio.
Non includere alcuna informazione di identificazione personale (PII) nei nomi delle risorse.
--file @COS_ENDPOINT_DEFINITION_JSON_FILE-
Un file contenente una definizione di endpoint nel seguente formato:
{ "endpoint": "aaaaa", "target_crn": "yyyyy", "bucket": "zzzzzz", "api_key": "xxxxxx" }o per uno scenario in cui è abilitata l'autenticazione da servizio a servizio:
{ "endpoint": "aaaaa", "target_crn": "yyyyy", "bucket": "zzzzzz", "service_to_service_enabled": true } --endpoint COS_ENDPOINT-
L'endpoint IBM Cloud Object Storage da associare al bucket IBM Cloud Object Storage.
--bucket COS_BUCKET-
Nome del bucket IBM Cloud Object Storage da associare alla destinazione.
--target-crn COS_TARGET_CRN-
CRN dell'istanza di IBM Cloud Object Storage.
--api-key COS_API_KEY|@COS_API_KEY_FILE-
Il valore della chiave API o un riferimento al file della chiave API utilizzato per ottenere l'accesso. Ad esempio,
ibmcloud login --apikey $KEYFILE --service-to-service-enabled (TRUE | FALSE)-
Indica se l'autorizzazione da servizio a servizio è stata abilitata per il bucket. Specificare
TRUEse l'autorizzazione da servizio a servizio è abilitata eFALSEse l'autorizzazione da servizio a servizio non è abilitata. Per impostazione predefinita, l'autorizzazione da servizio a servizio èFALSE. --output FORMAT-
Il formato attualmente supportato è JSON. Se specificato, l'output verrà restituito in formato JSON. Se non viene specificato
JSON, l'output verrà restituito in formato tabellare. help|--help|-h-
Elenca le opzioni disponibili per il comando.
Esempio
Di seguito è riportato un esempio che utilizza il comando 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
Eliminazione di un target tramite CLI
Utilizza questo comando per eliminare una destinazione.
ibmcloud atracker target rm --target TARGET [--force]
Opzioni comando
--target TARGET- L'ID o il nome del bersaglio.
--force|-f- Eliminerà la destinazione senza fornire all'utente alcuna richiesta aggiuntiva.
help|--help|-h- Elenca le opzioni disponibili per il comando.
Esempio
Di seguito è riportato un esempio che utilizza il comando 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.
Di seguito è riportato un esempio che utilizza il comando ibmcloud atracker target rm --target xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -force.
Questo esempio mostra un comando non riuscito in cui non è stato possibile trovare la destinazione specificata.
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.
Convalida di un target tramite CLI
Utilizzare questo comando per convalidare che un target sia configurato correttamente per una regione IBM Cloud Activity Tracker Event Routing.
ibmcloud atracker target validate --target TARGET [--region REGION] [--output FORMAT]
Opzioni comando
--target TARGET- L'ID o il nome del bersaglio.
--region REGION|-r REGION- Nome della regione, ad esempio
us-southoeu-gb. Se non specificato, verrà utilizzata la regione in cui si è effettuato l'accesso o quella di destinazione. --output FORMAT- Il formato attualmente supportato è JSON. Se specificato, l'output verrà restituito in formato JSON. Se non viene specificato
JSON, l'output verrà restituito in formato tabellare. help|--help|-h- Elenca le opzioni disponibili per il comando.
Esempio
Di seguito è riportato un esempio che utilizza il comando ibmcloud atracker target validate --target new-target-name.
Questo esempio mostra un target COS convalidato con successo.
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
Ottenere informazioni su un target utilizzando la CLI
Utilizzare questo comando per ottenere informazioni su un target per una regione IBM Cloud Activity Tracker Event Routing.
ibmcloud atracker target get --target TARGET [--output FORMAT]
Opzioni comando
--target TARGET- L'ID o il nome del bersaglio.
--output FORMAT- Il formato attualmente supportato è JSON. Se specificato, l'output verrà restituito in formato JSON. Se non viene specificato
JSON, l'output verrà restituito in formato tabellare. help|--help|-h- Elenca le opzioni disponibili per il comando.
Esempio
Di seguito è riportato un esempio che utilizza il comando ibmcloud atracker target get --target new-target-name che mostra un target COS.
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
Elencare tutti gli obiettivi in una regione
Utilizzare questo comando per elencare le destinazioni configurate per una regione IBM Cloud Activity Tracker Event Routing.
ibmcloud atracker target ls [--output FORMAT]
Opzioni comando
--output FORMAT- Il formato attualmente supportato è JSON. Se specificato, l'output verrà restituito in formato JSON. Se non viene specificato
JSON, l'output verrà restituito in formato tabellare. help|--help|-h- Elenca le opzioni disponibili per il comando.
Esempio
Di seguito è riportato un esempio che utilizza il comando 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
Obiettivi e azioni API
La tabella seguente elenca le operazioni che è possibile eseguire per gestire le destinazioni:
| Azione | Metodo API REST | URL_API |
|---|---|---|
| Crea un obiettivo | POST |
<ENDPOINT>/api/v2/targets |
| Aggiorna un obiettivo | PUT |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| Elimina un obiettivo | DELETE |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| Leggi un obiettivo | GET |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| Elenca tutti gli obiettivi | GET |
<ENDPOINT>/api/v2/targets |
| Convalidare un obiettivo | POST |
<ENDPOINT>/api/v2/targets/{id}/validate |
È possibile utilizzare endpoint privati e pubblici per gestire i target. Per ulteriori informazioni sull'elenco dei ENDPOINTS disponibili, vedere Endpoint.
-
È possibile gestire i target dalla rete privata utilizzando un endpoint API con il seguente formato:
https://private.REGION.atracker.cloud.ibm.com -
È possibile gestire i target dalla rete pubblica utilizzando un endpoint API con il seguente formato:
https://REGION.atracker.cloud.ibm.com -
È possibile disattivare gli endpoint pubblici aggiornando le impostazioni dell'account. Per ulteriori informazioni, vedere Configurazione delle impostazioni di destinazione e regione.
Per ulteriori informazioni sulla REST API, vedere Target.
Prerequisiti API
Per effettuare chiamate API per gestire le destinazioni, completare i seguenti passaggi:
- Ottenere un token di accesso IAM. Per ulteriori informazioni, vedere Recupero dei token di accesso IAM.
- Identifica l'endpoint API nella regione in cui intendi configurare o gestire una destinazione. Per ulteriori informazioni, vedere Endpoint.
Creazione di un target COS tramite API
È possibile utilizzare il seguente comando cURL per creare un target IBM Cloud Object Storage (COS):
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
}
}'
Dove
-
<ENDPOINT>è l'endpoint API nella regione in cui intendi configurare o gestire un target. Per ulteriori informazioni, vedere Endpoint. -
TARGET_NAMEè il nome della destinazione. La lunghezza massima del nome è di 256 caratteri.Non includere alcuna informazione di identificazione personale (PII) nei nomi delle risorse.
-
TARGET_TYPEè il tipo di destinazione. Il tipo valido ècloud_object_storage. -
cos_endpointinclude informazioni sulla destinazione. Per ulteriori informazioni su come ottenere i dettagli del bucket, vedere Ottenere i dettagli di configurazione del bucket.
PRIVATE_COS_ENDPOINT indica l'endpoint IBM Cloud Activity Tracker Event Routing in cui cercare questo bucket. Utilizzare l'endpoint privato.
COS_CRN indica il CRN dell'istanza COS in cui è stato effettuato il provisioning del bucket.
BUCKET_NAME indica il nome del bucket.
API_KEY contiene la chiave API che dispone delle autorizzazioni per caricare oggetti nel bucket. Questo valore viene ignorato se service_to_service_enabled è true.
SERVICE_TO_SERVICE indica se l'autorizzazione da servizio a servizio è stata abilitata per il bucket. Specificare true se l'autorizzazione da servizio a servizio è abilitata e false se l'autorizzazione da servizio a servizio non è abilitata. Per impostazione predefinita, l'autorizzazione da servizio a servizio è false.
Ad esempio, puoi utilizzare la seguente richiesta cURL per creare una destinazione a Dallas:
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
}
}'
Nella risposta si ottengono informazioni sul target, come id, che indica il GUID del target, e crn, che indica il CRN del target.
Aggiornamento di un target COS tramite API
Quando si aggiorna un target IBM Cloud Object Storage (COS), è necessario includere le informazioni sul target nella sezione dati della richiesta.
- Devi superare tutti i campi.
- Aggiorna i campi che devono essere modificati.
- Non è possibile modificare il
target_typedi un target una volta creato.
È possibile utilizzare il seguente comando cURL per aggiornare una destinazione:
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
}
}'
Dove
-
<ENDPOINT>è l'endpoint API nella regione in cui intendi configurare o gestire un target. Per ulteriori informazioni, vedere Endpoint. -
TARGET_IDè l'ID della destinazione. -
TARGET_NAMEè il nome della destinazione. La lunghezza massima del nome è di 256 caratteri.Non includere alcuna informazione di identificazione personale (PII) nei nomi delle risorse.
-
TARGET_TYPEè il tipo di destinazione. Impostare il valore sucloud_object_storageper un target COS. -
cos_endpointinclude informazioni sulla destinazione. Per ulteriori informazioni su come ottenere i dettagli del bucket, vedere Ottenere i dettagli di configurazione del bucket.
PRIVATE_COS_ENDPOINT indica l'endpoint IBM Cloud Activity Tracker Event Routing in cui cercare questo bucket. Utilizzare l'endpoint privato.
COS_CRN indica il CRN dell'istanza COS in cui è stato effettuato il provisioning del bucket.
BUCKET_NAME indica il nome del bucket.
API_KEY contiene la chiave API che dispone delle autorizzazioni per caricare oggetti nel bucket. Questo valore viene ignorato se service_to_service_enabled è true.
SERVICE_TO_SERVICE indica se l'autorizzazione da servizio a servizio è stata abilitata per il bucket. Specificare true se l'autorizzazione da servizio a servizio è abilitata e false se l'autorizzazione da servizio a servizio non è abilitata. Per impostazione predefinita, l'autorizzazione da servizio a servizio è false.
Ad esempio, puoi utilizzare la seguente richiesta cURL per creare una destinazione a Dallas:
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
}
}'
Eliminazione di un target tramite API
Per eliminare un target è possibile utilizzare il seguente comando cURL:
curl -X DELETE <ENDPOINT>/api/v2/targets/<TARGET_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
Dove
<ENDPOINT>è l'endpoint API nella regione in cui intendi configurare o gestire un target. Per ulteriori informazioni, vedere Endpoint.<TARGET_ID>è l'ID della destinazione.
Ad esempio, puoi utilizzare la seguente richiesta cURL per eliminare un target in US-South con ID 00000000-0000-0000-0000-000000000000:
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"
Nella risposta, se l'eliminazione è riuscita, si ottiene un risultato vuoto:
{}
Convalida di un target tramite API
È possibile utilizzare il seguente comando cURL per convalidare una destinazione verificando le credenziali per scrivere sulla destinazione.
curl -X POST <ENDPOINT>/api/v2/targets/<TARGET_ID>/validate -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
Dove
<ENDPOINT>è l'endpoint API nella regione in cui intendi configurare o gestire un target. Per ulteriori informazioni, vedere Endpoint.<TARGET_ID>è l'ID della destinazione.
Ad esempio, puoi utilizzare la seguente richiesta cURL per convalidare un target in US-South con 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"
Nella risposta, si ottengono informazioni nella sezione cos_write_status, ad esempio:
"write_status": {
"status": "success"
},
Visualizzazione di un target tramite API
È possibile utilizzare il seguente comando cURL per visualizzare i dettagli di configurazione di 1 destinazione:
curl -X GET <ENDPOINT>/api/v2/targets/<TARGET_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
Dove
<ENDPOINT>è l'endpoint API nella regione in cui intendi configurare o gestire un target. Per ulteriori informazioni, vedere Endpoint.<TARGET_ID>è l'ID della destinazione.
Ad esempio, è possibile eseguire la seguente richiesta cURL per ottenere informazioni su un target con 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"
I risultati mostreranno se l'obiettivo è COS ("target_type": "cloud_object_storage").
Elencare tutti gli obiettivi utilizzando l'API
È possibile utilizzare il seguente comando cURL per visualizzare tutti i target:
curl -X GET <ENDPOINT>/api/v2/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
Dove
<ENDPOINT>è l'endpoint API nella regione in cui intendi configurare o gestire un target. Per ulteriori informazioni, vedere Endpoint.
Ad esempio, è possibile eseguire la seguente richiesta cURL per ottenere informazioni sulle destinazioni definite a Dallas:
curl -X GET https://private.us-south.atracker.cloud.ibm.com/api/v2/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
I risultati mostreranno se l'obiettivo è un obiettivo COS ("target_type": "cloud_object_storage").
Codici di risposta HTTP
Quando si utilizza l'API REST di IBM Cloud Activity Tracker Event Routing, è possibile ottenere i codici di risposta standard di HTTP per indicare se un metodo è stato completato con successo.
- Una risposta pari a 200 indica sempre successo.
- Una risposta 4xx indica un errore.
- Una risposta 5xx indica solitamente un errore interno del sistema.
Vedere la tabella seguente per alcuni codici di risposta di HTTP:
| Codice di stato | Condizione | Descrizione |
|---|---|---|
200 |
OK | La richiesta ha avuto esito positivo. |
201 |
OK | La richiesta ha avuto esito positivo. Viene creata una risorsa. |
400 |
Richiesta non valida | La richiesta non ha avuto successo. Potrebbe mancare un parametro obbligatorio. |
401 |
Non autorizzato | Il token IAM utilizzato nella richiesta API non è valido o è scaduto. |
403 |
Non consentito | L'operazione è vietata perché le autorizzazioni non sono sufficienti. |
404 |
Non trovato | La risorsa richiesta non esiste o è già stata eliminata. |
429 |
Troppe richieste | Troppe richieste raggiungono l'API troppo rapidamente. |
500 |
Errore interno del server | Si è verificato un errore durante l'elaborazione di IBM Cloud Activity Tracker Event Routing. |
Creazione di un target IBM Cloud Object Storage tramite l'interfaccia utente
Sono elencate e selezionabili solo le risorse presenti nel tuo account. Per specificare una risorsa in un account diverso, selezionare Specifica CRN in Scegli destinazione.
- Accedi al tuo account IBM Cloud.
- Fai clic sull'
Menu > Osservabilità.
- Seleziona " Monitoraggio attività ".
- Fare clic su Crea per aprire il pannello di creazione.
- Scegli il tipo: fai clic su Object Storage.
- Autorizzazione del servizio richiesta: è richiesta l'autorizzazione del servizio per consentire IBM Cloud Activity Tracker Event Routing di comunicare con IBM Cloud Object Storage. Fare clic su Autorizza ora per creare automaticamente la policy oppure fare clic su Concedi accesso in IAM.
- Scegli destinazione: seleziona Cerca per istanza o Specifica CRN
- Cerca per istanza: seleziona un'istanza IBM Cloud Object Storage dalla tabella oppure fai clic su Crea per creare una nuova istanza IBM Cloud Object Storage. Dopo aver selezionato un'istanza, seleziona un bucket IBM Cloud Object Storage.
- Specifica CRN: immetti il nome della risorsa cloud (CRN) del bucket IBM Cloud Object Storage. Ciò consente di immettere un CRN da un account diverso.
- Endpoint del bucket: utilizza l'endpoint predefinito del bucket o modificalo.
- Nome destinazione: immettere un nome significativo per la destinazione.
- Regione di destinazione: seleziona la regione in cui verranno elaborati i dati dell'evento.
- Attiva Imposta come destinazione predefinita per impostare automaticamente la nuova destinazione come destinazione predefinita nelle impostazioni di IBM Cloud Activity Tracker Event Routing. Per maggiori dettagli, consultare la documentazione degli obiettivi predefiniti.
- Fare clic su Crea destinazione.
Aggiornamento di un target IBM Cloud Object Storage tramite l'interfaccia utente
Sono elencate e selezionabili solo le risorse presenti nel tuo account. Per specificare una risorsa in un account diverso, selezionare Specifica CRN in Scegli destinazione.
- Accedi al tuo account IBM Cloud.
- Fai clic sull'
Menu > Osservabilità.
- Seleziona " Monitoraggio attività ".
- Individuare l'elemento da aggiornare e fare clic
.
- Fai clic su Non impostare come predefinito per rimuovere il tuo target come target predefinito nelle impostazioni di IBM Cloud Activity Tracker Event Routing. Per maggiori dettagli, consultare la documentazione degli obiettivi predefiniti.
- Fare clic su Modifica per aprire il pannello di aggiornamento.
- Dettagli: fai clic su Modifica per aggiornare il nome o la regione del tuo target. Puoi anche attivare l'opzione Destinazione predefinita per aggiungere o rimuovere la tua destinazione come destinazione predefinita nelle impostazioni di IBM Cloud Activity Tracker Event Routing.
- Fai clic su Salva per aggiornare il tuo obiettivo.
- Destinazione: fai clic su Modifica per modificare l'istanza o i bucket IBM Cloud Object Storage associati alla tua destinazione.
- Fai clic su Salva per aggiornare il tuo obiettivo.
Eliminazione di un target tramite l'interfaccia utente
Non è possibile eliminare una destinazione " IBM Cloud Activity Tracker Event Routing " se questa è utilizzata in un percorso o come impostazione predefinita per una destinazione.
- Accedi al tuo account IBM Cloud.
- Fai clic sull'
Menu > Osservabilità.
- Seleziona " Monitoraggio attività ".
- Determina quale target eliminare e clicca
.
- Fare clic su Elimina e poi su Elimina nel pannello di conferma.
Elencare tutti gli obiettivi in una regione utilizzando l'interfaccia utente
- Accedi al tuo account IBM Cloud.
- Fai clic sull'
Menu > Osservabilità.
- Seleziona " Monitoraggio attività ".
La tabella riporta i dettagli relativi agli obiettivi:
- Tipo di destinazione
- Nome destinazione
- Regione di destinazione
- Percorsi: se viene utilizzato in qualsiasi percorso
- Stato dell'obiettivo:
- Attivo: il target funziona come previsto
- Errore: la destinazione non è configurata correttamente e gli eventi non verranno indirizzati alla destinazione. Aggiorna i dettagli o la destinazione del tuo target per correggere la configurazione del target o elimina il target se non è più necessario