Pré-requisitos da CLI

Antes de usar a CLI para gerenciar destinos, conclua as seguintes etapas:

1. Instale a CLI da IBM Cloud.

2. Instale a CLI da IBM Cloud Activity Tracker Event Routing.

3. Efetue login no IBM Cloud. Execute o comando a seguir: ibmcloud login

Configurando a autorização d S2S por meio da interface do usuário dentro da mesma conta

Para configurar uma autorização de serviço a serviço usando a interface com o usuário IBM Cloud, faça conforme a seguir.

1. Efetue login na sua conta IBM Cloud como o proprietário da conta que estará configurando destinos IBM Cloud Activity Tracker Event Routing.

   Depois de efetuar login com seu ID do usuário e senha, o painel do IBM Cloud se abre.

2. Clique em Gerenciar > Acesso (IAM) > Autorizações.

3. Clique em Criar.

4. Para o serviço de origem, selecione Activity Tracker e, em “Como você deseja definir o escopo do acesso? ”, selecione “Todos os recursos ”.

5. Para o serviço de destino, selecione IBM Cloud Logs em “Como você deseja definir o escopo do acesso? ”, selecione “Recursos com base nos atributos selecionados ”.

6. Selecione “Instância do serviço ” e a sequência de caracteres deve ser igual ao nome da sua instância do IBM Cloud Logs.

7. Para o Acesso de serviço, selecione Emissor

8. Clique em Autorizar. Sua nova autorização de serviço a serviço será listada na visualização Gerenciar autorizações.

Configurando a autorização d S2S por meio da CLI

Para configurar uma autorização de serviço a serviço usando a CLI IBM Cloud, faça conforme a seguir.

1. Faça login na sua conta do IBM Cloud como o titular da conta que irá configurar a autorização d IBM Cloud Activity Tracker Event Routing.

2. Crie uma política de autorização definindo sua autorização de serviço a serviço.

   ibmcloud iam authorization-policy-create atracker cloud-logs "Sender" [--target-service-instance-id <CLOUD_LOGS_SERVICE_INSTANCE>
   

Configurando a autorização d S2S, utilizando a API

Para configurar uma autorização de serviço a serviço usando a API IBM Cloud, faça conforme a seguir.

1. Efetue login na sua conta IBM Cloud como o proprietário da conta que estará configurando autorização do IAM IBM Cloud Activity Tracker Event Routing

2. Crie um arquivo authorization_policy_resource.json definindo sua autorização de serviço para serviço.

   {
       "type": "authorization",
       "subjects": [
           {
               "attributes": [
                 {
                      "name": "accountId",
                      "value": "CUSTOMER_ACCOUNT_ID"
                  },
                  {
                       "name": "serviceName",
                       "value": "atracker"
                   }
               ]
           }
       ],
       "roles": [
           {
               "role_id": "crn:v1:bluemix:public:iam::::serviceRole:Sender"
           }
       ],
       "resources": [
           {
               "attributes": [
                 {
                      "name": "accountId",
                      "value": "CUSTOMER_ACCOUNT_ID"
                  },
                  {
                       "name": "serviceName",
                       "value": "cloud-logs"
                   },
                   {
                       "name": "serviceInstance",
                       "value": "CLOUD_LOGS_SERVICE_INSTANCE"
                   }
               ]
           }
       ]
   }
   

   Em que:

   CUSTOMER_ACCOUNT_ID é o GUID da conta para a conta que estará configurando destinos. Isso pode ser localizado usando o comando ibmcloud account list.

   CLOUD_LOGS_SERVICE_INSTANCE é o ID da instância do IBM Cloud Logs.

3. Obtenha um token de acesso do IAM. Para obter mais informações, consulte Recuperando tokens de acesso do iAM.

4. Execute o comando a seguir para configurar a sua autorização de serviço a serviço:

   curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header "Authorization: $ACCESS_TOKEN" -d @authorization_policy_resource.json "https://iam.cloud.ibm.com/v1/policies"
   

Criação de um destino “ IBM Cloud Logs ” usando a CLI

Use este comando para criar um destino “ IBM Cloud Logs ” a ser utilizado na configuração de um destino para eventos de atividade.

 ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file CLOUD_LOGS_ENDPOINT_DEFINITION_JSON_FILE] |  ( [--target-crn CLOUD_LOGS_TARGET_CRN] [--region REGION] [--output FORMAT]

OK
Target
Name:                    my-target
ID:                      000000000-00000000-0000-0000-00000000
CRN:                     crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                  us-south
Type:                    cloud_logs
Cloud Logs Target CRN:   crn:v1:staging:public:logs:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
Write Status:            success
CreatedAt:               2024-05-31T19:03:35.427Z
UpdatedAt:               2024-05-31T19:03:35.427Z

Atualizando um destino do IBM Cloud Logs usando a CLI

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

ibmcloud atracker target update --target TARGET [--name TARGET_NAME] [ [--file CLOUD_LOGS_ENDPOINT_DEFINITION_JSON_FILE] |  [--target-crn CLOUD_LOGS_TARGET_CRN]]] [--output FORMAT]

OK
Target
Name:                    new-target-name
ID:                      000000000-00000000-0000-0000-00000000
CRN:                     crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                  us-south
Type:                    cloud_logs
Cloud Logs Target CRN:   crn:v1:staging:public:logs:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
Write Status:            success
Created:                 2024-05-31T19:03:35.427Z
Updated:                 2024-05-31T19:03:35.427Z

Excluindo um destino usando a CLI

Use este comando para excluir um destino.

ibmcloud atracker target rm --target TARGET [--force]

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

Are you sure you want to remove the Target bearing Target ID 33333333-3333-3333-3333-333333333333? [y/N]> y
FAILED
Something went wrong. Error:
 Status Code:  404
 Incident ID:  67a33257-d5a4-46ec-94d9-14eb70e94f3d
 Code:         not_found
 Message:      The target id specified in `target_id` field is not found.

Validando um destino usando a CLI

Use esse comando para validar que um destino foi configurado corretamente para uma região do IBM Cloud Activity Tracker Event Routing.

ibmcloud atracker target validate --target TARGET [--region REGION] [--output FORMAT]

Target
Name:                       new-target-name
ID:                         xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN:                        crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type:                       cloud_logs
Cloud Logs Target CRN:      crn:v1:staging:public:logs:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
Service to Service Enabled:	true
Write Status:               success
Created:                    2021-07-21T16:04:15.174Z
Updated:                    2021-07-21T17:49:56.452Z

Obtendo informações sobre um destino que usa a CLI

Use esse comando para obter informações sobre um destino para uma região do IBM Cloud Activity Tracker Event Routing.

ibmcloud atracker target get --target TARGET [--output FORMAT]

Target
Name:                       new-target-name
ID:                         xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN:                        crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type:                       cloud_logs
Cloud Logs Target CRN:      crn:v1:staging:public:logs:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
Service to Service Enabled: true
Write Status:               success
Created:                    2024-06-02T16:04:15.174Z
Updated:                    2024-06-05T17:49:56.452Z

Listando todos os destinos em uma região

Use esse comando para listar os destinos configurados para uma região do IBM Cloud Activity Tracker Event Routing.

ibmcloud atracker target ls [--output FORMAT]

Name                       ID                                     Region     Type                Created
target-01                  xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx   us-south   cloud_logs          2020-11-18T03:52:08.603Z

Destinos e ações da API

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

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

• É possível gerenciar destinos 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 destinos a partir da rede pública usando um terminal de API com o formato a seguir: https://REGION.atracker.cloud.ibm.com

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

Pré-requisitos da API

Para fazer chamadas de API para gerenciar destinos, conclua as seguintes etapas:

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 em que você planeja configurar ou gerenciar um destino. Para obter mais informações, consulte Terminais.

Criação de um destino do IBM Cloud Logs usando a API

Você pode usar o seguinte comando cURL para criar um destino IBM Cloud Logs:

curl -X POST  <ENDPOINT>/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "TARGET_NAME",
    "target_type": "cloud_logs",
    "cloudlogs_endpoint": {
      "target_crn": "CLOUD_LOGS_CRN"
    }
  }'

em que

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

• TARGET_NAME é o nome do destino. O comprimento máximo do nome é de 256 caracteres.

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

• TARGET_TYPE é o tipo do destino.

• cloudlogs_endpoint inclui informações sobre o destino.

CLOUD_LOGS_CRN indica o CRN da instância IBM Cloud Logs.

 Se você quiser usar uma instância do IBM Cloud Logs em Montreal (`ca-mon`), a região do destino também deverá ser Montreal (`ca-mon`).
 {: restriction}

Por exemplo, é possível usar a solicitação cURL a seguir para criar um destino em Dallas:

curl -X POST   https://private.us-south.atracker.cloud.ibm.com/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "My CLOUD LOGS target",
    "target_type": "cloud_logs",
    "cloudlogs_endpoint": {
      "target_crn": "crn:v1:bluemix:public:logs:us-south:a/<account-id>:<instance-id>::"
    }
  }'

Na resposta, são fornecidas informações sobre o destino como o id, que indica o GUID do destino, e o crn, que indica o CRN do destino.

Atualização de um destino do IBM Cloud Logs usando a API

Ao atualizar um destino do IBM Cloud Logs, é necessário incluir as informações do destino na seção de dados da solicitação.

• Deve-se ter aprovação em todos os campos.
• Atualize os campos que precisam ser modificados.
• Uma vez criado, não é possível mudar o target_type de um destino.

É possível usar o comando cURL a seguir para atualizar um destino:

curl -X PUT  <ENDPOINT>/api/v2/targets/TARGET_ID  -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "TARGET_NAME",
    "target_type": "cloud_logs",
    "cloudlogs_endpoint": {
      "target_crn": "CLOUD_LOGS_CRN"
    }
  }'

em que

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

• TARGET_ID é o ID do destino.

• TARGET_NAME é o nome do destino. O comprimento máximo do nome é de 256 caracteres.

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

• TARGET_TYPE é o tipo do destino. Defina o valor como “ cloud_logs ” para um destino do tipo “ IBM Cloud Logs ”.

• cloudlogs_endpoint inclui informações sobre o destino.

CLOUD_LOGS_CRN indica o CRN da instância IBM Cloud Logs.

 Se você quiser usar uma instância do IBM Cloud Logs em Montreal (`ca-mon`), a região do destino também deverá ser Montreal (`ca-mon`).
 {: restriction}

Por exemplo, pode-se usar a solicitação cURL a seguir para atualizar um destino em Dallas:

curl -X PUT   https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/TARGET_ID   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "My new CLOUD LOGS target name",
    "target_type": "cloud_logs",
    "cloudlogs_endpoint": {
      "target_crn": "crn:v1:bluemix:public:logs:us-south:a/<account-id>:<instance-id>::"
    }
  }'

Excluindo um destino que usa a CLI

É possível usar o comando cURL a seguir para excluir um destino:

curl -X DELETE <ENDPOINT>/api/v2/targets/<TARGET_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 um destino. Para obter mais informações, consulte Terminais.
• <TARGET_ID> é o ID do destino.

Por exemplo, pode-se usar a solicitação cURL a seguir para excluir um destino na região US-South com o ID 00000000-0000-0000-0000-000000000000:

curl -X DELETE https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

Na resposta, obtém-se um resultado vazio se a exclusão foi bem-sucedida:

{}

Validando um destino que usa a API

É possível usar o comando cURL a seguir para validar um destino, verificando as credenciais para gravar no destino.

curl -X POST <ENDPOINT>/api/v2/targets/<TARGET_ID>/validate -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 um destino. Para obter mais informações, consulte Terminais.
• <TARGET_ID> é o ID do destino.

Por exemplo, é possível usar a solicitação cURL a seguir para validar um destino na região US-South com o ID 00000000-0000-0000-0000-000000000000:

curl -X POST https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/<TARGETID>/validate -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

Na resposta, você encontra informações na seção write_status, por exemplo:

"write_status": {
    "status": "success"
  },

Visualizando um destino que usa a API

É possível usar o comando cURL a seguir para visualizar os detalhes de configuração de um destino:

curl -X GET <ENDPOINT>/api/v2/targets/<TARGET_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 um destino. Para obter mais informações, consulte Terminais.
• <TARGET_ID> é o ID do destino.

Por exemplo, pode-se executar a solicitação cURL a seguir para obter informações sobre um destino com o ID 00000000-0000-0000-0000-000000000000:

curl -X GET https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

Os resultados mostrarão se o alvo é COS ("target_type": "cloud_object_storage"), ou IBM Cloud Logs oferecendo ("target_type": "cloud_logs")

Listando todos os destinos usando a API

É possível usar o comando cURL a seguir para visualizar todos os destinos:

curl -X GET <ENDPOINT>/api/v2/targets -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 um destino. Para obter mais informações, consulte Terminais.

Por exemplo, pode-se executar a solicitação cURL a seguir para obter informações sobre os destinos que são definidos em Dallas:

curl -X GET https://private.us-south.atracker.cloud.ibm.com/api/v2/targets -H "Authorization:  $ACCESS_TOKEN" -H "content-type: application/json"

Os resultados mostrarão se o alvo é COS ("target_type": "cloud_object_storage"), ou IBM Cloud Logs oferecendo ("target_type": "cloud_logs")

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:

Criando um destino IBM Cloud Logs usando a IU

Somente os recursos em sua conta são listados e selecionáveis Para especificar um recurso em uma conta diferente, selecione Especificar CRN em Escolher destino..

1. Efetue login na conta do IBM Cloud.

2. Clique no ícone do menu > Observabilidade.

3. Selecione “Acompanhamento de atividades ”.

4. Clique em Criar para abrir o painel de criação

5. Escolher tipo: clique em Logs de nuvem.

6. Autorização de serviço necessária: a autorização de serviço é necessária para permitir que IBM Cloud Activity Tracker Event Routing se comunique com IBM Cloud Logs. Clique em Autorizar agora para criar a política automaticamente ou clique em Conceder acesso no IAM..

7. Escolher destino: selecione Procurar por instância ou Especificar CRN

   • Procurar por instância: selecione uma instância do IBM Cloud Logs na tabela ou clique em Criar para criar uma nova instância do IBM Cloud Logs

   Se você quiser usar uma instância do IBM Cloud Logs em Montreal (ca-mon), a região do destino também deverá ser Montreal (ca-mon).

• Nome de destino: Insira um nome significativo no destino.
• Região de destino: selecione a região que processará os dados do evento..
• Alterne Configurar como destino padrão para configurar automaticamente seu novo destino como um destino padrão nas configurações do IBM Cloud Activity Tracker Event Routing. Consulte a documentação de destinos padrão para obter mais detalhes..
• Clique em Criar destino..

Atualizando um destino IBM Cloud Logs usando a IU

Somente os recursos em sua conta são listados e selecionáveis Para especificar um recurso em uma conta diferente, selecione Especificar CRN em Escolher destino..

1. Efetue login na conta do IBM Cloud.

2. Clique no ícone do menu > Observabilidade.

3. Selecione “Acompanhamento de atividades ”.

4. Selecione o destino a ser atualizado e clique no .

5. Clique em Desconfigurar como padrão para remover seu destino como um destino padrão nas configurações do IBM Cloud Activity Tracker Event Routing. Consulte a documentação de destinos padrão para obter mais detalhes..

6. Clique em Editar para abrir o painel de atualização

7. Detalhes: clique em Editar para atualizar o nome ou região de seu destino. Também é possível alternar Destino padrão para incluir ou remover seu destino como um destino padrão nas configurações do IBM Cloud Activity Tracker Event Routing.

8. Clique em Salvar para atualizar seu destino..

9. Destino: Clique em Editar para mudar a instância IBM Cloud Logs associada ao seu destino.

   Se você quiser usar uma instância do IBM Cloud Logs em Montreal (ca-mon), a região do destino também deverá ser Montreal (ca-mon).

10. Clique em Salvar para atualizar seu destino..

Excluindo um destino usando a interface do usuário

Não é possível excluir um alvo IBM Cloud Activity Tracker Event Routing se ele for usado em uma rota ou como uma configuração de alvo padrão.

1. Efetue login na conta do IBM Cloud.
2. Clique no ícone do menu > Observabilidade.
3. Selecionar monitoramento de atividades
4. Selecione o item a ser excluído e clique no .
5. Clique em Excluir e, em seguida, clique em Excluir no painel de confirmação.

Listar todos os alvos em uma região 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 ”.

A tabela apresenta os detalhes do alvo:

• Tipo de destino
• Nome do destino
• Região de destino
• Rotas: se for usado em quaisquer rotas
• Status da meta:
  • Ativo: O destino está funcionando conforme esperado
  • Erro: o destino está configurado incorretamente e os eventos não serão roteados para o destino. Atualize seus detalhes de destino ou destino para corrigir a configuração de destino ou exclua o destino se ele não for mais necessário