Prerequisiti CLI

Prima di utilizzare la CLI per gestire i target, eseguire le operazioni seguenti:

1. Installa la CLI IBM Cloud.

2. Installa la CLI IBM Cloud Activity Tracker Event Routing.

3. Accedi a IBM Cloud. Esegui il seguente comando: ibmcloud login

Configurazione dell'autorizzazione " S2S " tramite l'interfaccia utente all'interno dello stesso account

Per configurare un'autorizzazione da servizio a servizio tramite l'interfaccia utente di IBM Cloud, procedere come segue.

1. Accedi al tuo account IBM Cloud con le credenziali del titolare dell'account che provvederà a configurare le destinazioni 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.

2. Selezionare Gestisci > Accesso (IAM) > Autorizzazioni.

3. Fai clic su Crea.

4. Per il servizio di origine, selezionare Activity Tracker e per "Come desideri definire l'ambito dell'accesso?", seleziona " Tutte le risorse ".

5. Per il servizio di destinazione, selezionare App Configuration e per "Come si desidera definire l'ambito dell'accesso?", selezionare " Risorse in base agli attributi selezionati ".

6. Selezionare l'istanza del servizio e la stringa corrispondente. Imposta il nome della tua istanza di IBM Cloud App Configuration.

7. Per l'accesso al servizio, selezionare i ruoli "Manager " e " Configuration Update Reporter ".

8. Fai clic su Autorizza. La tua nuova autorizzazione da servizio a servizio verrà visualizzata nella schermata “Gestisci autorizzazioni ”.

Configurazione dell'autorizzazione di " S2S " tramite la CLI

Per configurare un'autorizzazione da servizio a servizio tramite la CLI di IBM Cloud, procedere come segue.

1. Accedi al tuo account IBM Cloud con le credenziali del titolare dell'account che configurerà l'autorizzazione IBM Cloud Activity Tracker Event Routing.

2. Crea una politica di autorizzazione che definisca l'autorizzazione da servizio a servizio.

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

Configurazione dell'autorizzazione di " S2S " tramite l'API

Per configurare un'autorizzazione da servizio a servizio tramite l'API IBM Cloud, procedere come segue.

1. Accedi al tuo account IBM Cloud con le credenziali del titolare dell'account che configurerà l'autorizzazione IAM per IBM Cloud Activity Tracker Event Routing.

2. Crea un file authorization_policy_resource.json in cui definire 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:ConfigurationUpdateReporter"
           }
       ],
       "resources": [
           {
               "attributes": [
                 {
                      "name": "accountId",
                      "value": "CUSTOMER_ACCOUNT_ID"
                  },
                  {
                       "name": "serviceName",
                       "value": "apprapp"
                   },
                   {
                       "name": "serviceInstance",
                       "value": "APPCONFIG_SERVICE_INSTANCE"
                   }
               ]
           }
       ]
   }
   

   Dove:

   CUSTOMER_ACCOUNT_ID è il GUID dell'account che provvederà a configurare le destinazioni. È possibile ottenerlo utilizzando il ibmcloud account list comando.

   APPCONFIG_SERVICE_INSTANCE è l'ID dell'istanza di IBM Cloud App Configuration.

3. Ottenere un token di accesso IAM. Per ulteriori informazioni, consultare la sezione " Recupero dei token di accesso IAM ".

4. Esegui 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 una destinazione " IBM Cloud App Configuration " tramite la CLI

Utilizza questo comando per creare un target " IBM Cloud App Configuration " da utilizzare per configurare una destinazione per gli eventi delle attività.

 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

Aggiornamento di una destinazione " IBM Cloud App Configuration " tramite la CLI

Utilizza questo comando per aggiornare una destinazione IBM Cloud App Configuration per una regione IBM Cloud Activity Tracker Event Routing. Qualsiasi valore specificato che differisca da quello presente al momento della creazione originale dell'obiettivo verrà aggiornato al valore specificato nel comando.

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

Eliminazione di una destinazione tramite la CLI

Utilizza questo comando per eliminare una destinazione.

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.

Convalida di un target tramite la CLI

Utilizza questo comando per verificare che una destinazione sia configurata correttamente per una regione di IBM Cloud Activity Tracker Event Routing.

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

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

Ottenere informazioni su un bersaglio tramite la CLI

Utilizza questo comando per ottenere informazioni su un target relativo a una regione di IBM Cloud Activity Tracker Event Routing.

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

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

Elenco di tutti gli obiettivi in una regione

Utilizza questo comando per visualizzare l'elenco delle destinazioni configurate per una regione di IBM Cloud Activity Tracker Event Routing.

ibmcloud atracker target ls [--output FORMAT]

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

Obiettivi e azioni dell'API

La tabella seguente elenca le operazioni che è possibile eseguire per gestire le destinazioni:

È possibile utilizzare endpoint privati e pubblici per gestire le destinazioni. Per ulteriori informazioni sull'elenco degli endpoint ENDPOINTS disponibili, consultare la sezione Endpoint.

• È possibile gestire gli obiettivi dalla rete privata utilizzando un endpoint API con il seguente formato: https://private.REGION.atracker.cloud.ibm.com

• È possibile gestire gli obiettivi 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, consultare la sezione " Configurazione delle impostazioni relative alla destinazione e alla regione ".

Per ulteriori informazioni sull'API REST, consultare la sezione " Destinazioni".

Prerequisiti API

Per effettuare chiamate API per la gestione dei target, procedere come segue:

1. Ottenere un token di accesso IAM. Per ulteriori informazioni, consultare la sezione " Recupero dei token di accesso IAM ".
2. Individuare l'endpoint API nella regione in cui si intende configurare o gestire un obiettivo. Per ulteriori informazioni, consultare la sezione " Endpoint".

Creazione di un target " IBM Cloud App Configuration " tramite l'API

È possibile utilizzare il seguente comando cURL per creare un target IBM Cloud App Configuration:

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

Dove

• <ENDPOINT> è l'endpoint API nella regione in cui si intende configurare o gestire un target. Per ulteriori informazioni, consultare la sezione " Endpoint".

• TARGET_NAME è il nome della destinazione. La lunghezza massima del nome è di 256 caratteri.

  Non inserire alcuna informazione di identificazione personale (PII) nei nomi delle risorse.

• TARGET_TYPE è il tipo dell'obiettivo.

• app_config_endpoint contiene informazioni sul bersaglio.

APPCONFIG_CRN indica il CRN dell'istanza di IBM Cloud App Configuration.

Ad esempio, è possibile 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 App Configuration target",
    "target_type": "app_config",
    "app_config_endpoint": {
      "target_crn": "crn:v1:bluemix:public:apprapp:us-south:a/<account-id>:<instance-id>::"
    }
  }'

Nella risposta vengono fornite informazioni sul target, quali l' id, che indica il GUID del target, e l' crn, che indica il CRN del target.

Aggiornamento di una destinazione " IBM Cloud App Configuration " tramite l'API

Quando si aggiorna un target IBM Cloud App Configuration, è necessario includere le informazioni relative al target nella sezione “dati” della richiesta.

• È necessario compilare tutti i campi.
• Aggiorna i campi che devono essere modificati.
• Una volta creata, l' target_type e di una destinazione non può essere modificata.

Per aggiornare una destinazione, è possibile utilizzare il seguente comando cURL:

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

Dove

• <ENDPOINT> è l'endpoint API nella regione in cui si intende configurare o gestire un target. Per ulteriori informazioni, consultare la sezione " Endpoint".

• TARGET_ID è l'ID del bersaglio.

• TARGET_NAME è il nome della destinazione. La lunghezza massima del nome è di 256 caratteri.

  Non inserire alcuna informazione di identificazione personale (PII) nei nomi delle risorse.

• TARGET_TYPE è il tipo dell'obiettivo. Impostare il valore su app_config per una destinazione IBM Cloud App Configuration.

• app_config_endpoint contiene informazioni sul bersaglio.

APPCONFIG_CRN indica il CRN dell'istanza di IBM Cloud App Configuration.

Ad esempio, è possibile utilizzare la seguente richiesta cURL per aggiornare un target a Dallas:

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

Eliminazione di un target tramite l'API

Per eliminare una destinazione, è 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 si intende configurare o gestire un target. Per ulteriori informazioni, consultare la sezione " Endpoint".
• <TARGET_ID> è l'ID del bersaglio.

Ad esempio, è possibile utilizzare la seguente richiesta cURL per eliminare un target nella regione US-South con l'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, si ottiene un risultato vuoto se l'eliminazione è andata a buon fine:

{}

Convalida di un target tramite l'API

È possibile utilizzare il seguente comando cURL per convalidare una destinazione, verificando le credenziali necessarie per scrivere su di essa.

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 si intende configurare o gestire un target. Per ulteriori informazioni, consultare la sezione " Endpoint".
• <TARGET_ID> è l'ID del bersaglio.

Ad esempio, è possibile utilizzare la seguente richiesta cURL per verificare la validità di un target nella regione US-South con l'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, le informazioni sono riportate nella sezione write_status, ad esempio:

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

Visualizzazione di un bersaglio tramite l'API

È possibile utilizzare il seguente comando cURL per visualizzare i dettagli di configurazione di 1 target:

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 si intende configurare o gestire un target. Per ulteriori informazioni, consultare la sezione " Endpoint".
• <TARGET_ID> è l'ID del bersaglio.

Ad esempio, è possibile eseguire la seguente richiesta cURL per ottenere informazioni su un target con l'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 indicheranno se l'obiettivo è COS ("target_type": "cloud_object_storage"), l'offerta di IBM Cloud Logs ("target_type": "cloud_logs") o IBM Cloud App Configuration ("target_type": "app_config")

Elencare tutti i target tramite l'API

È possibile utilizzare il seguente comando cURL per visualizzare tutte le destinazioni:

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 si intende configurare o gestire un target. Per ulteriori informazioni, consultare la sezione " Endpoint".

Ad esempio, è possibile eseguire la seguente richiesta cURL per ottenere informazioni sui target definiti 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 indicheranno se l'obiettivo è COS ("target_type": "cloud_object_storage"), l'offerta di IBM Cloud Logs ("target_type": "cloud_logs") o IBM Cloud App Configuration ("target_type": "app_config")

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 verificare se un metodo è stato eseguito correttamente.

• Un codice di risposta 200 indica sempre che l'operazione è andata a buon fine.
• Una risposta " 4xx " indica un errore.
• Una risposta di tipo " 5xx " indica solitamente un errore interno del sistema.

Si veda la tabella seguente per alcuni codici di risposta dell' HTTP: