Configurazione delle impostazioni dell'account

Puoi configurare le impostazioni dell'account Activity Tracker Event Routing nel tuo account utilizzando la CLI di Activity Tracker Event Routing, l'API REST di Activity Tracker Event Routing e gli script Terraform. Imposta queste impostazioni per definire dove e come gli eventi di controllo vengono raccolti, instradati e gestiti nel tuo account.

Quando configuri o modifichi le impostazioni dell'account Activity Tracker Event Routing, tieni in considerazione le seguenti informazioni:

Ogni volta che modifichi le impostazioni dell'account Activity Tracker Event Routing, i dati trasmessi nella nuova richiesta sostituiscono tutti i dati di configurazione esistenti. È necessario assicurarsi che i dati esistenti non vengano eliminati quando si esegue un aggiornamento delle impostazioni dell'account, includendoli nella nuova richiesta.
Prima di disabilitare gli endpoint pubblici impostando --private-api-endpoint-only TRUE, assicurati che il tuo account abbia accesso all'endpoint privato. Puoi farlo eseguendo il comando ibmcloud account show. Se VRF Enabled è true e Service Endpoint Enabled è true allora hai accesso all'endpoint privato. Se non hai accesso all'endpoint privato, non potrai riattivare l'endpoint pubblico, poiché per riattivare l'endpoint pubblico è necessario l'accesso all'endpoint privato.

Quali dati puoi configurare tramite le impostazioni dell'account IBM Cloud® Activity Tracker Event Routing ?

È possibile definire una qualsiasi delle seguenti informazioni:

Posizione nel tuo account IBM Cloud in cui sono archiviati i metadati di configurazione dell'account Activity Tracker Event Routing.

Per metadati intendiamo i dati di destinazione/percorso/impostazioni disponibili nell'account in qualsiasi regione.

Puoi scegliere una qualsiasi delle posizioni supportate in cui è disponibile Activity Tracker Event Routing. Per ulteriori informazioni, vedi Ubicazioni.

Tenere in considerazione eventuali requisiti di conformità aziendali o di settore, come sedi convalidate per i servizi finanziari o regioni gestite dall'UE.
Il tipo di endpoint autorizzati a gestire la configurazione dell'account Activity Tracker Event Routing nell'account.

È possibile configurare endpoint pubblici, endpoint privati o entrambi.
Le posizioni in cui un amministratore di account può definire destinazioni per la raccolta di eventi di controllo.

Puoi scegliere una qualsiasi delle posizioni supportate in cui è disponibile Activity Tracker Event Routing. Per ulteriori informazioni, vedi Ubicazioni.

Tenere in considerazione eventuali requisiti di conformità aziendali o di settore, come sedi convalidate per i servizi finanziari o regioni gestite dall'UE.
1 o più destinazioni nell'account che raccoglieranno gli eventi di controllo dalle posizioni supportate Activity Tracker Event Routing in cui non hai configurato la modalità di raccolta dei dati di controllo.

Se si definisce più di una destinazione, tutte le destinazioni predefinite ricevono una copia degli eventi di controllo che non dispongono di una regola di routing per indicare dove raccoglierli nell'account. È possibile definire fino a 2 obiettivi predefiniti per account.

Autorizzazioni IAM

È necessario concedere agli utenti le autorizzazioni IAM per gestire le impostazioni dell'account. Per ulteriori informazioni, vedere Assegnare l'accesso alle risorse.

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 spettatore per il servizio di destinazione, è possibile assegnare solo il ruolo di spettatore per l'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.

Quando si definisce una policy, è necessario impostare l'ambito della policy sull'account. Un percorso è una risorsa globale non vincolata a una regione specifica.

Required IAM roles
Azione IAM	Ambito della politica IAM	Ruoli IAM	Descrizione
`atracker.setting.get`	Account	`Administrator` `Editor` `Viewer` `Operator`	Ottieni informazioni sulle impostazioni
`atracker.setting.update`	Account	`Administrator`	Aggiorna impostazioni

Prerequisiti CLI

Prima di utilizzare la CLI per gestire le impostazioni dell'account Activity Tracker Event Routing, installa la CLI IBM Cloud Activity Tracker Event Routing.

Verifica di disporre delle autorizzazioni IAM per leggere o aggiornare le impostazioni dell'account Activity Tracker Event Routing.

Ottenere le impostazioni dell'account tramite la CLI

Utilizzare questo comando per ottenere le impostazioni per le configurazioni dell'account IBM Cloud Activity Tracker Event Routing.

ibmcloud atracker setting get [--output FORMAT]

Opzioni comando

--output FORMAT: Se viene specificato JSON, l'output verrà restituito in formato JSON. Se 'JSON non è specificato, l'output verrà restituito in formato tabellare.
help | --help | -h: Elenca le opzioni disponibili per il comando.

Esempio

Di seguito è riportato un esempio in cui non sono stati impostati obiettivi predefiniti o consentiti e la versione API è V2.

Atracker settings
Metadata region primary:     us-south
Metadata region backup:      us-east
Default targets:             []
Permitted target regions:    []
Private api endpoint only:   false
API version:                 2

Aggiornamento delle impostazioni tramite CLI

Utilizzare questo comando per modificare le impostazioni dell'account corrente, come le destinazioni predefinite, le regioni di destinazione consentite e la regione dei metadati principali.

ibmcloud atracker setting update [--metadata-region-primary REGION] [--metadata-region-backup REGION] [--default-targets TARGET] [--permitted-target-regions REGIONS] [--private-api-endpoint-only ( TRUE | FALSE )] [--output FORMAT] [--force]

Opzioni comando

default-targets: È un elenco di ID di destinazione. Se nessuna regola di routing determina l'invio di eventi ad altre destinazioni, queste ultime riceveranno gli eventi. TARGETS è un elenco di ID di destinazione separati da virgole.
permitted-target-regions: È l'elenco delle regioni che possono essere utilizzate per definire un target. REGIONS è un elenco di regioni separate da virgole. È possibile specificare un massimo di due regioni target consentite.
metadata-region-primary: Specificare la REGIONE in cui sono archiviati i metadati associati alle definizioni di percorso e destinazione.
metadata_region_backup: È la regione in cui i metadati associati alle definizioni di percorso e destinazione vengono archiviati come posizione di backup.
private-api-endpoint-only: Specifica se è possibile utilizzare un endpoint privato. Se true è possibile utilizzare solo un endpoint privato.
--output FORMAT: Se si specifica JSON, l'output verrà restituito in formato JSON. Se 'JSON non è specificato, l'output verrà restituito in formato tabellare.
help | --help | -h: Elenca le opzioni disponibili per il comando.

Se l'aggiornamento riesce, verranno visualizzate le impostazioni correnti.

Impostazioni e azioni API

La tabella seguente elenca le azioni che si possono eseguire per gestire le impostazioni:

Impostazioni azioni tramite l'API REST IBM Cloud Activity Tracker Event Routing
Azione	Metodo API REST	URL_API
Ottieni informazioni sulle impostazioni	`GET`	`<ENDPOINT>/api/v2/settings`
Aggiorna impostazioni	`PUT`	`<ENDPOINT>/api/v2/settings`

È possibile utilizzare endpoint privati e pubblici per gestire le impostazioni. Per ulteriori informazioni sull'elenco dei ENDPOINTS disponibili, vedere Endpoint.

Per impostazione predefinita, è possibile gestire le impostazioni dalla rete privata. È necessario utilizzare un endpoint API con il seguente formato: https://private.<region>.atracker.cloud.ibm.com
È anche possibile abilitare gli endpoint pubblici in una regione per gestire le impostazioni. Per ulteriori informazioni, vedere Gestione degli endpoint.

Per ulteriori informazioni sull'API REST, vedere l'API delle impostazioni.

Prerequisiti API

Per effettuare chiamate API per gestire le impostazioni, 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 le impostazioni. Per ulteriori informazioni, vedere Endpoint.

Ottenere le impostazioni tramite l'API

È possibile utilizzare il seguente comando cURL per ottenere informazioni sulle impostazioni esistenti:

curl -X GET  ENDPOINT/api/v2/settings   -H "Authorization:  $ACCESS_TOKEN"

Dove:

ENDPOINT: L'endpoint API si trova nella regione in cui intendi configurare o gestire una destinazione. Per ulteriori informazioni, vedere Endpoint.

Ad esempio, è possibile utilizzare le seguenti informazioni sulle impostazioni di richiesta cURL per la regione degli Stati Uniti meridionali:

curl -X GET   https://private.us-south.atracker.cloud.ibm.com/api/v2/settings   -H "Authorization:  $ACCESS_TOKEN"

Viene restituita una risposta simile alla seguente:

{
 "default_targets": ["50375218-0000-4234-bbb4-171bebab8408", "c7519d8a-5f97-498b-0000-8542f60955cd"],
 "permitted_target_regions": ["us-south", "us-east"],
 "metadata_region_primary": "us-south",
 "metadata_region_backup": "eu-de",
 "private_api_endpoint_only": false
}

Dove:

default_targets: È un elenco di ID di destinazione. Se nessuna regola di routing determina l'invio di eventi ad altre destinazioni, queste ultime riceveranno gli eventi.
permitted_target_regions: È l'elenco delle regioni che possono essere utilizzate per definire un target. Sono ammesse al massimo due regioni target.
metadata_region_primary: È la regione in cui vengono archiviati i metadati associati alle definizioni di percorso e destinazione.
metadata_region_backup: È la regione in cui i metadati associati alle definizioni di percorso e destinazione vengono archiviati come posizione di backup.
private_api_endpoint_only: Specifica se è possibile utilizzare un endpoint privato. Se true è possibile utilizzare solo un endpoint privato.

Aggiornamento delle impostazioni tramite API

Quando si aggiornano le impostazioni, è necessario includere le informazioni sulle impostazioni nella sezione dati della richiesta.

Devi superare tutti i campi.
Aggiorna i campi che devono essere modificati.

È possibile utilizzare il seguente comando cURL per aggiornare le impostazioni:

curl -X PUT  <ENDPOINT>/api/v2/settings
-H "Authorization:  $ACCESS_TOKEN"
-H "content-type: application/json"
-d '{
   "default_targets": ["IDs"],
   "permitted_target_regions": ["REGIONS"],
   "metadata_region_primary": "REGION",
   "metadata_region_backup": "REGION",
   "private_api_endpoint_only": false
}'

Dove:

ENDPOINT: L'endpoint API si trova nella regione in cui intendi configurare o gestire una destinazione. Per ulteriori informazioni, vedere Endpoint.
default_targets: È un elenco di ID di destinazione. Se nessuna regola di routing determina l'invio di eventi ad altre destinazioni, queste ultime riceveranno gli eventi.
permitted_target_regions: È l'elenco delle regioni che possono essere utilizzate per definire un target. È possibile specificare un massimo di due regioni target consentite.
metadata_region_primary: È la regione in cui vengono archiviati i metadati associati alle definizioni di percorso e destinazione.
metadata_region_backup: È la regione in cui i metadati associati alle definizioni di percorso e destinazione vengono archiviati come posizione di backup.
private_api_endpoint_only: Specifica se è possibile utilizzare un endpoint privato. Se true è possibile utilizzare solo un endpoint privato.

Codici di risposta HTTP

Quando si utilizza l'API IBM Cloud Activity Tracker Event Routing REST API, si possono ottenere codici di risposta HTTP standard per indicare se un metodo è stato completato correttamente.

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 seguente tabella per alcuni codici di risposta HTTP:

Elenco dei codici di risposta 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.

Ottenere le impostazioni dell'account tramite l'interfaccia utente

Accedi al tuo account IBM Cloud.
Fare clic > Osservabilità.
Seleziona Programma di traccia dell'attività.
Selezionare Routing.
Selezionare Impostazioni.

In questa pagina puoi visualizzare le seguenti impostazioni:

Posizione dei metadati: visualizza la regione dei metadati primari e la regione dei metadati di backup.
Regioni target consentite. Visualizza le regioni di destinazione in cui è possibile inviare gli eventi.
Destinazioni predefinite: visualizza le destinazioni predefinite configurate.
Endpoint pubblici: mostra se gli endpoint pubblici sono abilitati. Se disabilitata, non sarà possibile accedere all'interfaccia utente di Activity Tracker Event Routing.
Report: visualizza la configurazione in formato JSON.

Aggiornamento delle impostazioni tramite l'interfaccia utente

Accedi al tuo account IBM Cloud.
Fare clic > Osservabilità.
Seleziona Programma di traccia dell'attività.
Selezionare Routing.
Selezionare Impostazioni.

Fare clic su Modifica accanto all'impostazione da modificare. È possibile modificare le seguenti impostazioni:

Posizione dei metadati: seleziona la regione dei metadati primari e la regione dei metadati di backup desiderate.
Regioni target consentite: seleziona la regione in cui è possibile creare i target. Se non viene selezionata alcuna regione, tutte le regioni possono ricevere eventi.
Destinazioni predefinite: seleziona la destinazione che verrà utilizzata per impostazione predefinita quando le regole di routing non esistono o non corrispondono.