IBM Cloud Docs
Gestión de rutas

Gestión de rutas

Puede gestionar las rutas de su cuenta mediante la IBM Cloud Metrics Routing UI, la IBM Cloud Metrics Routing CLI, la IBM Cloud Metrics Routing REST API, y el IBM Cloud Metrics Routing Terraform provider. Una ruta define las reglas que indican qué métricas se enrutan en una región y hacia dónde enrutarlas.

Para obtener más información sobre las rutas de IBM Cloud Metrics Routing, consulte rutas.

Acerca de las rutas

Puede configurar IBM Cloud Metrics Routing para enrutar las métricas de plataforma que se generan en diferentes regiones en las que se admite el servicio a un destino de destino.

  • Solo puede enrutar métricas de plataforma que se generen en regiones en las que IBM Cloud Metrics Routing esté disponible. Para obtener más información, consulte Regiones.

  • Si tiene requisitos normativos y de conformidad, compruebe que las reglas de ruta las cumplen.

Acceso de IAM

Debe tener los permisos de IAM correctos para gestionar rutas. Para obtener información, consulte Gestión del acceso de IAM.

Creación de una ruta mediante la interfaz de usuario

Haga lo siguiente para crear una ruta utilizando la interfaz de usuario.

  1. Inicia sesión en tu cuenta IBM Cloud.

  2. Pulse el icono Menú Icono Menú > Observabilidad.

  3. Pulse Supervisión.

  4. Haga clic en Enrutamiento.

  5. Haga clic en la pestaña Rutas.

  6. Haz clic en Crear para abrir la página de creación de rutas.

  7. Introduzca un nombre significativo para la ruta.

  8. Pulse Siguiente.

  9. En Reglas de enrutamiento, modifique la Acción de Regla 1:

    • Seleccione Send para que la regla enrute las métricas a los objetivos asociados.

    • Seleccione Drop para que la regla elimine las métricas que coincidan con esta regla.

  10. Añade los filtros de inclusión para determinar las métricas enrutadas a los objetivos especificados en la regla.

Seleccione el filtro y la condición deseados y especifique el valor que debe coincidir con el filtro de inclusión.

Para añadir varios filtros de inclusión, haga clic en Añadir filtro para añadir filtros adicionales.

  1. Añade el objetivo a asociar con la regla seleccionando un objetivo de la lista. Si no tiene ningún objetivo definido, haga clic en Añadir objetivo para crear uno nuevo.

  2. Haga clic en Añadir regla para añadir reglas adicionales a la ruta.

El orden de las reglas de ruta afecta al comportamiento del enrutamiento. Las reglas se procesan en orden y una vez que una regla coincide, las reglas siguientes no se procesan.

El orden de las reglas de enrutamiento puede modificarse haciendo clic en las flechas arriba y abajo situadas a la derecha de cada definición de regla.

Si necesita eliminar una regla o filtro, haga clic en el icono Eliminar asociado a la regla o filtro.

Puede configurar hasta 10 reglas por ruta.

  1. Una vez definida la ruta, haz clic en Siguiente.

  2. Revise la definición de la ruta asegurándose de que el orden de las reglas es el previsto.

  3. Pulse Crear.

Actualizar una ruta mediante la interfaz de usuario

Haga lo siguiente para actualizar una ruta utilizando la interfaz de usuario.

  1. Inicia sesión en tu cuenta IBM Cloud.

  2. Pulse el icono Menú Icono Menú > Observabilidad.

  3. Pulse Supervisión.

  4. Haga clic en Enrutamiento.

  5. Haga clic en la pestaña Rutas.

  6. Determine qué ruta desea actualizar y haga clic en el icono Acciones.

  7. Haz clic en Renombrar para cambiar el nombre de la ruta.

  8. Haga clic en Editar para actualizar las reglas de ruta.

  9. En Reglas de enrutamiento, modifique la Acción de la regla:

    • Seleccione Send para que la regla enrute las métricas a los objetivos asociados.

    • Seleccione Drop para que la regla elimine las métricas que coincidan con esta regla.

  10. Añada o modifique los filtros de inclusión para determinar las métricas enrutadas a los objetivos especificados en la regla.

Seleccione el filtro y la condición deseados y especifique el valor que debe coincidir con el filtro de inclusión.

Para añadir varios filtros de inclusión, haga clic en Añadir filtro para añadir filtros adicionales.

  1. Modifica el objetivo a asociar con la regla seleccionando un objetivo de la lista. Si no tiene ningún objetivo definido, haga clic en Añadir objetivo para crear uno nuevo.

  2. Haga clic en Añadir regla para añadir reglas adicionales a la ruta.

El orden de las reglas de ruta afecta al comportamiento del enrutamiento. Las reglas se procesan en orden y una vez que una regla coincide, las reglas siguientes no se procesan.

El orden de las reglas de enrutamiento puede modificarse haciendo clic en las flechas arriba y abajo situadas a la derecha de cada definición de regla.

Si necesita eliminar una regla o filtro, haga clic en el icono Eliminar asociado a la regla o filtro.

Puede configurar hasta 10 reglas por ruta.

  1. Haz clic en Actualizar para realizar cambios en tu ruta.

Visualización de una ruta mediante la interfaz de usuario

Haga lo siguiente para ver una ruta utilizando la interfaz de usuario.

  1. Inicia sesión en tu cuenta IBM Cloud.

  2. Pulse el icono Menú Icono Menú > Observabilidad.

  3. Pulse Supervisión.

  4. Haga clic en Enrutamiento.

  5. Haga clic en la pestaña Rutas.

    Se enumeran las rutas configuradas. El orden de las rutas no afecta al comportamiento del enrutamiento, ya que se procesan de forma independiente.

    Cada ruta muestra el nombre de la ruta y las reglas.

    La página de rutas también muestra Guía de enrutamiento con información adicional sobre la configuración del enrutamiento.

Supresión de una ruta mediante la interfaz de usuario

Haga lo siguiente para eliminar una ruta utilizando la interfaz de usuario.

  1. Inicia sesión en tu cuenta IBM Cloud.

  2. Pulse el icono Menú Icono Menú > Observabilidad.

  3. Pulse Supervisión.

  4. Haga clic en Enrutamiento.

  5. Haga clic en la pestaña Rutas.

  6. Determine qué ruta desea eliminar y haga clic en el icono Acciones.

  7. Haz clic en Borrar para borrar toda la ruta. Debe introducir el nombre de la ruta antes de borrarla.

Requisitos previos de la CLI

Antes de utilizar la CLI para gestionar rutas, complete los siguientes pasos:

  1. Instale la CLI de IBM Cloud.

  2. Instale la CLI de IBM Cloud Metrics Routing.

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

Creación de una ruta con la CLI

Utilice este comando para crear una ruta.

Los nombres de ruta son exclusivos en la cuenta.

ibmcloud metrics-router route create --name ROUTE_NAME ( --rules RULES |  --file RULES_DEFINITION_JSON_FILE ) [--output FORMAT] [--force]

Opciones de mandato

--name ROUTE_NAME

El nombre que se le dará a la ruta.

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

--rules RULES

Definición de matriz de reglas con formato JSON entre comillas simples que definen cómo se direccionan las métricas. Para obtener más información, consulte Definición de reglas de direccionamiento.

--file RULES_DEFINITION_JSON_FILE

Archivo JSON que incluye las reglas de direccionamiento que definen cómo se direccionan las métricas. Para obtener más información, consulte Definición de reglas de direccionamiento.

--output FORMAT

El formato soportado actualmente es JSON. Si se especifica, la salida se devolverá en formato JSON. Si no se ha especificado JSON, la salida se devolverá en un formato tabular.

help | --help | -h

Listar las opciones disponibles para el mandato.

Ejemplo

A continuación se muestra un ejemplo utilizando el mandato ibmcloud metrics-router route create.

Este ejemplo muestra un ejemplo de creación de ruta con éxito.

ibmcloud mr route create --name target1 --rules '[{"action": "send", "targets":[{"id":"551957a7-c1e3-4160-84d8-4268709f6743"}]}]'
OK
Route
Name:         target1
ID:           06a29ca2-40f5-4371-ae3c-76a896577bd3
CRN:          crn:v1:bluemix:public:metrics-router:global:a/xxxx::route:06a29ca2-40f5-4371-ae3c-76a896577bd3
Rule 0:       [[551957a7-c1e3-4160-84d8-4268709f6743(mon-std)], []]
Created At:   2023-05-30T21:14:21.460Z
Updated At:   2023-05-30T21:14:21.460Z

Actualización de una ruta utilizando la CLI

Utilice este comando para actualizar una ruta. Cualquier valor especificado que sea distinto de cuando se creó originalmente la ruta se actualizará al valor especificado en el mandato.

ibmcloud metrics-router route update --route ROUTE [--name ROUTE_NAME] ( --rules RULES |  --file RULES_DEFINITION_JSON_FILE ) [--output FORMAT] [--force]

Opciones de mandato

--route ROUTE

El ID o nombre de la ruta actual.

--name route_NAME

El nombre que se le dará a la ruta.

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

--rules RULES

Definición de matriz de reglas con formato JSON entre comillas simples que definen cómo se direccionan las métricas. Para obtener más información, consulte Definición de reglas de direccionamiento.

--file RULES_DEFINITION_JSON_FILE

Archivo JSON que incluye las reglas de direccionamiento que definen cómo se direccionan las métricas. Para obtener más información, consulte Definición de reglas de direccionamiento.

--output FORMAT

El formato soportado actualmente es JSON. Si se especifica, la salida se devolverá en formato JSON. Si no se ha especificado JSON, la salida se devolverá en un formato tabular.

help | --help | -h

Listar las opciones disponibles para el mandato.

Ejemplo

A continuación se muestra un ejemplo utilizando el mandato ibmcloud metrics-router route update --route my-route --name my-new-route-name.

ibmcloud mr route update --route target1 --name target2
OK
Route
Name:         target2
ID:           06a29ca2-40f5-4371-ae3c-76a896577bd3
CRN:          crn:v1:bluemix:public:metrics-router:global:a/xxxx::route:06a29ca2-40f5-4371-ae3c-76a896577bd3
Rule 0:       [[551957a7-c1e3-4160-84d8-4268709f6743(mon-std)], []]
Created At:   2023-05-30T21:14:21.460Z
Updated At:   2023-05-30T21:19:40.953Z

Supresión de una ruta mediante la CLI

Utilice este comando para eliminar una ruta.

ibmcloud metrics-router ROUTE rm --route route [--force]

Opciones de mandato

--route ROUTE
El ID o el nombre de la ruta.
--force | -f
Se suprimirá la ruta sin proporcionar al usuario ningún mensaje adicional.
help | --help | -h
Listar las opciones disponibles para el mandato.

Ejemplo

A continuación se muestra un ejemplo utilizando el mandato ibmcloud metrics-router route rm --route xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

Are you sure you want to remove the route with route ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx? [y/N]>y
OK
Route with name xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx was successfully removed.

Obtener información sobre una ruta utilizando la CLI

Utilice este mandato para obtener información sobre una ruta para una región de IBM Cloud Metrics Routing.

ibmcloud metrics-router ROUTE get --route route [--output FORMAT]

Opciones de mandato

--route ROUTE
El ID o el nombre de la ruta.
--output FORMAT
El formato soportado actualmente es JSON. Si se especifica, la salida se devolverá en formato JSON. Si no se ha especificado JSON, la salida se devolverá en un formato tabular.
help | --help | -h
Listar las opciones disponibles para el mandato.

Ejemplo

A continuación se muestra un ejemplo de utilización del mandato ibmcloud metrics-router route get --route new-route-name que muestra una ruta.

ibmcloud mr route get --route route-all
OK
Route
Name:         route-all
ID:           f22e9cb6-2fcd-456d-9cf2-27813b1cc375
CRN:          crn:v1:bluemix:public:metrics-router:global:a/xxxx::route:f22e9cb6-2fcd-456d-9cf2-27813b1cc375
Rule 0:       [[551957a7-c1e3-4160-84d8-4268709f6743(mon-std)], []]
Created At:   2023-05-30T08:04:53.183Z
Updated At:   2023-05-30T08:53:22.824Z

Listado de todas las rutas de una región

Utilice este comando para listar las rutas configuradas para una región IBM Cloud Metrics Routing.

ibmcloud metrics-router route ls [--output FORMAT]

Opciones de mandato

--output FORMAT
El formato soportado actualmente es JSON. Si se especifica, la salida se devolverá en formato JSON. Si no se ha especificado JSON, la salida se devolverá en un formato tabular.
help | --help | -h
Listar las opciones disponibles para el mandato.

Ejemplo

A continuación se muestra un ejemplo utilizando el mandato ibmcloud metrics-router route ls.

ibmcloud mr route ls
OK
Routes
Name:         route-all
ID:           f22e9cb6-2fcd-456d-9cf2-27813b1cc375
CRN:          crn:v1:bluemix:public:metrics-router:global:a/xxxx::route:f22e9cb6-2fcd-456d-9cf2-27813b1cc375
Rule 0:       [[551957a7-c1e3-4160-84d8-4268709f6743(mon-std)], []]
Created At:   2023-05-30T08:04:53.183Z
Updated At:   2023-05-30T08:53:22.824Z

Rutas y acciones de la API

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

acciones de ruta utilizando la IBM Cloud Metrics Routing API REST
Acción Método de API REST API_URL
Crear una ruta POST <ENDPOINT>/api/v3/routes
Actualizar una ruta PATCH <ENDPOINT>/api/v3/routes/<route_ID>
Suprimir una ruta DELETE <ENDPOINT>/api/v3/routes/<route_ID>
Leer una ruta GET <ENDPOINT>/api/v3/routes/<route_ID>
Listar todas las rutas GET <ENDPOINT>/api/v3/routes

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 siguiente formato: https://private.REGION.metrics-router.cloud.ibm.com

  • Puede gestionar rutas desde la red pública utilizando un punto final de API con el siguiente formato: https://REGION.metrics-router.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 valores de ruta 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

Puede utilizar el siguiente mandato cURL para crear una ruta:

Los nombres de ruta son exclusivos en la cuenta. No puede reutilizar un nombre de ruta para configurar varios destinos.

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

Donde

<ENDPOINT>

En la región en la que tiene previsto configurar o gestionar una ruta. Para obtener más información, consulte Puntos finales.

ROUTE_NAME

El nombre que se le dará a la ruta.

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

RULES

Definición de matriz de reglas con formato JSON entre comillas simples que definen cómo se direccionan las métricas. Para obtener más información, consulte Definición de reglas de direccionamiento.

Por ejemplo, puede utilizar la siguiente solicitud cURL para crear una ruta:

curl -X POST https://private.us-south.metrics-router.cloud.ibm.com/api/v3/routes -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
    "name": "My-route",
    "rules": [
      {
        "action": "send",
        "targets": [
          {
            "id": "50375218-7cff-4234-bbb4-171bebab8408"
          },
          {
            "id": "c7519d8a-5f97-498b-a229-8542f60955cd"
          }
        ],
        "inclusion_filters": [
          {
            "operand": "location",
            "operator": "is",
            "values": ["us-east"]
          },
          {
            "operand": "service_name",
            "operator": "in",
            "values": ["codeengine","container-registry"]
          }
        ]
      }
    ]
  }'

Actualización de una ruta utilizando la API

Puede modificar el nombre de una ruta y reglas. Cualquier valor especificado que sea diferente de cuando se creó originalmente la ruta se actualizará al valor especificado en la solicitud.

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 deben cambiarse.

Los nombres de ruta son exclusivos en la cuenta. No puede reutilizar un nombre de ruta para configurar varios destinos.

Puede utilizar el mandato cURL siguiente para actualizar una ruta:

curl -X PATCH <ENDPOINT>/api/v3/routes/ROUTE_ID -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
    "name": "ROUTE_NAME",
    "rules": [
      RULES
    ]
  }'

Donde

<ENDPOINT>

En la región en la que tiene previsto configurar o gestionar una ruta. Para obtener más información, consulte Puntos finales.

ROUTE_ID

ID de la ruta.

ROUTE_NAME

Nombre de la ruta. La longitud máxima del nombre es de 256 caracteres.

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

RULES

Definición de matriz de reglas con formato JSON entre comillas simples que definen cómo se direccionan las métricas. Para obtener más información, consulte Definición de reglas de direccionamiento.

Por ejemplo, puede utilizar la siguiente solicitud cURL para crear una ruta en Dallas:

curl -X PATCH https://private.us-south.metrics-router.cloud.ibm.com/api/v3/routes -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
    "name": "My route",
    "rules": [
      {
        "action": "send",
        "targets": [
          {
            "id": "50375218-7cff-4234-bbb4-171bebab8408"
          },
          {
            "id": "c7519d8a-5f97-498b-a229-8542f60955cd"
          }
        ],
        "inclusion_filters": [
          {
            "operand": "location",
            "operator": "is",
            "values": ["us-east"]
          },
          {
            "operand": "service_name",
            "operator": "in",
            "values": ["codeengine","container-registry"]
          }
        ]
      }
    ]
    }
  }'

Supresión de una ruta mediante la API

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

curl -X DELETE <ENDPOINT>/api/v3/routes/<route_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

Donde

<ENDPOINT>
En la región en la que tiene previsto configurar o gestionar una ruta. Para obtener más información, consulte Puntos finales.
<route_ID>
ID de la ruta.

Por ejemplo, puede utilizar la siguiente petición cURL para eliminar una ruta con el ID ' 00000000-0000-0000-0000-000000000000:

curl -X DELETE https://private.us-south.metrics-router.cloud.ibm.com/api/v3/routes/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

Visualización de una ruta utilizando la API

Puede utilizar el siguiente comando cURL para ver los detalles de configuración de 1 ruta:

curl -X GET <ENDPOINT>/api/v3/routes/<route_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

Donde

<ENDPOINT>
En la región en la que tiene previsto configurar o gestionar una ruta. Para obtener más información, consulte Puntos finales.
<route_ID>
ID de la ruta.

Por ejemplo, puede ejecutar la siguiente solicitud cURL para obtener información sobre una ruta con el ID 00000000-0000-0000-0000-000000000000:

curl -X GET https://private.us-south.metrics-router.cloud.ibm.com/api/v3/routes/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

Listado de todas las rutas que utilizan la API

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

curl -X GET <ENDPOINT>/api/v3/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 Dallas:

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

Códigos de respuesta de HTTP

Cuando se utiliza la API REST de IBM Cloud Metrics 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 indica un error interno del sistema.

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

Lista de códigos de respuesta HTTP
Código de estado Estado Descripción
200 OK La solicitud se ha realizado correctamente.
201 OK La solicitud se ha realizado correctamente. Se crea un recurso.
400 Solicitud errónea La solicitud no ha sido satisfactoria. Es posible que falte un parámetro que sea necesario.
401 No autorizado La señal de IAM que se utiliza en la solicitud de API no es válida o ha caducado.
403 Prohibido La operación está prohibida debido a permisos insuficientes.
404 No encontrado El recurso solicitado no existe o ya se ha suprimido.
429 Demasiadas solicitudes Demasiadas solicitudes han llegado a la API demasiado rápido.
500 Error de servidor interno Algo ha fallado en el proceso de IBM Cloud Metrics Routing.