Requisitos previos de la CLI

Antes de utilizar la CLI para gestionar destinos, lleve a cabo los pasos siguientes:

1. Instale la CLI de IBM Cloud.

2. Instale la CLI de IBM Cloud Activity Tracker Event Routing.

3. Inicie sesión en IBM Cloud. Ejecute el siguiente mandato: ibmcloud login

Configuración de la autorización de S2S mediante la interfaz de usuario dentro de la misma cuenta

Realice lo siguiente para configurar una autorización de servicio a servicio utilizando la interfaz de usuario de IBM Cloud.

1. Inicie sesión en la cuenta de IBM Cloud como propietario de la cuenta que va a configurar los destinos de IBM Cloud Activity Tracker Event Routing.

   Después de iniciar sesión con su ID de usuario y su contraseña, se abre el panel de control de IBM Cloud.

2. Selecciona Gestionar > Acceso (IAM) > Autorizaciones.

3. Pulse Crear.

4. En el servicio Source, selecciona Activity Tracker y, en ¿Cómo quieres delimitar el acceso?, selecciona Todos los recursos.

5. En el servicio de destino, selecciona App Configuration y, en ¿Cómo quieres delimitar el acceso?, selecciona Recursos basados en los atributos seleccionados.

6. Selecciona « Instancia de servicio » y « cadena igual a ». Establece el nombre de tu instancia de « IBM Cloud App Configuration ».

7. Para acceder al servicio, selecciona los roles « Manager » y « Configuration Update Reporter ».

8. Pulse Autorizar. La nueva autorización de servicio a servicio se especificará en la vista Gestionar autorizaciones.

Configuración de la autorización de S2S mediante la CLI

Realice lo siguiente para configurar una autorización de servicio a servicio utilizando la CLI de IBM Cloud.

1. Inicia sesión en tu cuenta de IBM Cloud como el titular de la cuenta que va a configurar la autorización de IBM Cloud Activity Tracker Event Routing.

2. Cree una política de autorización que defina la autorización de servicio a servicio.

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

Configuración de la autorización de S2S mediante la API

Realice lo siguiente para configurar una autorización de servicio a servicio utilizando la API de IBM Cloud.

1. Inicie la sesión en la cuenta de IBM Cloud como propietario de la cuenta que va a configurar la autorización de IAM de IBM Cloud Activity Tracker Event Routing.

2. Cree un archivo authorization_policy_resource.json que defina la autorización de servicio a servicio.

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

   Donde:

   CUSTOMER_ACCOUNT_ID es el GUID de cuenta para la cuenta que va a configurar destinos. Esto se puede encontrar utilizando el mandato ibmcloud account list.

   APPCONFIG_SERVICE_INSTANCE es el ID de la instancia de « IBM Cloud App Configuration ».

3. Obtenga una señal de acceso IAM. Para obtener más información, consulte Recuperación de señales de acceso de IAM.

4. Ejecute el mandato siguiente para configurar la autorización de servicio a servicio:

   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"
   

Creación de un destino « IBM Cloud App Configuration » mediante la CLI

Utiliza este comando para crear un destino de IBM Cloud App Configuration que se utilizará para configurar un destino para los eventos de actividad.

 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

Actualización de un destino de « IBM Cloud App Configuration » mediante la CLI

Utilice este comando para actualizar un destino de IBM Cloud App Configuration para una región de IBM Cloud Activity Tracker Event Routing. Cualquier valor especificado que sea distinto de cuando se creó originalmente el destino se actualizará al valor especificado en el mandato.

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

Supresión de un destino utilizando la CLI

Utilice este mandato para suprimir un destino.

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.

Validación de un destino utilizando la CLI

Utilice este mandato para validar que un destino se ha configurado correctamente para una región de 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

Obtención de información sobre un destino utilizando la CLI

Utilice este mandato para obtener información sobre un destino para una región de 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

Listado de todos los destinos de una región

Utilice este mandato para generar una lista de los destinos configurados para una región de 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

Destinos y acciones de la API

En la tabla siguiente se listan las acciones que puede ejecutar para gestionar destinos:

Puede utilizar puntos finales públicos y privados para gestionar destinos. Para obtener más información sobre la lista de ENDPOINTS que están disponibles, consulte Puntos finales.

• Puede gestionar destinos desde la red privada utilizando un punto final de API con el formato siguiente: https://private.REGION.atracker.cloud.ibm.com

• Puede gestionar destinos desde la red pública utilizando un punto final de API con el formato siguiente: https://REGION.atracker.cloud.ibm.com

• Puede inhabilitar los puntos finales públicos actualizando los valores de la cuenta. Para obtener más información, consulte Configuración de los valores de destino y región.

Para obtener más información sobre la API REST, consulte Destinos.

Requisitos previos de la API

Para realizar llamadas de API para gestionar destinos, complete los pasos siguientes:

1. Obtenga una señal de acceso IAM. Para obtener más información, consulte Recuperación de señales de acceso de IAM.
2. Identifique el punto final de API en la región en la que tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales.

Creación de un destino de « IBM Cloud App Configuration » mediante la API

Puede utilizar el siguiente comando de cURL para crear un destino 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"
    }
  }'

Donde

• <ENDPOINT> es el punto final de la API en la región donde tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales.

• TARGET_NAME es el nombre del destino. La longitud máxima del nombre es de 256 caracteres.

  No incluya información de identificación personal en ningún nombre de recurso.

• TARGET_TYPE es el tipo del destino.

• app_config_endpoint incluye información sobre el destino.

APPCONFIG_CRN indica el CRN de la instancia de « IBM Cloud App Configuration ».

Por ejemplo, puede utilizar la siguiente solicitud de cURL para crear un destino en 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>::"
    }
  }'

En la respuesta, obtiene información sobre el destino como, por ejemplo, el id, que indica el GUID del destino y el crn, que indica el CRN del destino.

Actualización de un destino de « IBM Cloud App Configuration » mediante la API

Al actualizar un destino de IBM Cloud App Configuration, debe incluir la información del destino en la sección de datos de la solicitud.

• Debe pasar todos los campos.
• Actualice los campos que deben cambiarse.
• No puede cambiar el target_type de un destino una vez creado.

Puede utilizar el siguiente mandato cURL para actualizar un destino:

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

Donde

• <ENDPOINT> es el punto final de la API en la región donde tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales.

• TARGET_ID es el ID del destino.

• TARGET_NAME es el nombre del destino. La longitud máxima del nombre es de 256 caracteres.

  No incluya información de identificación personal en ningún nombre de recurso.

• TARGET_TYPE es el tipo del destino. Establece el valor en « app_config » para un destino « IBM Cloud App Configuration ».

• app_config_endpoint incluye información sobre el destino.

APPCONFIG_CRN indica el CRN de la instancia de « IBM Cloud App Configuration ».

Por ejemplo, puede utilizar la siguiente solicitud de cURL para actualizar un destino en 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>::"
    }
  }'

Supresión de un destino utilizando la API

Puede utilizar el siguiente mandato de cURL para suprimir un destino:

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

Donde

• <ENDPOINT> es el punto final de la API en la región donde tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales.
• <TARGET_ID> es el ID del destino.

Por ejemplo, puede utilizar la siguiente solicitud de cURL para suprimir un destino en EE.UU. sur con el 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"

En la respuesta, obtendrá un resultado vacío si la supresión se ha realizado correctamente:

{}

Validación de un destino utilizando la API

Puede utilizar el mandato cURL siguiente para validar un destino comprobando las credenciales para escribir en el destino.

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

Donde

• <ENDPOINT> es el punto final de la API en la región donde tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales.
• <TARGET_ID> es el ID del destino.

Por ejemplo, puede utilizar la siguiente solicitud cURL para validar un destino en EE.UU. sur con el 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"

En la respuesta, se ofrece información en la sección write_status, por ejemplo:

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

Visualización de un destino utilizando la API

Puede utilizar el siguiente mandato de cURL para ver los detalles de configuración de 1 destino:

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

Donde

• <ENDPOINT> es el punto final de la API en la región donde tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales.
• <TARGET_ID> es el ID del destino.

Por ejemplo, puede ejecutar la siguiente solicitud cURL para obtener información sobre un destino con el 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"

Los resultados indicarán si el destino es COS ("target_type": "cloud_object_storage"), la oferta de IBM Cloud Logs ("target_type": "cloud_logs") o IBM Cloud App Configuration ("target_type": "app_config")

Listar todos los destinos utilizando la API

Puede utilizar el siguiente mandato cURL para ver todos los destinos:

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

Donde

• <ENDPOINT> es el punto final de la API en la región donde tiene previsto configurar o gestionar un destino. Para obtener más información, consulte Puntos finales.

Por ejemplo, puede ejecutar la siguiente solicitud cURL para obtener información sobre los destinos definidos en Dallas:

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

Los resultados indicarán si el destino es COS ("target_type": "cloud_object_storage"), la oferta de IBM Cloud Logs ("target_type": "cloud_logs") o IBM Cloud App Configuration ("target_type": "app_config")

Códigos de respuesta de HTTP

Cuando se utiliza la API REST de IBM Cloud Activity Tracker Event Routing, es posible obtener códigos de respuesta HTTP estándar para indicar si un método se ha completado satisfactoriamente.

• Una respuesta de 200 siempre indica éxito.
• Una respuesta 4xx indica una anomalía.
• Una respuesta 5xx normalmente indica un error interno del sistema.

Consulte la tabla siguiente para ver algunos códigos de respuesta HTTP: