Configurando as definições de conta

Você pode configurar as definições da conta do Activity Tracker Event Routing em sua conta usando a CLI do Activity Tracker Event Routing, a API REST do Activity Tracker Event Routing e scripts do Terraform. Defina essas configurações para definir onde e como os eventos de auditoria são coletados, roteados e gerenciados em sua conta.

Ao configurar ou modificar as configurações da conta Activity Tracker Event Routing, leve em consideração as seguintes informações:

Sempre que você alterar as configurações da conta Activity Tracker Event Routing, os dados enviados na nova solicitação substituirão quaisquer dados de configuração existentes. Deve-se garantir que quaisquer dados existentes não sejam excluídos ao executar uma atualização das configurações da conta, incluindo-a na nova solicitação.
Antes de desativar os terminais públicos, configurando --private-api-endpoint-only TRUE, certifique-se de que sua conta tenha acesso ao terminal privado. Você pode fazer isso executando o comando ibmcloud account show. Se VRF Enabled for true e Service Endpoint Enabled for true, você tem acesso ao terminal privado. Se você não tiver acesso ao terminal privado, poderá reativar o terminal público, uma vez que o acesso ao terminal privado é necessário para reativar o terminal público.

Quais dados você pode configurar nas configurações da conta do IBM Cloud® Activity Tracker Event Routing?

É possível definir qualquer uma das informações a seguir:

O local na sua conta do IBM Cloud onde os metadados de configuração da conta Activity Tracker Event Routing estão armazenados.

Por metadados, nos referimos aos dados de destino / rota / configurações que estão disponíveis em toda a conta em qualquer região.

Você pode escolher qualquer um dos locais compatíveis onde o serviço “ Activity Tracker Event Routing ” estiver disponível. Para obter mais informações, consulte Locais.

Leve em consideração quaisquer requisitos corporativos ou de conformidade com o setor de mercado, como locais Serviços Financeiros Validados, ou regiões gerenciadas pela União Europeia.
O tipo de pontos finais autorizados a gerenciar a configuração da conta do Activity Tracker Event Routing na conta.

É possível configurar terminais públicos, terminais privados ou ambos.
As localizações onde um administrador de conta pode definir destinos para coletar eventos de auditoria.

Você pode escolher qualquer um dos locais compatíveis onde o serviço “ Activity Tracker Event Routing ” estiver disponível. Para obter mais informações, consulte Locais.

Leve em consideração quaisquer requisitos corporativos ou de conformidade com o setor de mercado, como locais Serviços Financeiros Validados, ou regiões gerenciadas pela União Europeia.
Há um ou mais alvos na conta que coletarão eventos de auditoria de locais compatíveis com o Activity Tracker Event Routing, nos quais você ainda não configurou como deseja coletar os dados de auditoria.

Se você definir mais de 1 de destino, todos os destinos padrão obtêm uma cópia de eventos de auditoria que não possuem uma regra de roteamento para indicar onde coletá-los na conta. É possível definir até 2 destinos padrão por conta.

Permissões do IAM

Deve-se conceder aos usuários permissões do IAM para gerenciar as configurações da conta Para obter mais informações, consulte Designar acesso a recursos

Se você tiver a permissão do IAM para criar políticas e autorizações, poderá conceder apenas o nível de acesso que possui como usuário do serviço de destino. Por exemplo, se você tiver acesso de visualizador ao serviço de destino, poderá atribuir apenas a função de visualizador para a autorização. Se você tentar atribuir uma permissão mais alta, como administrador, pode parecer que a permissão foi concedida; no entanto, somente a permissão de nível mais alto que você tem para o serviço de destino, ou seja, visualizador, será atribuída.

Ao definir uma política, é possível configurar o escopo da política para a conta.. Uma rota é um recurso global que não está ligado a uma região específica..

Required IAM roles
AÇÃO DO IAM	escopo da Política do IAM	Funções do IAM	Descrição
`atracker.setting.get`	Conta	`Administrator` `Editor` `Viewer` `Operator`	Obter informações de configurações
`atracker.setting.update`	Conta	`Administrator`	Atualizar configurações

Pré-requisitos da CLI

Antes de usar a CLI para gerenciar configurações da conta do Activity Tracker Event Routing, Instale a IBM Cloud Activity Tracker Event Routing CLI.

Verifique se você possui permissões do IAM para ler ou atualizar as configurações da conta do Activity Tracker Event Routing.

Obtendo configurações da conta usando a CLI

Use este comando para obter as configurações da conta IBM Cloud Activity Tracker Event Routing.

ibmcloud atracker setting get [--output FORMAT]

Opções de comando

--output FORMAT: Se o JSON for especificado, a saída será devolvida no formato JSON. Se o JSON não for especificado, a saída será retornada em um formato tabular.
help | --help | -h: Liste as opções disponíveis para o comando.

Exemplo

A seguir está um exemplo em que não foram definidos destinos padrão ou permitidos e a versão da API é V2.

Atracker settings
Metadata region primary:     us-south
Metadata region backup:      us-east
Default targets:             []
Permitted target regions:    []
Private api endpoint only:   false
API version:                 2

Atualizando configurações usando a CLI

Use este comando para modificar configurações da conta atual, como os destinos padrão, regiões de destino permitidas e a região de metadados primários.

ibmcloud atracker setting update [--metadata-region-primary REGION] [--metadata-region-backup REGION] [--default-targets TARGET] [--permitted-target-regions REGIONS] [--private-api-endpoint-only ( TRUE | FALSE )] [--output FORMAT] [--force]

Opções de comando

default-targets: É uma lista de IDs de destino. Se nenhuma regra de roteamento fizer com que eventos sejam enviados para outros destinos, esses destinos receberão os eventos. TARGETS é uma lista de IDs de destino separados por vírgula
permitted-target-regions: É a lista de regiões que podem ser usadas para definir um destino. REGIONS é uma lista de regiões separadas por vírgula. Pode ser especificado um máximo de duas regiões de destino permitidas.
metadata-region-primary: Especifique a REGION onde os metadados associados à rota e definições de destino são armazenados.
metadata_region_backup: É a região onde os metadados associados às definições de rota e destino são armazenados como local de backup.
private-api-endpoint-only: Especifica se um terminal privado pode ou não ser usado. Se true, apenas um terminal privado pode ser usado.
--output FORMAT: Se JSON for especificado, a saída será retornada no formato JSON. Se o JSON não for especificado, a saída será retornada em um formato tabular.
help | --help | -h: Liste as opções disponíveis para o comando.

Se a atualização for bem-sucedida, as configurações atuais serão exibidas.

Ações e configurações da API

A tabela a seguir lista as ações possíveis de executar para gerenciar configurações:

Ações de configuração usando a IBM Cloud Activity Tracker Event Routing API REST
Ação	Método de API de REST	API_URL
Obter informações de configurações	`GET`	`<ENDPOINT>/api/v2/settings`
Atualizar configurações	`PUT`	`<ENDPOINT>/api/v2/settings`

É possível usar terminais privados e públicos para gerenciar configurações. Para obter mais informações sobre a lista de ENDPOINTS disponíveis, consulte Terminais.

Por padrão, é possível gerenciar configurações a partir da rede privada. Deve-se usar um terminal de API com o formato a seguir: https://private.<region>.atracker.cloud.ibm.com
Também pode-se ativar terminais públicos em uma região para gerenciar configurações. Para obter mais informações, consulte Gerenciando terminais.

Para obter mais informações sobre a API REST, consulte a API de configurações.

Pré-requisitos da API

Para fazer chamadas de API para gerenciar configurações, conclua as etapas a seguir:

Obtenha um token de acesso do IAM. Para obter mais informações, consulte Recuperando tokens de acesso do iAM.
Identifique o terminal da API na região onde planeja-se configurar ou gerenciar configurações. Para obter mais informações, consulte Terminais.

Obtendo configurações usando a API

É possível usar o comando cURL a seguir para obter informações de configurações existentes:

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

Em que:

ENDPOINT: É o terminal da API na região onde planeja-se configurar ou gerenciar um destino. Para obter mais informações, consulte Terminais.

Por exemplo, pode-se utilizar as informações de configurações da solicitação cURL a seguir da região US South:

curl -X GET   https://private.us-south.atracker.cloud.ibm.com/api/v2/settings   -H "Authorization:  $ACCESS_TOKEN"

Uma resposta semelhante à resposta a seguir é retornada:

{
 "default_targets": ["50375218-0000-4234-bbb4-171bebab8408", "c7519d8a-5f97-498b-0000-8542f60955cd"],
 "permitted_target_regions": ["us-south", "us-east"],
 "metadata_region_primary": "us-south",
 "metadata_region_backup": "eu-de",
 "private_api_endpoint_only": false
}

Em que:

default_targets: É uma lista de IDs de destino. Se nenhuma regra de roteamento fizer com que eventos sejam enviados para outros destinos, esses destinos receberão os eventos.
permitted_target_regions: É a lista de regiões que podem ser usadas para definir um destino. É permitido um máximo de duas regiões de destino permitidas.
metadata_region_primary: É a região onde os metadados associados à rota e definições de destino são armazenados.
metadata_region_backup: É a região onde os metadados associados às definições de rota e destino são armazenados como local de backup.
private_api_endpoint_only: Especifica se um terminal privado pode ou não ser usado. Se true, apenas um terminal privado pode ser usado.

Atualizando configurações usando a API

Ao atualizar as configurações, deve-se incluir as informações de configurações na seção de dados da solicitação.

Deve-se ter aprovação em todos os campos.
Atualize os campos que precisam de alteração.

É possível usar o comando cURL a seguir para atualizar configurações:

curl -X PUT  <ENDPOINT>/api/v2/settings
-H "Authorization:  $ACCESS_TOKEN"
-H "content-type: application/json"
-d '{
   "default_targets": ["IDs"],
   "permitted_target_regions": ["REGIONS"],
   "metadata_region_primary": "REGION",
   "metadata_region_backup": "REGION",
   "private_api_endpoint_only": false
}'

Em que:

ENDPOINT: É o terminal da API na região onde planeja-se configurar ou gerenciar um destino. Para obter mais informações, consulte Terminais.
default_targets: É uma lista de IDs de destino. Se nenhuma regra de roteamento fizer com que eventos sejam enviados para outros destinos, esses destinos receberão os eventos.
permitted_target_regions: É a lista de regiões que podem ser usadas para definir um destino. Pode ser especificado um máximo de duas regiões de destino permitidas.
metadata_region_primary: É a região onde os metadados associados à rota e definições de destino são armazenados.
metadata_region_backup: É a região onde os metadados associados às definições de rota e destino são armazenados como local de backup.
private_api_endpoint_only: Especifica se um terminal privado pode ou não ser usado. Se true, apenas um terminal privado pode ser usado.

Códigos de resposta HTTP

Quando você usa a API de REST do IBM Cloud Activity Tracker Event Routing, pode obter códigos de resposta HTTP padrão para indicar se um método foi concluído com sucesso.

A resposta 200 sempre indica sucesso.
A resposta 4xx indica uma falha.
A resposta 5xx geralmente indica um erro no sistema interno.

Consulte a tabela a seguir para obter alguns códigos de resposta HTTP:

Lista de códigos de resposta HTTP
Código de status	Status	Descrição
`200`	OK	A solicitação foi bem-sucedida.
`201`	OK	A solicitação foi bem-sucedida. Um recurso é criado.
`400`	Solicitação inválida	A solicitação foi malsucedida. Um parâmetro que é necessário pode estar ausente.
`401`	Desautorizado	O token IAM que é usado na solicitação da API é inválido ou expirou.
`403`	Proibido	A operação é proibida devido a permissões insuficientes.
`404`	Não Encontrado	O recurso solicitado não existe ou já está foi excluído.
`429`	Muitas solicitações	Muitas solicitações atingiram a API muito rapidamente.
`500`	Erro interno do servidor	Algo deu errado no processamento do IBM Cloud Activity Tracker Event Routing.

Obter as configurações da conta usando a interface do usuário

Efetue login na conta do IBM Cloud.
Clique no ícone de menu > Observabilidade.
Selecione Activity Tracker.
Selecione Roteamento..
Selecione Configurações.

Nesta página, é possível visualizar as seguintes configurações:

Local de metadados: exibe a região de metadados Primários e a região de metadados de Backup.
Regiões-alvo permitidas. Exibe as regiões de destino nas quais eventos podem ser enviados.
Destinos padrão: Exibe os destinos padrão configurados.
Terminais públicos: exibe se os terminais públicos estão ativados. Quando desativado, a UI do Activity Tracker Event Routing não pode ser acessada.
Relatórios: exibe a configuração no formato JSON.

Atualização das configurações por meio da interface do usuário

Efetue login na conta do IBM Cloud.
Clique no ícone de menu > Observabilidade.
Selecione Activity Tracker.
Selecione Roteamento..
Selecione Configurações.

Clique em Editar próximo à configuração a ser alterada. Você pode modificar as seguintes configurações:

Local de metadados: selecione a região de metadados Primários e a região de metadados de Backup desejados
Regiões de destino permitidas: selecione a região na qual os destinos podem ser criados. Se nenhuma região for selecionada, todas as regiões poderão receber eventos.
Destinos padrão: Selecione o destino que será usado por padrão quando as regras de roteamento não existirem ou não corresponderem.