Pré-requisitos da CLI

Antes de usar a CLI para gerenciar rotas, instale a versão mais recente do plug-in da CLI do Activity Tracker Event Routing V2 em seu sistema local. Consulte Instalando o Activity Tracker Event Routing CLI.

Em seguida, efetue login no IBM Cloud. Execute o comando a seguir: ibmcloud login

Criando uma rota usando a CLI

Use este comando para criar uma nova rota para um destino 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

Atualizando uma rota usando a CLI

Use este comando para atualizar uma rota para um destino Activity Tracker Event Routing. Qualquer valor especificado que seja diferente do momento da criação da rota será atualizado para o valor especificado no comando.

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

Excluindo uma rota usando a CLI

Use este comando para excluir uma rota 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

Visualizando uma rota usando a CLI

Use este comando para obter informações sobre uma rota 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

Listando todas as rotas usando a CLI

Use este comando para listar todas as rotas 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

Rotas e ações da API

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

É 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.

• É possível gerenciar rotas a partir da rede privada usando um terminal de API com o formato a seguir: https://private.REGION.atracker.cloud.ibm.com.

• É possível gerenciar rotas a partir da rede pública usando um terminal de API com o formato a seguir: https://REGION.atracker.cloud.ibm.com.

• Uma vez que as rotas são configurações globais, pode-se usar qualquer terminal regional para gerenciar as rotas para a conta.

• É possível desativar os terminais públicos atualizando as configurações da conta. Para obter informações adicionais, consulte Definindo configurações de destino e região.

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

Pré-requisitos da API

Para fazer chamadas de API a fim de gerenciar rotas, siga as etapas a seguir:

1. Obtenha um token de acesso do IAM. Para obter mais informações, consulte Recuperando tokens de acesso do iAM.
2. Identifique o terminal da API na região onde você planeja configurar ou gerenciar uma rota. Para obter mais informações, consulte Terminais.

Criando uma rota usando a API

Deve-se criar um destino antes de criar uma rota.

É possível usar o comando cURL a seguir para criar uma rota:

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"]
      }
    ]
  }'

em que

• <ENDPOINT> é o terminal de API na região em que você planeja configurar ou gerenciar uma rota. Para obter mais informações, consulte Terminais.

• ROUTE_NAME é o nome da rota. O comprimento máximo do nome é de 180 caracteres e não pode incluir qualquer um dos seguintes caracteres especiais a seguir:-, ., _, :.

  Não inclua nenhuma PII (Personal Identifying Information) em quaisquer nomes de recursos.

• LOCATIONS é uma lista de locais associados à rota. Especificar global para incluir eventos globais. Para incluir todos os locais especificam *. Se você tiver diversas regras, juntamente com uma regra com uma localização *, então as outras regras irão rotear eventos para os destinos especificados com quaisquer eventos, não correspondendo a qualquer outra regra roteando os eventos restantes para o destino especificado pela regra com a localização *.

• TARGET_ID é o GUID do destino que define onde eventos de auditoria são roteados e coletados. Isso pode incluir GUIDs de destinos em outras regiões. Se TARGET_ID estiver vazio, quaisquer eventos correspondentes à regra serão descartados.

Por exemplo, pode-se usar a solicitação cURL a seguir para criar uma rota que define como os eventos com base em localização global e US-South são coletados e roteados na conta:

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"]
      }
    ]
  }'

Na resposta, você recebe informações sobre a rota como o id, que indica o GUID da rota, e o crn, que indica o CRN da rota.

Atualizando uma rota usando a API

Ao atualizar uma rota, deve-se incluir as informações dela 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 uma rota:

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"]
      }
    ]
  }'

em que

• <ENDPOINT> é o terminal de API na região em que você planeja configurar ou gerenciar uma rota. Para obter mais informações, consulte Terminais.

• <ROUTE_ID> é o ID da rota a ser atualizado

• ROUTE_NAME é o nome da rota. O comprimento máximo do nome é de 180 caracteres e não pode incluir qualquer um dos seguintes caracteres especiais a seguir:-, ., _, :.

  Não inclua nenhuma PII (Personal Identifying Information) em quaisquer nomes de recursos.

• LOCATIONS é uma lista de locais associados à rota. Especificar global para incluir eventos globais. Para incluir todos os locais especificam *. Se você tiver diversas regras, juntamente com uma regra com uma localização *, então as outras regras irão rotear eventos para os destinos especificados com quaisquer eventos, não correspondendo a qualquer outra regra roteando os eventos restantes para o destino especificado pela regra com a localização *.

• TARGET_ID é o GUID do destino que define onde eventos de auditoria são roteados e coletados. Isso pode incluir GUIDs de destinos em outras regiões. Se TARGET_ID estiver vazio, quaisquer eventos correspondentes à regra serão descartados.

Por exemplo, é possível usar a solicitação cURL a seguir para atualizar uma rota que define como eventos globais com base nas localizações US-South e US-East são coletados e roteados na conta:

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"]
      }
    ]
  }'

Excluindo uma rota usando a API

É possível usar o comando cURL a seguir para excluir uma rota:

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

em que

• <ENDPOINT> é o terminal de API na região em que você planeja configurar ou gerenciar uma rota. Para obter mais informações, consulte Terminais.
• <ROUTE_ID> é o ID da rota a ser excluída

Por exemplo, pode-se executar a solicitação cURL a seguir para excluir a rota com o 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"

Visualizando uma rota usando a API

É possível usar o comando cURL a seguir para visualizar uma rota:

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

em que

• <ENDPOINT> é o terminal de API na região em que você planeja configurar ou gerenciar uma rota. Para obter mais informações, consulte Terminais.
• <ROUTE_ID> é o ID da rota a ser buscada

Por exemplo, pode-se executar a solicitação cURL a seguir para obter informações sobre uma rota com o 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"

Listando todas as rotas em uma região usando a API

É possível usar o comando cURL a seguir para visualizar todas as rotas:

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

em que

• <ENDPOINT> é o terminal de API na região em que você planeja configurar ou gerenciar uma rota. Para obter mais informações, consulte Terminais.

Por exemplo, pode-se executar a solicitação cURL seguir para obter informações sobre as rotas que são definidas na região US South:

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 resposta HTTP

Quando você usa a API de REST do 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:

Criando uma rota usando a IU

1. Efetue login na conta do IBM Cloud.
2. Clique no ícone do menu > Observabilidade.
3. Selecione “Acompanhamento de atividades ”.
4. Selecione Rotas.
5. Clique em “Criar” para abrir a página de criação.
6. Insira um nome significativo para a rota..
7. Em Regras de roteamento, modifique Regra 1:
   • Enviar eventos de auditoria de: selecione os locais do evento de auditoria que corresponderão a esta regra.
   • Para destinos: Selecione um destino que será anexado a esta regra. Clique em Incluir destino para incluir mais destinos na regra..
8. Clique em Incluir regra para incluir regras adicionais na rota.
   • A ordem das regras de roteamento afeta o comportamento de roteamento As regras são processadas em ordem e quando uma regra é correspondida, as regras subsequentes não são processadas.
9. Cada regra possui uma seta para cima e para baixo que permite alterar a ordem da regra.
10. Cada regra possui um botão Remover que permite excluir uma regra de uma rota.
11. Revise a definição de rota, assegurando que a ordem das regras seja conforme o desejado
12. Clique em Criar.

Atualização de uma rota usando a interface do usuário

1. Efetue login na conta do IBM Cloud.
2. Clique no ícone do menu > Observabilidade.
3. Selecione “Acompanhamento de atividades ”.
4. Selecione Rotas.
5. Determine qual rota atualizar e clique no ícone .
6. Clique em Renomear para renomear a rota
7. Clique em Editar para atualizar as regras de rota..
8. Se desejado, edite as regras existentes:
   • Enviar eventos de auditoria de: selecione os locais do evento de auditoria que corresponderão a esta regra.
   • Para destinos: Selecione um destino que será anexado a esta regra. Clique em Incluir destino para incluir mais destinos na regra..
9. Clique em Incluir regra para incluir regras adicionais na rota.
   • A ordem das regras de roteamento afeta o comportamento de roteamento As regras são processadas em ordem e quando uma regra é correspondida, as regras subsequentes não são processadas.
10. Cada regra possui uma seta para cima e para baixo que permite alterar a ordem da regra.
11. Cada regra possui um botão Remover que permite excluir uma regra de uma rota.
12. Clique em Atualizar para fazer mudanças em sua rota.

Visualizando uma rota usando a interface do usuário

1. Efetue login na conta do IBM Cloud.
2. Clique no ícone do menu > Observabilidade.
3. Selecione “Acompanhamento de atividades ”.
4. Selecione Rotas.
5. A tabela de rotas é ordenada por data de criação.. A ordem das rotas não afeta o comportamento de roteamento..
6. Cada bloco de rota exibe o nome da rota e as regras.
7. A página de rotas também exibe Orientação de roteamento com informações adicionais sobre como configurar roteamento.

Excluindo uma rota usando a IU

1. Efetue login na conta do IBM Cloud.
2. Clique no ícone do menu > Observabilidade.
3. Selecione “Acompanhamento de atividades ”.
4. Selecione Rotas.
5. Determine qual rota atualizar e clique no ícone .
6. Clique em Excluir para excluir a rota inteira Você deve inserir o nome da rota antes que ela seja excluída.