Requisitos previos de la CLI

Antes de utilizar la CLI para gestionar rutas, instala en tu sistema local la última versión del complemento de la CLI de Activity Tracker Event Routing V2. Consulte Instalación de la CLI de Activity Tracker Event Routing.

A continuación, inicie la sesión en IBM Cloud. Ejecute el siguiente mandato: ibmcloud login

Creación de una ruta mediante la CLI

Utilice este mandato para crear una ruta nueva para un destino de Activity Tracker Event Routing.

ibmcloud atracker route create --name ROUTE_NAME  ( --target-ids TARGETS  [--locations REGIONS] | --rules RULES | --file RULES_DEFINITION_JSON_FILE ) [--output FORMAT]

OK
Route
Name:                    dev-eu-de-route
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 0
Rules:                   [locations: [us-south], target_ids: [33333333-3333-3333-3333-333333333333]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:10:09.996Z

Actualización de una ruta utilizando la CLI

Utilice este mandato para actualizar una ruta para un destino de Activity Tracker Event Routing. Cualquier valor especificado que sea distinto de cuando se creó originalmente la ruta se actualizará al valor especificado en el mandato.

ibmcloud atracker route update --route ROUTE [--name ROUTE_NAME] [--force] ( [--target-ids TARGETS]  [--locations REGIONS] | [--rules RULES] | [--file RULES_DEFINITION_JSON_FILE] ) [--output FORMAT] [--output FORMAT]

OK
Route
Name:                    dev-eu-de-route
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 1
Rules:                   [locations: [*], target_ids: [55555555-5555-5555-5555-555555555555]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:13:37.218Z

Supresión de una ruta mediante la CLI

Utilice este mandato para suprimir una ruta de Activity Tracker Event Routing.

ibmcloud atracker route rm --route ROUTE [--force]

Are you sure you want to remove the route with the Route ID 44444444-4444-4444-4444-444444444444? [y/N]> y
OK
Route with route ID 44444444-4444-4444-4444-444444444444 was successfully removed.

FAILED
No route found with route name - 33333333-3333-3333-3333-333333333333

Visualización de una ruta utilizando la CLI

Utilice este mandato para obtener información sobre una ruta de Activity Tracker Event Routing.

ibmcloud atracker route get --route ROUTE [--output FORMAT]

OK
Route
Name:                    dev-eu-de-route-0
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 2
Rules:                   [locations: [us-south], target_ids: [55555555-5555-5555-5555-555555555555]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:15:07.281Z

Listar todas las rutas utilizando la CLI

Utilice este mandato para listar todas las rutas configuradas para Activity Tracker Event Routing.

ibmcloud atracker route ls [--output FORMAT]

Name                      ID                                     Rules                                              Route Version   API version   CreatedAt                  UpdatedAt
my-global-route           aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa   [[11111111-1111-1111-1111-111111111111],[global]]  5               2             2022-05-04T20:18:00.595Z   2022-05-05T19:04:58.374Z
send-all-to-us-east       bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb   [[22222222-2222-2222-2222-222222222222],[*]]       0               2             2022-05-06T12:02:47.832Z   2022-05-06T12:02:47.832Z

Rutas y acciones de la API

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

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

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

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

• Dado que las rutas son configuraciones globales, puede utilizar cualquier punto final regional para gestionar las rutas de la cuenta.

• 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 Rutas.

Requisitos previos de la API

Para realizar llamadas de API con el fin de gestionar rutas, realice 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 una ruta. Para obtener más información, consulte Puntos finales.

Creación de una ruta mediante la API

Debe crear un destino antes de crear una ruta.

Puede utilizar el siguiente mandato cURL para crear una ruta:

curl -X POST  <ENDPOINT>/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "ROUTE_NAME",
    "rules": [
      {
        "locations": ["LOCATIONS"],
        "target_ids": ["TARGET_ID"]
      }
    ]
  }'

Donde

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

• ROUTE_NAME es el nombre de la ruta. La longitud máxima del nombre es de 180 caracteres y no puede incluir ninguno de los caracteres especiales siguientes:-, ., _ y :.

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

• LOCATIONS es una lista de ubicaciones asociadas a la ruta. Especifique global para incluir sucesos globales. Para incluir todas las ubicaciones, especifique *. Si tiene varias reglas, junto con una regla con una ubicación *, las otras reglas direccionarán los sucesos a los destinos especificados con cualquier suceso que no coincida con ninguna otra regla que direccione los sucesos restantes al destino especificado por la regla con la ubicación *.

• TARGET_ID es el GUID del destino que define dónde se direccionan y recopilan los sucesos de auditoría. Esto puede incluir los GUID de destinos en otras regiones. Si TARGET_ID está vacío, los sucesos que coincidan con la regla se descartarán.

Por ejemplo, puede utilizar la siguiente solicitud cURL para crear una ruta que defina cómo se recopilan y direccionan los sucesos basados en la ubicación EE. UU. sur y globales en la cuenta:

curl -X POST   https://private.us-south.atracker.cloud.ibm.com/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "my-route",
    "rules": [
      {
        "locations": ["us-south", "global"],
        "target_ids": ["22222222-2222-2222-2222-222222222222"]
      }
    ]
  }'

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

Actualización de una ruta utilizando la API

Al actualizar una ruta, debe incluir la información de ruta en la sección de datos de la solicitud.

• Debe pasar todos los campos.
• Actualice los campos que necesitan cambiar.

Puede utilizar el mandato cURL siguiente para actualizar una ruta:

curl -X PUT  <ENDPOINT>/api/v2/routes/<ROUTE_ID>   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "ROUTE_NAME",
    "rules": [
      {
        "locations": ["LOCATIONS"],
        "target_ids": ["TARGET_ID"]
      }
    ]
  }'

Donde

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

• <ROUTE_ID> es el ID de la ruta que se va a actualizar

• ROUTE_NAME es el nombre de la ruta. La longitud máxima del nombre es de 180 caracteres y no puede incluir ninguno de los caracteres especiales siguientes:-, ., _ y :.

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

• LOCATIONS es una lista de ubicaciones asociadas a la ruta. Especifique global para incluir sucesos globales. Para incluir todas las ubicaciones, especifique *. Si tiene varias reglas, junto con una regla con una ubicación *, las otras reglas direccionarán los sucesos a los destinos especificados con cualquier suceso que no coincida con ninguna otra regla que direccione los sucesos restantes al destino especificado por la regla con la ubicación *.

• TARGET_ID es el GUID del destino que define dónde se direccionan y recopilan los sucesos de auditoría. Esto puede incluir los GUID de destinos en otras regiones. Si TARGET_ID está vacío, los sucesos que coincidan con la regla se descartarán.

Por ejemplo, puede utilizar la siguiente solicitud cURL para actualizar una ruta que defina cómo se recopilan y direccionan los sucesos basados en las ubicaciones EE.UU. sur y EE.UU. este y globales en la cuenta:

curl -X PUT https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "my-route",
    "rules": [
      {
        "locations": ["us-south", "global", "us-east],
        "target_ids": ["22222222-2222-2222-2222-222222222222"]
      }
    ]
  }'

Supresión de una ruta mediante la API

Puede utilizar el mandato de cURL siguiente para suprimir una ruta:

curl -X DELETE   <ENDPOINT>/api/v2/routes/<ROUTE_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 una ruta. Para obtener más información, consulte Puntos finales.
• <ROUTE_ID> es el ID de la ruta que se va a suprimir

Por ejemplo, puede ejecutar la siguiente solicitud cURL para suprimir la ruta con el ID aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa:

curl -X DELETE  https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

Visualización de una ruta utilizando la API

Puede utilizar el mandato de cURL siguiente para ver una ruta:

curl -X GET   <ENDPOINT>/api/v2/routes/<ROUTE_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 una ruta. Para obtener más información, consulte Puntos finales.
• <ROUTE_ID> es el ID de la ruta que se va a captar

Por ejemplo, puede ejecutar la siguiente solicitud cURL para obtener información sobre una ruta con el ID aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa:

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

Listado de todas las rutas de una región utilizando la API

Puede utilizar el mandato de cURL siguiente para ver todas las rutas:

curl -X GET   <ENDPOINT>/api/v2/routes   -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 una ruta. Para obtener más información, consulte Puntos finales.

Por ejemplo, puede ejecutar la siguiente solicitud cURL para obtener información sobre las rutas definidas en EE.UU. sur:

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

Códigos de respuesta de HTTP

Cuando se utiliza la API REST de 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:

Creación de una ruta mediante la interfaz de usuario

1. Inicie sesión en su cuenta de IBM Cloud.
2. Haz clic en el icono de menú > Observabilidad.
3. Selecciona « Seguimiento de la actividad ».
4. Seleccione Rutas.
5. Haz clic en «Crear» para abrir la página de creación.
6. Especifique un nombre significativo para la ruta.
7. En Reglas de direccionamiento, modifique la Regla 1:
   • Enviar sucesos de auditoría desde: seleccione las ubicaciones de sucesos de auditoría que coincidirán con esta regla.
   • A destinos: Seleccione un destino que se adjuntará a esta regla. Pulse Añadir destino para añadir más destinos a la regla.
8. Pulse Añadir regla para añadir reglas adicionales a la ruta.
   • El orden de las reglas de ruta afecta al comportamiento de direccionamiento. Las reglas se procesan en orden y una vez que una regla coincide, las reglas posteriores no se procesan.
9. Cada regla tiene una flecha arriba y abajo que le permite cambiar el orden de la regla.
10. Cada regla tiene un botón Eliminar que le permite suprimir una regla de una ruta.
11. Revise la definición de ruta asegurándose de que el orden de las reglas sea el previsto.
12. Pulse Crear.

Actualización de una ruta mediante la interfaz de usuario

1. Inicie sesión en su cuenta de IBM Cloud.
2. Haz clic en el icono de menú > Observabilidad.
3. Selecciona « Seguimiento de la actividad ».
4. Seleccione Rutas.
5. Determine qué ruta desea actualizar y pulse el .
6. Pulse Renombrar para cambiar el nombre de la ruta.
7. Pulse Editar para actualizar las reglas de ruta.
8. Si lo desea, edite las reglas existentes:
   • Enviar sucesos de auditoría desde: seleccione las ubicaciones de sucesos de auditoría que coincidirán con esta regla.
   • A destinos: Seleccione un destino que se adjuntará a esta regla. Pulse Añadir destino para añadir más destinos a la regla.
9. Pulse Añadir regla para añadir reglas adicionales a la ruta.
   • El orden de las reglas de ruta afecta al comportamiento de direccionamiento. Las reglas se procesan en orden y una vez que una regla coincide, las reglas posteriores no se procesan.
10. Cada regla tiene una flecha arriba y abajo que le permite cambiar el orden de la regla.
11. Cada regla tiene un botón Eliminar que le permite suprimir una regla de una ruta.
12. Pulse Actualizar para realizar cambios en la ruta.

Visualización de una ruta mediante la interfaz de usuario

1. Inicie sesión en su cuenta de IBM Cloud.
2. Haz clic en el icono de menú > Observabilidad.
3. Selecciona « Seguimiento de la actividad ».
4. Seleccione Rutas.
5. La tabla de rutas se ordena por fecha de creación. El orden de las rutas no afecta al comportamiento de direccionamiento.
6. Cada bloque de ruta muestra el nombre de ruta y las reglas.
7. La página Rutas también muestra Guía de direccionamiento con información adicional sobre la configuración del direccionamiento.

Supresión de una ruta mediante la interfaz de usuario

1. Inicie sesión en su cuenta de IBM Cloud.
2. Haz clic en el icono de menú > Observabilidad.
3. Selecciona « Seguimiento de la actividad ».
4. Seleccione Rutas.
5. Determine qué ruta desea actualizar y pulse el .
6. Pulse Suprimir para suprimir toda la ruta. Debe especificar el nombre de ruta antes de suprimir la ruta.