Configuración de valores de cuenta

Puede configurar los ajustes de la cuenta IBM Cloud Logs Routing para definir dónde y cómo se recopilan, enrutan y gestionan los registros de la plataforma en su cuenta. Puede hacerlo a través de la interfaz de usuario, o utilizando la CLI, la API REST V3, o scripts Terraform.

Antes de inhabilitar los puntos finales públicos estableciendo --private-api-endpoint-only TRUE, asegúrese de que la cuenta tenga acceso al punto final privado. Puede hacerlo ejecutando el mandato ibmcloud account show. Si VRF Enabled es true y Service Endpoint Enabled es true, tendrá acceso al punto final privado. Si no tiene acceso al punto final privado, no podrá volver a habilitar el punto final público ya que el acceso de punto final privado es necesario para volver a habilitar el punto final público.

Para obtener más información, consulte Acerca de la configuración de la cuenta.

Permisos de IAM

Asegúrese de que dispone de los permisos IAM correctos para configurar los ajustes de IBM Cloud Logs Routing.

Obtener detalles de la configuración de la cuenta mediante la interfaz de usuario

Complete los siguientes pasos para ver la configuración de la cuenta de IBM Cloud Logs Routing mediante la interfaz de usuario:

  1. Conéctese a su cuenta IBM Cloud.

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

  3. Haga clic en Registro > Enrutamiento.

  4. Pulse el separador Valores.

En esta página puede ver los siguientes ajustes:

  • Ubicación de metadatos: Muestra la región de metadatos primaria y la región de metadatos de copia de seguridad.

  • Regiones objetivo permitidas. Muestra las regiones de destino a las que se pueden enviar los registros de la plataforma.

  • Objetivos por defecto: Muestra los objetivos por defecto configurados.

  • Puntos finales públicos: Muestra si los puntos finales públicos están habilitados. Cuando está desactivada, no se puede acceder a la interfaz de usuario IBM Cloud Logs Routing.

  • Informes: Muestra las configuraciones en formato JSON.

Actualizar la configuración de la cuenta mediante la interfaz de usuario

  1. Conéctese a su cuenta IBM Cloud.

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

  3. Haga clic en Registro >Ruta.

  4. Pulse el separador Valores.

  5. Haga clic en Editar junto al ajuste que desee modificar. Puede modificar los siguientes ajustes:

  • Ubicación de los metadatos: Seleccione la región de metadatos primaria y la región de metadatos de copia de seguridad que desee.

  • Regiones de destino permitidas: Seleccione la región en la que se pueden crear objetivos. Si no se selecciona ninguna región, todas las regiones pueden recibir los registros de la plataforma.

  • Destinos por defecto: Seleccione el destino que se utilizará por defecto cuando las reglas de enrutamiento no existan o no coincidan.

Requisitos previos de la CLI

Antes de utilizar la CLI para gestionar la configuración de cuentas de IBM Cloud Logs Routing, instale la CLI de IBM Cloud Logs Routing.

Compruebe que dispone de permisos IAM para leer, actualizar, o ambos, los ajustes de la cuenta IBM Cloud Logs Routing.

Obtención de detalles de la configuración de la cuenta mediante la CLI

Utilice este comando para obtener los ajustes de configuración de la cuenta IBM Cloud Logs Routing.

ibmcloud logs-router setting get [--output FORMAT]

Opciones de comando

--output FORMAT
Si se ha especificado JSON, 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 en el que no se han establecido objetivos predeterminados o permitidos.

Default Targets             -
Permitted Target Regions    -
Primary Metadata Region
Backup Metadata Region
Private Api Endpoint Only   false
Api Version                 1

Actualización de la configuración de la cuenta mediante la CLI

Utilice este mandato para modificar los valores de cuenta actuales, como los destinos predeterminados, las regiones de destino permitidas y la región de metadatos primaria.

ibmcloud logs-router setting update [--default-targets DEFAULT-TARGETS | @DEFAULT-TARGETS-FILE] [--permitted-target-regions PERMITTED-TARGET-REGIONS] [--primary-metadata-region PRIMARY-METADATA-REGION] [--backup-metadata-region BACKUP-METADATA-REGION] [--private-api-endpoint-only=PRIVATE-API-ENDPOINT-ONLY] [--output FORMAT] [--force]

Opciones de comando

primary-metadata-region

Especifique la región donde se almacenan los metadatos asociados a las definiciones de ruta y destino.

La longitud máxima es 256 caracteres. La longitud mínima es de 3 caracteres.

backup-metadata-region

Especifique la REGIÓN donde se almacenan los metadatos asociados a las definiciones de ruta y destino como copia de seguridad.

La longitud máxima es 256 caracteres. La longitud mínima es de 3 caracteres.

private-api-endpoint-only

Especifica si se puede utilizar un punto final privado. Si TRUE sólo se puede utilizar un punto final privado.

default-targets

Es una lista de ID de destino. Si ninguna regla de enrutamiento hace que los registros de la plataforma se envíen a otros destinos, estos destinos recibirán los registros de la plataforma. TARGETS es una lista separada por comas de ID de destino.

La longitud máxima es de 2 elementos. La longitud mínima es de 0 elementos.

permitted-target-regions

Es la lista de regiones que se pueden utilizar para definir un destino. REGIONS es una lista separada por comas de regiones.

La longitud máxima es de 16 elementos. La longitud mínima es de 0 elementos.

--output FORMAT

Si se especifica JSON, 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.

Si la actualización se realiza correctamente, se mostrarán los valores actuales.

Requisitos previos de la API

Para realizar llamadas de API para gestionar valores, 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 piensa configurar o gestionar valores. Para obtener más información, consulte Puntos finales.

Obtener detalles de la configuración de la cuenta mediante la API

Puede utilizar el siguiente mandato cURL para obtener información de valores existentes:

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

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 utilizar la siguiente solicitud cURL para obtener la información de configuración de la cuenta:

curl -X GET   https://api.<region>.logs-router.cloud.ibm.com/v3/settings   -H "Authorization:  $ACCESS_TOKEN"

Se devuelve una respuesta similar a la siguiente:

{
  "default_targets":[],
  "permitted_target_regions":[],
  "primary_metadata_region":"",
  "backup_metadata_region":"",
  "private_api_endpoint_only":false,
  "api_version":1
}

Donde:

default_targets
Es una lista de ID de destino. Si ninguna regla de enrutamiento hace que los registros de la plataforma se envíen a otros destinos, estos destinos recibirán los registros de la plataforma.
permitted_target_regions
Es la lista de regiones que se pueden utilizar para definir un destino. Se permite un máximo de dos regiones de destino.
primary_metadata_region
Es la región donde se almacenan los metadatos asociados a las definiciones de ruta y destino.
backup_metadata_region
Es la región donde se almacenan como copia de seguridad los metadatos asociados a las definiciones de ruta y destino.
private_api_endpoint_only
Especifica si se puede utilizar un punto final privado. Si true sólo se puede utilizar un punto final privado.
api_version
Es la versión de la API configurada para esta cuenta.

Actualización de la configuración de la cuenta mediante la API

Cuando actualices la configuración, ten en cuenta la siguiente información:

  • Debe incluir la información de configuración en la sección de datos de la solicitud.

  • Debe pasar los datos configurados para cada ajuste.

    Los datos configurados y no incluidos en una solicitud de actualización se eliminan.

  • Actualice los datos de los campos que deban modificarse.

  • El cambio de versión de la API sólo está permitido como parte del proceso de migración de V1 a V3. Véase Transición de v1 a v3.

Puede utilizar el siguiente mandato cURL para actualizar los valores:

curl -X PATCH   https://api.<region>.logs-router.cloud.ibm.com/v3/settings
-H "Authorization: Bearer <IAM_TOKEN>"
-H 'accept: application/json'
-d '{
    "default_targets": [
      {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      }
    ],
    "permitted_target_regions": ["us-south", "us-east"],
    "primary_metadata_region": "us-south",
    "backup_metadata_region": "us-east",
    "private_api_endpoint_only": false
  }'

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.
default_targets
Es una lista de ID de destino. Si ninguna regla de enrutamiento hace que los registros de la plataforma se envíen a otros destinos, estos destinos recibirán los registros de la plataforma.
permitted_target_regions
Es la lista de regiones que se pueden utilizar para definir un destino. Se puede especificar un máximo de dos regiones de destino permitidas.
primary_metadata_region
Es la región donde se almacenan los metadatos asociados a las definiciones de ruta y destino.
backup_metadata_region
Es la región donde se almacenan los metadatos asociados a las definiciones de ruta y destino con fines de copia de seguridad.
private_api_endpoint_only
Especifica si se puede utilizar o no un punto final privado. Si true sólo se puede utilizar un punto final privado.