Gestion des cibles COS

Vous pouvez gérer les cibles « IBM Cloud Object Storage » (COS) de votre compte à l'aide de l'interface de ligne de commande (CLI) IBM Cloud Activity Tracker Event Routing, de l'API REST IBM Cloud Activity Tracker Event Routing et de scripts Terraform. Une cible est une ressource dans laquelle vous pouvez collecter des événements d'audit.

Pour plus d'informations sur les cibles IBM Cloud Activity Tracker Event Routing, voir Cibles.

A propos des cibles COS

Si vous utilisez une cible « IBM Cloud Object Storage » (COS), vous pouvez utiliser le même compartiment COS pour collecter les événements d'audit de votre compte dans plusieurs régions. Dans ce scénario, les événements sont transmis à la région cible avant d'être écrits dans le compartiment COS. Vous pouvez définir un compartiment dans chaque région pour améliorer les performances et réduire la latence réseau.

Lorsque vous définissez une cible dans IBM Cloud Object Storage (COS), consultez les informations suivantes :

  • Vous pouvez créer le compartiment à n'importe quel emplacement. Pour plus d'informations, voir Gestion des compartiments IBM Cloud Object Storage (COS).

  • Vous ne pouvez configurer qu'un seul compartiment par cible.

  • Si vous avez des exigences réglementaires et de conformité, vérifiez les emplacements où vous pouvez créer un compartiment. Puis, si les performances sont critiques, pensez à créer le compartiment COS dans la même région que celle où les événements d'audit sont générés.

Accès IAM

Vous devez accorder aux utilisateurs des droits IAM pour gérer les cibles. Pour plus d'informations, voir Affectation de l'accès aux ressources.

Lorsque vous définissez une règle, vous pouvez indiquer la portée des droits. Vous pouvez choisir d'accorder des droits pour une région spécifique ou pour l'ensemble du compte.

Si vous disposez de l'autorisation IAM de créer des politiques et des autorisations, vous ne pouvez accorder que le niveau d'accès dont vous disposez en tant qu'utilisateur du service cible. Par exemple, si vous disposez d'un accès « lecteur » au service cible, vous ne pouvez attribuer que le rôle « lecteur » dans le cadre de l'autorisation. Si vous tentez d'attribuer une autorisation plus élevée, telle qu'administrateur, il peut sembler que l'autorisation est accordée, mais seule l'autorisation la plus élevée que vous avez pour le service cible, c'est-à-dire spectateur, sera attribuée.

Les utilisateurs dont le champ d'application est régional ne pourront accéder qu'aux cibles situées dans leur région autorisée.

Les actions IAM et les rôles IAM qui les incluent.
IAM ACTION Portée de la règle IAM Rôles IAM Description
atracker.target.read Région Administrator
Editor
Viewer
Operator
Lire (visualiser) des informations sur une cible
atracker.target.create Région Administrator
Editor
Création d'une cible
atracker.target.update Région Administrator
Editor
Mettre à jour une cible
atracker.target.delete Région Administrator
Editor
Supprimer une cible
atracker.target.list Compte Administrator
Editor
Viewer
Operator
Répertorier toutes les cibles

Options d'authentification

Lors de l'écriture sur une cible COS, vous pouvez utiliser les options suivantes pour vous authentifier dans un compartiment IBM Cloud Object Storage (COS).

  • En configurant l'autorisation « serviconfigre-to-service » ( S2S ) (recommandé).
  • En fournissant une clé d'API lors de la configuration de la cible.

Vous pouvez configurer l'autorisation de service à service sur votre compartiment COS pour ne pas avoir à transmettre une clé d'API lors de l'écriture de vos données chiffrées dans le compartiment COS.

Prérequis pour l'interface de ligne de commande (CLI)

Avant d'utiliser l'interface de ligne de commande pour gérer les cibles, procédez comme suit :

  1. Installez l'interface de ligne de commande IBM Cloud.

  2. Installez l'interface de ligne de commande IBM Cloud Activity Tracker Event Routing.

  3. Connectez-vous à IBM Cloud. Exécutez la commande suivante : ibmcloud login

Obtention de votre clé d'API de compartiment COS

Pour plus d'informations sur l'obtention de votre clé d'API de compartiment COS, voir Génération d'une clé d'API pour accéder à un compartiment.

Configuration de l'autorisation « S2S » via l'interface utilisateur avec le même compte

Procédez comme suit pour configurer une autorisation de service à service à l'aide de l'interface utilisateur IBM Cloud.

  1. Connectez-vous à votre compte IBM Cloud en tant que propriétaire du compte qui va configurer les cibles IBM Cloud Activity Tracker Event Routing.

    Une fois connecté avec votre ID utilisateur et votre mot de passe, le tableau de bord IBM Cloud s'ouvre.

  2. Cliquez sur « Gérer » > Accès (IAM). La page « Gérer les accès et les utilisateurs » s'affiche.

  3. Cliquez sur Autorisations.

  4. Cliquez sur Créer.

  5. Pour le service « Source », sélectionnez Activity Tracker et, pour « **Comment souhaitez-vous définir la portée de l'accès? ** », sélectionnez « Toutes les ressources ».

  6. Pour Service cible sélectionnez Cloud Object Storage et pour Comment voulez-vous étendre l'accès ?, sélectionnez Ressources basées sur les attributs sélectionnés.

  7. Sélectionnez Instance de service et la chaîne est le nom de votre Instance COS.

  8. Pour Accès au service, sélectionnez Auteur de l'objet.

  9. Cliquez sur Autoriser. Votre nouvelle autorisation de service à service sera répertoriée dans la vue Gérer les autorisations.

Vous ne pouvez autoriser que l'instance IBM Cloud Object Storage à l'aide de l'interface utilisateur. Si vous souhaitez limiter l'autorisation à un compartiment IBM Cloud Object Storage, vous devez configurer l'autorisation à l'aide de l' API.

Configuration de l'autorisation « S2S » à l'aide de l'interface de ligne de commande (CLI)

Procédez comme suit pour configurer une autorisation de service à service à l'aide de a CLI IBM Cloud.

  1. [Connectez-vous à votre compte IBM Cloud] (/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_login) en tant que propriétaire du compte qui va configurer l'autorisation IBM Cloud Activity Tracker Event Routing.

  2. Créez une règle d'autorisation définissant votre autorisation de service à service.

    ibmcloud iam authorization-policy-create atracker cloud-object-storage "Object Writer" [--target-service-instance-id <COS_SERVICE_INSTANCE>
    

    Où :

    COS_SERVICE_INSTANCE est le CRN de l'instance de compartiment de l'instance COS à autoriser.

Configuration de l'autorisation d' S2S s à l'aide de l'API

Procédez comme suit pour configurer une autorisation de service à service à l'aide de l'API IBM Cloud.

  1. Connectez-vous à votre compte IBM Cloud en tant que propriétaire du compte qui va configurer l'autorisation IBM Cloud Activity Tracker Event Routing IAM.

  2. Créez un fichier authorization_policy_resource.json définissant votre autorisation de service à service.

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

    Où :

    CUSTOMER_ACCOUNT_ID est le GUID du compte qui va configurer des cibles. Vous pouvez le trouver à l'aide de la commande ibmcloud account list.

    COS_SERVICE_INSTANCE est le CRN de l'instance de compartiment de l'instance COS à autoriser.

  3. Obtenez un jeton d'accès IAM. Pour plus d'informations, voir Extraction des jetons d'accès IAM.

  4. Exécutez la commande suivante pour configurer votre autorisation de service à service :

    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"
    

Création d'une cible COS à l'aide de l'interface CLI

Utilisez cette commande pour créer une cible IBM Cloud Object Storage à utiliser pour configurer une destination pour les événements d'activité.

 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]

Options de commande

--region REGION | -r REGION

Nom de la région, par exemple, us-south ou eu-gb. Si cette option n'est pas spécifiée, la région à laquelle l'utilisateur est connecté ou qui est ciblée est utilisée.

--name TARGET_NAME

Nom à attribuer à la cible.

N'incluez aucune information d'identification personnelle (PII) dans les noms de ressources.

--type TARGET_TYPE

Définissez TARGET_TYPE sur cloud_object_storage pour une cible COS.

--file @COS_ENDPOINT_DEFINITION_JSON_FILE

Fichier contenant une définition de noeud final au format suivant :

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

Noeud final IBM Cloud Object Storage à associer au compartiment IBM Cloud Object Storage.

--bucket BUCKET

Nom du compartiment IBM Cloud Object Storage à associer à la cible.

--target-crn COS_TARGET_CRN

Nom de ressource cloud de l'instance IBM Cloud Object Storage.

--api-key COS_API_KEY | @COS_API_KEY_FILE

Votre valeur de clé d'API ou une référence au fichier de clés de l'API utilisé pour obtenir l'accès. Par exemple, ibmcloud login --apikey $KEYFILE

--service-to-service-enabled

Indique si l'autorisation de service à service a été activée pour le compartiment. Indiquez TRUE si l'autorisation de service à service est activée, ou FALSE dans le cas contraire. Par défaut, service_to_service_enabled est FALSE.

--output FORMAT

Le format actuellement pris en charge est JSON. Si cette valeur est spécifiée, la sortie est renvoyée au format JSON. Si JSON n'est pas spécifié, la sortie est renvoyée au format tabulaire.

help | --help | -h

Répertorie les options disponibles pour la commande.

Exemple

Voici un exemple d'utilisation de la commande 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.

Voici un exemple de création de cible ayant abouti.

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

Mise à jour d'une cible COS à l'aide de l'interface CLI

Cette commande permet de mettre à jour une cible COS pour une région IBM Cloud Activity Tracker Event Routing. Toute valeur spécifiée différente de la date de création initiale de la cible est mise à jour à la valeur spécifiée dans la commande.

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]

Options de commande

--target TARGET

ID ou nom actuel de la cible.

--region REGION | -r REGION

Nom de la région, par exemple, us-south ou eu-gb. Si cette option n'est pas spécifiée, la région à laquelle l'utilisateur est connecté ou qui est ciblée est utilisée.

--name TARGET_NAME

Nom à attribuer à la cible.

N'incluez aucune information d'identification personnelle (PII) dans les noms de ressources.

--file @COS_ENDPOINT_DEFINITION_JSON_FILE

Fichier contenant une définition de noeud final au format suivant :

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

ou pour un scénario où l'authentification service à service est activée :

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

Noeud final IBM Cloud Object Storage à associer au compartiment IBM Cloud Object Storage.

--bucket COS_BUCKET

Nom du compartiment IBM Cloud Object Storage à associer à la cible.

--target-crn COS_TARGET_CRN

Nom de ressource cloud de l'instance IBM Cloud Object Storage.

--api-key COS_API_KEY | @COS_API_KEY_FILE

Votre valeur de clé d'API ou une référence au fichier de clés de l'API utilisé pour obtenir l'accès. Par exemple, ibmcloud login --apikey $KEYFILE

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

Indique si l'autorisation de service à service a été activée pour le compartiment. Indiquez TRUE si l'autorisation de service à service est activée, ou FALSE dans le cas contraire. Par défaut, l'autorisation de service à service est FALSE.

--output FORMAT

Le format actuellement pris en charge est JSON. Si cette valeur est spécifiée, la sortie est renvoyée au format JSON. Si JSON n'est pas spécifié, la sortie est renvoyée au format tabulaire.

help | --help | -h

Répertorie les options disponibles pour la commande.

Exemple

Voici un exemple d'utilisation de la commande 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

Suppression d'une cible à l'aide de l'interface de ligne de commande

Cette commande permet de supprimer une cible.

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

Options de commande

--target TARGET
ID ou nom de la cible.
--force | -f
Supprime la cible sans fournir d'invite supplémentaire à l'utilisateur.
help | --help | -h
Répertorie les options disponibles pour la commande.

Exemple

Voici un exemple d'utilisation de la commande 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.

Voici un exemple d'utilisation de la commande ibmcloud atracker target rm --target xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -force.

Cet exemple montre une commande ayant échoué dans laquelle la cible spécifiée est introuvable.

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.

Validation d'une cible à l'aide de l'interface de ligne de commande

Cette commande permet de confirmer qu'une cible est correctement configurée pour une région IBM Cloud Activity Tracker Event Routing.

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

Options de commande

--target TARGET
ID ou nom de la cible.
--region REGION | -r REGION
Nom de la région, par exemple, us-south ou eu-gb. Si cette option n'est pas spécifiée, la région à laquelle l'utilisateur est connecté ou qui est ciblée est utilisée.
--output FORMAT
Le format actuellement pris en charge est JSON. Si cette valeur est spécifiée, la sortie est renvoyée au format JSON. Si JSON n'est pas spécifié, la sortie est renvoyée au format tabulaire.
help | --help | -h
Répertorie les options disponibles pour la commande.

Exemple

Voici un exemple d'utilisation de la commande ibmcloud atracker target validate --target new-target-name.

Cet exemple montre une cible COS validée.

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

Obtention d'informations à propos d'une cible à l'aide de l'interface de ligne de commande

Cette commande permet d'obtenir des informations à propos d'une cible pour une région IBM Cloud Activity Tracker Event Routing.

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

Options de commande

--target TARGET
ID ou nom de la cible.
--output FORMAT
Le format actuellement pris en charge est JSON. Si cette valeur est spécifiée, la sortie est renvoyée au format JSON. Si JSON n'est pas spécifié, la sortie est renvoyée au format tabulaire.
help | --help | -h
Répertorie les options disponibles pour la commande.

Exemple

Voici un exemple d'utilisation de la commande ibmcloud atracker target get --target new-target-name montrant une cible 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

Liste de toutes les cibles d'une région

Cette commande permet de répertorier les cibles configurées pour une région IBM Cloud Activity Tracker Event Routing.

ibmcloud atracker target ls [--output FORMAT]

Options de commande

--output FORMAT
Le format actuellement pris en charge est JSON. Si cette valeur est spécifiée, la sortie est renvoyée au format JSON. Si JSON n'est pas spécifié, la sortie est renvoyée au format tabulaire.
help | --help | -h
Répertorie les options disponibles pour la commande.

Exemple

Voici un exemple d'utilisation de la commande 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

Cibles et actions d'API

Le tableau suivant répertorie les actions que vous pouvez exécuter pour gérer les cibles :

Ciblez des actions en utilisant l'API IBM Cloud Activity Tracker Event Routing API REST
Action Méthode d'API REST URL d'API
Création d'une cible POST <ENDPOINT>/api/v2/targets
Mettre à jour une cible PUT <ENDPOINT>/api/v2/targets/<TARGET_ID>
Supprimer une cible DELETE <ENDPOINT>/api/v2/targets/<TARGET_ID>
Lire une cible GET <ENDPOINT>/api/v2/targets/<TARGET_ID>
Répertorier toutes les cibles GET <ENDPOINT>/api/v2/targets
Valider une cible POST <ENDPOINT>/api/v2/targets/{id}/validate

Vous pouvez utiliser des noeuds finaux privés et publics pour gérer les cibles. Pour plus d'informations sur la liste des ENDPOINTS disponibles, voir Noeuds finaux.

  • Vous pouvez gérer des cibles à partir du réseau privé à l'aide d'un noeud final d'API au format suivant : https://private.REGION.atracker.cloud.ibm.com

  • Vous pouvez gérer des cibles à partir du réseau public à l'aide d'un noeud final d'API au format suivant : https://REGION.atracker.cloud.ibm.com

  • Vous pouvez désactiver les noeuds finaux publics en mettant à jour les paramètres du compte. Pour plus d'informations, voir Configuration des paramètres de la cible et de la région.

Pour plus d'informations sur l'API REST, voir Cibles.

Prérequis d'API

Pour effectuer des appels d'API pour gérer des cibles, procédez comme suit :

  1. Obtenez un jeton d'accès IAM. Pour plus d'informations, voir Extraction des jetons d'accès IAM.
  2. Identifiez le nœud final d'API dans la région dans laquelle vous prévoyez de configurer ou de gérer une cible. Pour plus d'informations, voir Nœuds finaux.

Création d'une cible COS à l'aide de l'API

Vous pouvez utiliser la commande cURL suivante pour créer une cible 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
    }
  }'

  • <ENDPOINT> est le nœud final de l'interface de programmation de la région où vous prévoyez de configurer ou de gérer une cible. Pour plus d'informations, voir Nœuds finaux.

  • TARGET_NAME est le nom de la cible. La longueur maximale du nom est de 256 caractères.

    N'incluez aucune information d'identification personnelle (PII) dans les noms de ressources.

  • TARGET_TYPE est le type de la cible. Le type valide est cloud_object_storage.

  • cos_endpoint inclut des informations sur la cible. Pour plus d'informations sur l'obtention des détails du compartiment, voir Obtention des détails de configuration du compartiment.

PRIVATE_COS_ENDPOINT indique le noeud final IBM Cloud Activity Tracker Event Routing pour rechercher ce compartiment. Utilisez le nœud final privé.

COS_CRN indique le CRN de l'instance COS où vous avez mis à disposition le compartiment.

BUCKET_NAMEIndique le nom du compartiment.

API_KEYContient la clé de l'interface de programmation qui dispose des droits permettant de télécharger des objets dans le compartiment. Cette valeur est ignorée si service_to_service_enabled est true.

SERVICE_TO_SERVICE indique si Autorisation de service à service a été activé pour le compartiment. Indiquez true si l'autorisation de service à service est activée, ou false dans le cas contraire. Par défaut, l'autorisation de service à service est false.

Par exemple, vous pouvez utiliser la demande cURL suivante pour créer une cible à 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
    }
  }'

Dans la réponse, vous obtenez des informations sur la cible, telles que l'id qui indique l'identificateur global unique de la cible et crn qui indique le CRN de la cible.

Mise à jour d'une cible COS à l'aide de l'API

Lorsque vous mettez à jour une cible IBM Cloud Object Storage (COS), vous devez inclure les informations cible dans la section de données de la demande.

  • Vous devez passer toutes les zones.
  • Mettez à jour les zones qui doivent être modifiées.
  • Vous ne pouvez pas modifier target_type d'une cible une fois créée.

Vous pouvez utiliser la commande cURL suivante pour mettre à jour une cible :

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

  • <ENDPOINT> est le nœud final de l'interface de programmation de la région où vous prévoyez de configurer ou de gérer une cible. Pour plus d'informations, voir Nœuds finaux.

  • TARGET_ID est l'ID de la cible.

  • TARGET_NAME est le nom de la cible. La longueur maximale du nom est de 256 caractères.

    N'incluez aucune information d'identification personnelle (PII) dans les noms de ressources.

  • TARGET_TYPE est le type de la cible. Définissez la valeur sur cloud_object_storage pour une cible COS.

  • cos_endpoint inclut des informations sur la cible. Pour plus d'informations sur l'obtention des détails du compartiment, voir Obtention des détails de configuration du compartiment.

PRIVATE_COS_ENDPOINT indique le noeud final IBM Cloud Activity Tracker Event Routing pour rechercher ce compartiment. Utilisez le nœud final privé.

COS_CRN indique le CRN de l'instance COS où vous avez mis à disposition le compartiment.

BUCKET_NAMEIndique le nom du compartiment.

API_KEYContient la clé de l'interface de programmation qui dispose des droits permettant de télécharger des objets dans le compartiment. Cette valeur est ignorée si service_to_service_enabled est true.

SERVICE_TO_SERVICE indique si Autorisation de service à service a été activé pour le compartiment. Indiquez true si l'autorisation de service à service est activée, ou false dans le cas contraire. Par défaut, l'autorisation de service à service est false.

Par exemple, vous pouvez utiliser la demande cURL suivante pour créer une cible à 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
    }
  }'

Suppression d'une cible à l'aide de l'API

Vous pouvez utiliser la commande cURL suivante pour supprimer une cible :

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

  • <ENDPOINT> est le nœud final de l'interface de programmation de la région où vous prévoyez de configurer ou de gérer une cible. Pour plus d'informations, voir Nœuds finaux.
  • <TARGET_ID> est l'ID de la cible.

Par exemple, vous pouvez utiliser la demande cURL suivante pour supprimer une cible dans Etats-Unis Sud avec l'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"

Dans la réponse, vous obtenez un résultat vide si la suppression a abouti :

{}

Validation d'une cible à l'aide de l'API

Vous pouvez utiliser la commande cURL suivante pour valider une cible en vérifiant les données d'identification pour écrire sur la cible.

curl -X POST <ENDPOINT>/api/v2/targets/<TARGET_ID>/validate -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

  • <ENDPOINT> est le nœud final de l'interface de programmation de la région où vous prévoyez de configurer ou de gérer une cible. Pour plus d'informations, voir Nœuds finaux.
  • <TARGET_ID> est l'ID de la cible.

Par exemple, vous pouvez utiliser la demande cURL suivante pour valider une cible dans Etats-Unis Sud avec l'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"

La réponse contient des informations dans la section cos_write_status, comme dans l'exemple suivant :

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

Affichage d'une cible à l'aide de l'API

Vous pouvez utiliser la commande cURL suivante pour afficher les informations de configuration d'une cible :

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

  • <ENDPOINT> est le nœud final de l'interface de programmation de la région où vous prévoyez de configurer ou de gérer une cible. Pour plus d'informations, voir Nœuds finaux.
  • <TARGET_ID> est l'ID de la cible.

Par exemple, vous pouvez exécuter la demande cURL suivante pour obtenir des informations sur une cible avec l'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"

Les résultats montreront si la cible est COS ("target_type": "cloud_object_storage").

Liste de toutes les cibles à l'aide de l'API

Vous pouvez utiliser la commande cURL suivante pour afficher toutes les cibles :

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

  • <ENDPOINT> est le nœud final de l'interface de programmation de la région où vous prévoyez de configurer ou de gérer une cible. Pour plus d'informations, voir Nœuds finaux.

Par exemple, vous pouvez exécuter la demande cURL suivante pour obtenir des informations sur les cibles définies à Dallas :

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

Les résultats indiqueront si la cible est une cible COS ("target_type": "cloud_object_storage").

Codes de réponse HTTP

Lorsque vous utilisez l'API REST IBM Cloud Activity Tracker Event Routing, vous pouvez obtenir des codes de réponse HTTP normaux indiquant si une méthode a abouti.

  • Une réponse 200 indique toujours le succès.
  • Une réponse 4xx indique un incident.
  • Une réponse 5xx indique généralement une erreur système interne.

Voir le tableau suivant pour certains codes de réponse HTTP :

Liste des codes de réponse HTTP
Code d'état Statut Description
200 OK La demande a abouti.
201 OK La demande a abouti. Une ressource est créée.
400 Demande incorrecte La demande n'a pas abouti. Il vous manque peut-être un paramètre obligatoire.
401 Non autorisé Le jeton IAM utilisé dans la demande d'API n'est pas valide ou est arrivé à expiration.
403 Interdit L'opération est interdite en raison de droits insuffisants.
404 Introuvable La ressource demandée n'existe pas ou est déjà supprimée.
429 Trop de demandes Trop de demandes atteignent l'API trop rapidement.
500 Erreur de serveur interne Une erreur s'est produite lors du traitement d'IBM Cloud Activity Tracker Event Routing.

Création d'une cible IBM Cloud Object Storage à l'aide de l'interface utilisateur

Seules les ressources de votre compte sont répertoriées et sélectionnables. Pour spécifier une ressource dans un autre compte, sélectionnez Spécifier le CRN sous Choisir la destination.

  1. Connectez-vous à votre compte IBM Cloud.
  2. Cliquez sur l'ic ône Menu > Observabilité.
  3. Sélectionnez « Suivi de l'activité ».
  4. Cliquez sur Créer pour ouvrir le panneau de création.
  5. Choisir un type: cliquez sur Object Storage.
  6. Autorisation de service requise: L'autorisation de service est requise pour permettre à IBM Cloud Activity Tracker Event Routing de communiquer avec IBM Cloud Object Storage. Cliquez sur Autoriser maintenant pour créer automatiquement la règle ou cliquez sur Accorder l'accès dans IAM.
  7. Choisir une destination: Sélectionnez Rechercher par instance ou Spécifier un nom de ressource de cloud
    • Recherche par instance: Sélectionnez une instance IBM Cloud Object Storage dans la table ou cliquez sur Créer pour créer une nouvelle instance IBM Cloud Object Storage. Après avoir sélectionné une instance, sélectionnez un compartiment IBM Cloud Object Storage.
    • Indiquez CRN: entrez le nom de ressource de cloud (CRN) du compartiment IBM Cloud Object Storage. Cela vous permet d'entrer un nom de ressource de cloud à partir d'un autre compte.
  • Noeud final de compartiment: utilisez le noeud final de compartiment par défaut ou modifiez-le.
  • Nom de la cible: Entrez un nom significatif pour la cible.
  • Région cible: Sélectionnez la région qui traitera les données d'événement.
  • Activez l'option Définir comme cible par défaut pour définir automatiquement votre nouvelle cible comme cible par défaut dans vos paramètres IBM Cloud Activity Tracker Event Routing. Voir la documentation sur les cibles par défaut pour plus de détails.
  • Cliquez sur Créer une cible.

Mise à jour d'une cible IBM Cloud Object Storage à l'aide de l'interface utilisateur

Seules les ressources de votre compte sont répertoriées et sélectionnables. Pour spécifier une ressource dans un autre compte, sélectionnez Spécifier le CRN sous Choisir la destination.

  1. Connectez-vous à votre compte IBM Cloud.
  2. Cliquez sur l'ic ône Menu > Observabilité.
  3. Sélectionnez « Suivi de l'activité ».
  4. Sélectionnez l'élément à mettre à jour, puis cliquez sur l'icône « Actions ».
  5. Cliquez sur Unset as default pour supprimer votre cible en tant que cible par défaut dans vos paramètres IBM Cloud Activity Tracker Event Routing. Voir la documentation sur les cibles par défaut pour plus de détails.
  6. Cliquez sur Editer pour ouvrir le panneau de mise à jour.
  7. Détails: cliquez sur Editer pour mettre à jour le nom ou la région de votre cible. Vous pouvez également activer Cible par défaut pour ajouter ou supprimer votre cible en tant que cible par défaut dans vos paramètres IBM Cloud Activity Tracker Event Routing.
  8. Cliquez sur Sauvegarder pour mettre à jour votre cible.
  9. Destination: cliquez sur Editer pour modifier l'instance IBM Cloud Object Storage ou les compartiments associés à votre cible.
  10. Cliquez sur Sauvegarder pour mettre à jour votre cible.

Suppression d'une cible via l'interface utilisateur

Vous ne pouvez pas supprimer une cible « IBM Cloud Activity Tracker Event Routing » si celle-ci est utilisée dans un itinéraire ou comme cible par défaut.

  1. Connectez-vous à votre compte IBM Cloud.
  2. Cliquez sur l'ic ône Menu > Observabilité.
  3. Sélectionnez « Suivi de l'activité ».
  4. Déterminez la cible à supprimer et cliquez sur l' icône Actions.
  5. Cliquez sur Supprimer, puis sur Supprimer dans le panneau de confirmation.

Afficher la liste de toutes les cibles d'une région via l'interface utilisateur

  1. Connectez-vous à votre compte IBM Cloud.
  2. Cliquez sur l'ic ône Menu > Observabilité.
  3. Sélectionnez « Suivi de l'activité ».

Le tableau présente les détails de la cible :

  • Type de cible
  • Nom de destination
  • Région de destination
  • Routes: s'il est utilisé dans des routes
  • Statut de la cible:
    • Actif: la cible fonctionne comme prévu
    • Erreur: La cible est déchiffrée et les événements ne seront pas acheminés vers la destination. Mettez à jour les détails ou la destination de la cible pour corriger la configuration cible ou supprimez la cible si elle n'est plus nécessaire