Gerenciando destinos do COS

Você pode gerenciar os destinos do COS ( IBM Cloud Object Storage ) em sua conta usando a CLI do IBM Cloud Activity Tracker Event Routing, a API REST do IBM Cloud Activity Tracker Event Routing e scripts do Terraform. Um destino é um recurso onde é possível coletar eventos de auditoria.

Para obter mais informações sobre destinos do IBM Cloud Activity Tracker Event Routing, consulte Destinos.

Sobre destinos do COS

Se você estiver usando um destino do IBM Cloud Object Storage (COS), poderá utilizar o mesmo bucket do COS para coletar eventos de auditoria em sua conta em várias regiões. Nesse cenário, os eventos são encaminhados para a região de destino antes de serem gravados no depósito COS. Pode-se considerar a definição de um depósito em cada região, para melhorar o desempenho e reduzir a latência de rede.

Ao definir um destino no IBM Cloud Object Storage (COS), considere as informações a seguir:

  • É possível criar o depósito em qualquer local. Para obter mais informações, consulte Gerenciando depósitos do IBM Cloud Object Storage (COS).

  • É possível configurar apenas 1 bucket para um destino.

  • Se você tiver requisitos de regulamentação e de conformidade, verifique os locais onde é possível criar um depósito. Em seguida, se o desempenho for importante, considere criar o depósito do COS na mesma região na qual os eventos de auditoria são gerados.

Acesso ao IAM

Você deve conceder aos usuários permissões do IAM para gerenciar destinos. Para obter mais informações, consulte Designar acesso a recursos

Ao definir uma política, é possível indicar o escopo das permissões.. É possível escolher entre conceder permissões para uma região específica ou para a conta inteira.

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.

Os usuários com escopo regional terão acesso restrito aos alvos em sua região autorizada.

Ações de IAM e as funções de IAM que as incluem.
AÇÃO DO IAM escopo da Política do IAM Funções do IAM Descrição
atracker.target.read Região Administrator
Editor
Viewer
Operator
Ler (visualizar) informações sobre um destino
atracker.target.create Região Administrator
Editor
Criar um destino
atracker.target.update Região Administrator
Editor
Atualizar um destino
atracker.target.delete Região Administrator
Editor
Excluir um destino
atracker.target.list Conta Administrator
Editor
Viewer
Operator
Listar todos os destinos

Opções de autenticação

Ao gravar em um destino COS, pode-se usar as opções a seguir para autenticar-se em um depósito IBM Cloud Object Storage (COS).

  • Configurando a autorização do serviconfigre-to-service ( S2S ) (recomendado).
  • Fornecendo uma chave de API ao configurar o destino.

É possível configurar a autorização de serviço a serviço para o seu depósito COS de maneira que não seja necessário passar uma chave de API ao gravar seus dados criptografados para o bucket COS.

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

Obtendo sua chave de API do depósito COS

Para obter informações sobre a obtenção de sua chave de API do depósito COS, consulte gerando uma chave de API para acessar um depósito.

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). É exibida a tela “Gerenciar acesso e usuários ”.

  3. Clique em Autorizações.

  4. Clique em Criar.

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

  6. Para Serviço de destino selecione Cloud Object Storage para Como você deseja colocar em escopo o acesso? selecionar Recursos com base em atributos selecionados.

  7. Selecione a Instância de serviço e sequência igual ao nome de sua instância COS.

  8. Para Acesso ao serviço selecione Escritor de objeto.

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

Será possível apenas autorizar para a instância IBM Cloud Object Storage usando a interface com o usuário. Se você deseja limitar a autorização a um depósito IBM Cloud Object Storage específico, é necessário configurar a autorização usando a API.

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. [Efetue login na sua conta IBM Cloud] (/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_login) como o proprietário da conta que estará configurando a autorização 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-object-storage "Object Writer" [--target-service-instance-id <COS_SERVICE_INSTANCE>
    

    Em que:

    COS_SERVICE_INSTANCE é a instância do depósito CRN da instância COS a ser autorizada.

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:ObjectWriter"
            }
        ],
        "resources": [
            {
                "attributes": [
                  {
                       "name": "accountId",
                       "value": "CUSTOMER_ACCOUNT_ID"
                   },
                   {
                        "name": "serviceName",
                        "value": "cloud-object-storage"
                    },
                    {
                        "name": "serviceInstance",
                        "value": "COS_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.

    COS_SERVICE_INSTANCE é a instância do depósito CRN da instância COS a ser autorizada.

  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"
    

Criando um destino COS usando a CLI

Use este comando para criar um destino IBM Cloud Object Storage para ser usado para configurar um destino para eventos de atividade.

 ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file COS_ENDPOINT_DEFINITION_JSON_FILE] |  ( [--endpoint COS_ENDPOINT] [--bucket COS_BUCKET] [--target-crn COS_TARGET_CRN] ( [--api-key ( COS_API_KEY | @COS_API_KEY_FILE )] |  [--service-to-service-enabled ( TRUE | FALSE )] ) ) ) [--region REGION] [--output FORMAT]

Opções de comando

--region REGION | -r REGION

Nome da região, por exemplo, us-south ou eu-gb. Se não for especificado, será usada a região conectada, ou destinada.

--name TARGET_NAME

O nome a ser fornecido ao destino.

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

--type TARGET_TYPE

Configure o TARGET_TYPE para cloud_object_storage para um destino COS.

--file @COS_ENDPOINT_DEFINITION_JSON_FILE

Um arquivo contendo uma definição de terminal no formato a seguir:

{
  "endpoint": "aaaaa",
  "target_crn": "yyyyy",
  "bucket": "zzzzzz",
  "api_key": "xxxxxx"
}
--endpoint COS_ENDPOINT

O terminal IBM Cloud Object Storage a ser associado ao depósito do IBM Cloud Object Storage.

--bucket BUCKET

O nome do depósito do IBM Cloud Object Storage a ser associado ao destino.

--target-crn COS_TARGET_CRN

O CRN da instância do IBM Cloud Object Storage.

--api-key COS_API_KEY | @COS_API_KEY_FILE

O valor da sua chave de API ou uma referência para o arquivo de Chave de API usado para obter acesso. Por exemplo, ibmcloud login --apikey $KEYFILE

--service-to-service-enabled

Indica se autorização de serviço a serviço foi ativado para o depósito. Especificar TRUE se a autorização de serviço a serviço está ativada e FALSE se a autorização de serviço a serviço não for ativada. Por padrão, service_to_service_enabled é FALSE.

--output FORMAT

O formato atualmente suportado é JSON. Se 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.

Exemplo

A seguir está um exemplo usando o comando ibmcloud atracker target create --name my-target --type cloud_object_storage --endpoint s3.us-west.cloud-object-storage.appdomain.cloud --bucket cloud-object-storage-my-cos --target-crn crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:: --api-key yyyyyyyyyyyyyyyyyyyyyyyyyyyyy.

Este exemplo mostra a criação de destino bem-sucedida.

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
Type:               		cloud_object_storage
COS Endpoint:       		s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN:     		crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket:         		cloud-object-my-target
Service to Service Enabled:	true
Write Status:   		success
Created:            		2021-07-21T16:04:15.174Z
Updated:            		2021-07-21T16:04:15.174Z

Atualizando um destino COS usando a CLI

Use este comando para atualizar um destino COS para uma região 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 COS_ENDPOINT_DEFINITION_JSON_FILE] |  ( [--endpoint COS_ENDPOINT] [--bucket COS_BUCKET] [--target-crn COS_TARGET_CRN] ( [--api-key ( COS_API_KEY | @COS_API_KEY_FILE )] | [--service-to-service-enabled ( TRUE | FALSE )]))] [--output FORMAT]

Opções de comando

--target TARGET

O ID ou nome de destino atual.

--region REGION | -r REGION

Nome da região, por exemplo, us-south ou eu-gb. Se não for especificado, será usada a região conectada, ou destinada.

--name TARGET_NAME

O nome a ser fornecido ao destino.

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

--file @COS_ENDPOINT_DEFINITION_JSON_FILE

Um arquivo contendo uma definição de terminal no formato a seguir:

{
  "endpoint": "aaaaa",
  "target_crn": "yyyyy",
  "bucket": "zzzzzz",
  "api_key": "xxxxxx"
}

ou para um cenário em que a autenticação do serviço a serviço esteja ativada:

{
  "endpoint": "aaaaa",
  "target_crn": "yyyyy",
  "bucket": "zzzzzz",
  "service_to_service_enabled": true
}
--endpoint COS_ENDPOINT

O terminal IBM Cloud Object Storage a ser associado ao depósito do IBM Cloud Object Storage.

--bucket COS_BUCKET

O nome do depósito do IBM Cloud Object Storage a ser associado ao destino.

--target-crn COS_TARGET_CRN

O CRN da instância do IBM Cloud Object Storage.

--api-key COS_API_KEY | @COS_API_KEY_FILE

O valor da sua chave de API ou uma referência para o arquivo de Chave de API usado para obter acesso. Por exemplo, ibmcloud login --apikey $KEYFILE

--service-to-service-enabled (TRUE | FALSE)

Indica se autorização de serviço a serviço foi ativado para o depósito. Especificar TRUE se a autorização de serviço a serviço está ativada e FALSE se a autorização de serviço a serviço não for ativada. Por padrão, a autorização de serviço a serviço é FALSE.

--output FORMAT

O formato atualmente suportado é JSON. Se 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.

Exemplo

A seguir está um exemplo usando o comando ibmcloud atracker target update --target my-target --name new-target-name.

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_object_storage
COS Endpoint:       		s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN:    		crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket:         		cloud-object-my-target
Service to Service Enabled:	true
Write Status:   		success
Created:            		2021-07-21T16:04:15.174Z
Updated:           		2021-07-21T17:49:56.452Z

Excluindo um destino usando a CLI

Use este comando para excluir um destino.

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

Opções de comando

--target TARGET
O ID ou nome do destino.
--force | -f
Excluirá o destino sem fornecer ao usuário nenhum prompt adicional.
help | --help | -h
Liste as opções disponíveis para o comando.

Exemplo

A seguir está um exemplo usando o comando ibmcloud atracker target rm --target xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

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.

A seguir está um exemplo usando o comando ibmcloud atracker target rm --target xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -force.

Esse exemplo mostra um comando com falha no qual não foi possível encontrar o destino especificado.

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]

Opções de comando

--target TARGET
O ID ou nome do destino.
--region REGION | -r REGION
Nome da região, por exemplo, us-south ou eu-gb. Se não for especificado, será usada a região conectada, ou destinada.
--output FORMAT
O formato atualmente suportado é JSON. Se 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.

Exemplo

A seguir está um exemplo usando o comando ibmcloud atracker target validate --target new-target-name.

Este exemplo mostra um destino COS validado com sucesso.

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_object_storage
COS Endpoint:       		s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN:     		crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket:         		cloud-object-my-target
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]

Opções de comando

--target TARGET
O ID ou nome do destino.
--output FORMAT
O formato atualmente suportado é JSON. Se 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.

Exemplo

A seguir está um exemplo usando o comando ibmcloud atracker target get --target new-target-name mostrando um destino COS.

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_object_storage
COS Endpoint:      		s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN:     		crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket:         		cloud-object-my-target
Service to Service Enabled:	true
Write Status:   		success
Created:           		2021-07-21T16:04:15.174Z
Updated:            		2021-07-21T17: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]

Opções de comando

--output FORMAT
O formato atualmente suportado é JSON. Se 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.

Exemplo

A seguir está um exemplo usando o comando ibmcloud atracker target ls.

Name                       ID                                     Region     Type                     Service to Service Enabled	Created
target-01                  xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx   us-south    cloud_object_storage    true				2020-11-18T03:52:08.603Z
target-02                  yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy   us-south    cloud_object_storage    true				2020-11-18T03:52:01.592Z
target-02-backup           zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz   us-east     cloud_object_storage    false				2021-02-26T06:53:13.466Z

Destinos e ações da API

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

Ações de destino usando a IBM Cloud Activity Tracker Event Routing API REST
Ação Método de API de REST API_URL
Criar um destino POST <ENDPOINT>/api/v2/targets
Atualizar um destino PUT <ENDPOINT>/api/v2/targets/<TARGET_ID>
Excluir um destino DELETE <ENDPOINT>/api/v2/targets/<TARGET_ID>
Ler um destino GET <ENDPOINT>/api/v2/targets/<TARGET_ID>
Listar todos os destinos GET <ENDPOINT>/api/v2/targets
Validar um destino POST <ENDPOINT>/api/v2/targets/{id}/validate

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

Criando um destino COS usando a API

É possível usar o comando cURL a seguir para criar um destino IBM Cloud Object Storage (COS):

curl -X POST  <ENDPOINT>/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "TARGET_NAME",
    "target_type": "cloud_object_storage",
    "cos_endpoint": {
      "endpoint": "PRIVATE_COS_ENDPOINT",
      "target_crn": "COS_CRN",
      "bucket": "BUCKET_NAME",
      "api_key": "API_KEY",
      "service_to_service_enabled": SERVICE_TO_SERVICE
    }
  }'

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. O tipo válido é cloud_object_storage.

  • cos_endpoint inclui informações sobre o destino. Para obter mais informações sobre como obter os detalhes do depósito, consulte Obtendo os detalhes de configuração do despósito.

PRIVATE_COS_ENDPOINT indica o terminal IBM Cloud Activity Tracker Event Routing para procurar este depósito. Use o terminal privado.

COS_CRN indica o CRN da instância COS em que o depósito foi provisionado.

BUCKET_NAME indica o nome do depósito.

API_KEY contém a chave de API que tem permissões para o upload de objetos no depósito. Esse valor é ignorado se service_to_service_enabled for true.

SERVICE_TO_SERVICE indica se a autorização de serviço a serviço foi ativada para o depósito. Especifique true se a autorização de serviço a serviço estiver ativada e false se a autorização de serviço a serviço não estiver ativada. Por padrão, a autorização de serviço a serviço é false.

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 COS target",
    "target_type": "cloud_object_storage",
    "cos_endpoint": {
      "endpoint": "s3.private.us-south.cloud-object-storage.appdomain.cloud",
      "target_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/<account-id>:<instance-id>::",
      "bucket": "my-activity-tracking-bucket",
      "api_key": "xxxxxxxxxxxxxxxxxx",
      "service_to_service_enabled": false
    }
  }'

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.

Atualizando um destino COS usando a API

Ao atualizar um destino IBM Cloud Object Storage (COS), deve-se incluir as informações de 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": "TARGET_TYPE",
    "cos_endpoint": {
      "endpoint": "PRIVATE_COS_ENDPOINT",
      "target_crn": "COS_CRN",
      "bucket": "BUCKET_NAME",
      "api_key": "API_KEY",
      "service_to_service_enabled": SERVICE_TO_SERVICE
    }
  }'

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. Configure o valor para cloud_object_storage para um destino COS.

  • cos_endpoint inclui informações sobre o destino. Para obter mais informações sobre como obter os detalhes do depósito, consulte Obtendo os detalhes de configuração do despósito.

PRIVATE_COS_ENDPOINT indica o terminal IBM Cloud Activity Tracker Event Routing para procurar este depósito. Use o terminal privado.

COS_CRN indica o CRN da instância COS em que o depósito foi provisionado.

BUCKET_NAME indica o nome do depósito.

API_KEY contém a chave de API que tem permissões para o upload de objetos no depósito. Esse valor é ignorado se service_to_service_enabled for true.

SERVICE_TO_SERVICE indica se a autorização de serviço a serviço foi ativada para o depósito. Especifique true se a autorização de serviço a serviço estiver ativada e false se a autorização de serviço a serviço não estiver ativada. Por padrão, a autorização de serviço a serviço é false.

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

curl -X PUT   https://private.us-south.atracker.cloud.ibm.com/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "My COS target",
    "target_type": "cloud_object_storage",
    "cos_endpoint": {
      "endpoint": "s3.private.us-south.cloud-object-storage.appdomain.cloud",
      "target_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/<account-id>:<instance-id>::",
      "bucket": "my-activity-tracking-bucket",
      "service_to_service_enabled": true
    }
  }'

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ê recebe informações na seção cos_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").

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 é um alvo COS ("target_type": "cloud_object_storage").

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

Criando um destino IBM Cloud Object Storage 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 Í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 Object Storage.
  6. Autorização de serviço necessária: a autorização de serviço é necessária para permitir que o IBM Cloud Activity Tracker Event Routing se comunique com IBM Cloud Object Storage. 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 IBM Cloud Object Storage na tabela ou clique em Criar para criar uma nova instância IBM Cloud Object Storage. Após selecionar uma instância, selecione um depósito do IBM Cloud Object Storage.
    • Especifique CRN: insira o Nome do recurso em nuvem (CRN) do depósito do IBM Cloud Object Storage. Isso permite que você insira um CRN de uma conta diferente.
  • Terminal do depósito: use o terminal de depósito padrão ou mude-o.
  • 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 Object Storage 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 Ícone do menu > Observabilidade.
  3. Selecione “Acompanhamento de atividades ”.
  4. Selecione o destino a ser atualizado e clique no ícone “Ações”.
  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 ou os depósitos do IBM Cloud Object Storage associados ao seu destino.
  10. Clique em Salvar para atualizar seu destino..

Excluindo um destino usando a interface do usuário

Não é possível excluir um destino do tipo “ IBM Cloud Activity Tracker Event Routing ” se ele for utilizado em uma rota ou como configuração de destino padrão.

  1. Efetue login na conta do IBM Cloud.
  2. Clique no ícone do menu Ícone do menu > Observabilidade.
  3. Selecione “Acompanhamento de atividades ”.
  4. Determine qual destino excluir e clique no ícone Ações.
  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 Í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