Sobre rotas

Você pode gerenciar rotas em sua conta usando a interface do usuário IBM Cloud Metrics Routing, a CLI IBM Cloud Metrics Routing CLI, a IBM Cloud Metrics Routing API REST e o IBM Cloud Metrics Routing provedor Terraform. Uma rota define as regras que indicam quais métricas são encaminhadas em uma região e para onde encaminhá-las.

Entendendo como funcionam as rotas em sua conta

Observe as informações a seguir sobre rotas:

As rotas são globais em uma conta e são avaliadas em todas as regiões em que o IBM Cloud® Metrics Routing está implantado.
É possível definir uma rota de qualquer um dos locais suportados nos quais o IBM Cloud Metrics Routing está disponível. Para obter mais informações, consulte Locais.
As rotas podem ser acessadas de qualquer ponto de extremidade regional da API IBM Cloud Metrics Routing.
É possível definir até 30 rotas para uma conta.
Por padrão, a conta tem 0 rotas configuradas.
É possível configurar até 10 regras para cada rota.
É possível configurar até 8 locais para cada regra.
É possível configurar até 3 destinos ({"targets":[{"id":ID1},{"id":ID2},{"id":ID3}]) para cada regra.
As rotas são processadas de maneira independente. Se você tiver várias rotas com regras que correspondam aos mesmos dados de métrica, esses dados serão enviados a vários destinos.
As regras em uma definição de rota são processadas em ordem. A primeira regra correspondente (por exemplo, location) que corresponde dados de métricas é usada para processar esses dados. Quando as métricas forem processadas, elas não serão processadas por uma regra subsequente dentro da definição dessa rota. Se você quiser especificar uma regra padrão para todas as métricas que não são processadas por outras regras, especifique a regra ("locations" : ["*"]) como a regra final em sua definição rules para o route.
Se os dados de métricas não corresponderem a nenhuma regra e nenhum destino padrão estiver configurado, as métricas serão descartadas e não serão roteadas para nenhum destino.
Qualquer atualização para 1 ou mais regras em uma definição de rota descarta o conjunto de regras existente e substitui-o pela configuração especificada.. Ao atualizar uma rota, deve-se definir todas as regras existentes no conjunto de regras que não mudam e incluir as mudanças nas regras que devem ser atualizadas.
As informações sobre rotas são armazenadas como metadados no local primário que você configurou para a conta IBM Cloud.

Se você não configurar um local de metadados primários, o local será configurado para o local no qual você define seu primeiro destino na conta Para obter mais informações, consulte Configurando configurações de conta.
É possível usar terminais privados e públicos para gerenciar rotas. Para obter mais informações sobre a lista de ENDPOINTS disponíveis, consulte Terminais.
- Você pode gerenciar rotas da rede privada usando um ponto de extremidade da API com o seguinte formato: https://private.REGION.metrics-router.cloud.ibm.com
- Você pode gerenciar rotas da rede pública usando um ponto de extremidade da API com o seguinte formato: https://REGION.metrics-router.cloud.ibm.com
- É possível desativar os terminais públicos atualizando as configurações da conta. Para obter mais informações, consulte Impingindo terminais privados
O nome da rota deve ter 1000 caracteres ou menos e não pode incluir nenhum caractere especial além de espaço, traço -, ponto ., sublinhado _ e dois pontos :.

O nome não deve incluir nenhuma informação de identificação pessoal (PII).

Depois de configurar uma rota, pode levar até 1 hora para que a configuração seja ativada.

Acesso ao IAM

Assegure-se de ter as permissões corretas do IAM para configurar o IBM Cloud Metrics Routing.

Permissões do IAM

A tabela a seguir lista as ações do IAM, o seu escopo e as funções necessárias para gerenciar rotas.

Escopos de ação e funções do IAM para gerenciar rotas
Tarefa	Ação do IAM	escopo da Política do IAM	Funções do IAM
Criar uma rota	`metrics-router.route.create`	Conta	`Administrator` `Editor`
Listar todas as rotas	`metrics-router.route.list`	Conta	`Administrator` `Editor` `Operator` `Viewer`
Obter detalhes de uma rota	`metrics-router.route.read`	Conta	`Administrator` `Editor` `Operator` `Viewer`
Modificar uma rota	`metrics-router.route.update`	Conta	`Administrator` `Editor`
Excluir uma rota	`metrics-router.route.delete`	Conta	`Administrator` `Editor`

Auditando eventos

A tabela a seguir lista as ações do IAM, o seu escopo e as funções necessárias para gerenciar rotas.

Ações de eventos de auditoria de rastreamento de atividades
Tarefa	Ação de evento de auditoria de rastreamento de atividade
Criar uma rota	`metrics-router.route.create`
Listar todas as rotas	`metrics-router.route.list`
Obter detalhes de uma rota	`metrics-router.route.read`
Modificar uma rota	`metrics-router.route.update`
Excluir uma rota	`metrics-router.route.delete`

Pré-requisitos da CLI

Antes de usar a CLI para gerenciar rotas, conclua as etapas a seguir:

Instale a CLI da IBM Cloud.
Instale a CLI da IBM Cloud Metrics Routing.

Gerenciamento de rotas usando a interface do usuário

Você pode gerenciar sua definição de rota usando a interface do usuário IBM Cloud Metrics Routing. Para obter mais informações, consulte Gerenciando rotas.

Comandos de CLI

A tabela a seguir lista as ações que podem ser executadas para gerenciar rotas:

Ações de rota
Ação	Comando
Criar uma rota	`ibmcloud metrics-router route create`
Atualizar uma rota	`ibmcloud metrics-router route update`
Excluir uma rota	`ibmcloud metrics-router route rm`
Leia uma rota	`ibmcloud metrics-router route get`
Listar todas as rotas	`ibmcloud metrics-router route ls`

Para obter mais informações, consulte IBM Cloud Metrics Routing v3 CLI.

Pré-requisitos da API

Antes de usar a API para gerenciar rotas, 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 você planeja configurar ou gerenciar uma rota. Para obter mais informações, consulte Terminais.

Métodos de API

A tabela a seguir lista as ações que podem ser executadas para gerenciar rotas:

Encaminhe ações usando a IBM Cloud Metrics Routing API REST
Ação	Método de API de REST	API_URL
`Create a route`	`POST`	`<ENDPOINT>/api/v3/routes`
`Update a route`	`PATCH`	`<ENDPOINT>/api/v3/routes/<ROUTE_ID>`
`Delete a route`	`DELETE`	`<ENDPOINT>/api/v3/routes/<ROUTE_ID>`
`Get information about a route`	`GET`	`<ENDPOINT>/api/v3/routes/<ROUTE_ID>`
`List all routes`	`GET`	`<ENDPOINT>/api/v3/routes`

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

Códigos de resposta HTTP

Quando você usa a API de REST do IBM Cloud Metrics 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 do site 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.
`204`	OK	A rota foi excluída com êxito.
`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 chegam à API muito rapidamente.
`500`	Erro interno do servidor	Algo deu errado no processamento do IBM Cloud Metrics Routing.