Gestion des clés d'accès

La clé d'accès est un jeton à l'aide duquel vous devez configurer les agents de surveillance pour qu'ils acheminent correctement les données vers votre instance IBM Cloud Monitoring dans IBM Cloud.

Obtention de la clé d'accès via l'interface utilisateur IBM Cloud

Pour obtenir la clé d'accès d'une instance IBM Cloud Monitoring via l'interface utilisateur IBM Cloud, procédez comme suit :

Connectez-vous à la console IBM Cloud.
Accédez à l'icône de menu > Observabilité.
Sélectionnez Surveillance. Le tableau de bord IBM Cloud Monitoring s'ouvre. Vous pouvez afficher la liste des instances de surveillance disponibles sur IBM Cloud.
Identifiez l'instance pour laquelle vous voulez obtenir une clé d'accès. Cliquez sur l'icône Actions en regard de l'instance, puis cliquez sur Gérer la clé.
Une fenêtre s'ouvre, dans laquelle vous pouvez cliquer sur Show key pour afficher la clé d'accès.

Obtention de la clé d'accès via l'interface de ligne de commande

Pour obtenir la clé d'accès d'une instance de surveillance via la ligne de commande, procédez comme suit :

[Prérequis] Installez l'interface de ligne de commande IBM Cloud.
Connectez-vous à la région d'IBM Cloud dans laquelle s'exécute l'instance de surveillance. Exécutez la commande suivante : ibmcloud login
Définissez le groupe de ressources dans lequel s'exécute l'instance de surveillance. Exécutez la commande suivante : ibmcloud target

Le groupe de ressources default est sélectionné par défaut.
Obtenez le nom d'instance. Exécutez la commande suivante : ibmcloud resource service-instances
```
ibmcloud resource service-instances
```
Obtenez le nom de la clé d'API qui est associée à l'instance de surveillance. Exécutez la commande ibmcloud resource service-keys :
```
ibmcloud resource service-keys --instance-name INSTANCE_NAME
```
où NOM_INSTANCE est le nom de l'instance que vous avez obtenu à l'étape précédente.
Obtenez la clé d'accès. Exécutez la commande ibmcloud resource service-key :
```
ibmcloud resource service-key APIKEY_NAME
```
où NOM_CLE_API représente le nom de la clé d'API.

La sortie générée par cette commande inclut le champ Clé d'accès qui contient la clé d'accès de l'instance.

Création de clés d'accès supplémentaires

Si la clé d'accès est compromise ou que vous disposez d'une règle permettant de la renouveler au bout d'un certain nombre de jours, vous pouvez générer une nouvelle clé d'accès et désactiver l'ancienne.

Pour créer une clé d'accès pour une instance IBM Cloud Monitoring, procédez comme suit :

Procurez-vous le jeton d'API à partir de l'interface utilisateur IBM Cloud Monitoring. En savoir plus.
Envoyez une demande curl POST au noeud final de surveillance pour générer une nouvelle clé d'accès.
```
curl -X POST -H 'Authorization: Bearer API_TOKEN' https:ENDPOINT/api/customer/accessKeys
```
Où
- ENDPOINT est l'URL de la région où se trouve l'instance de surveillance. Pour plus d'informations, voir Noeuds finaux de surveillance.
- API_TOKEN représente le jeton d'API que vous extrayez à l'étape 1.
La sortie fournit la clé d'accès nouvellement générée dans la réponse.
```
{
    "customerAccessKey": {
        "enabled": true,
        "accessKey": "12345678-1234-1234-1234-123456789012",
        "dateCreated": 1573852152224,
        "dateDisabled": null
    }
}
```
La clé d'accès peut désormais être utilisée dans les fichiers de configuration de l'agent de surveillance.

Désactivation d'une clé d'accès

Pour désactiver une clé d'accès existante pour une instance IBM Cloud Monitoring, procédez comme suit :

Procurez-vous le jeton d'API à partir de l'interface utilisateur IBM Cloud Monitoring ( voir les instructions).
Envoyez une demande curl POST au noeud final de surveillance pour désactiver la clé d'accès donnée.
```
curl -X POST -H 'Authorization: Bearer API_TOKEN' https:ENDPOINT/api/customer/accessKeys/ACCESS_KEY/disable
```
Où
- ENDPOINT est l'URL de la région où se trouve l'instance de surveillance. Pour plus d'informations, voir Noeuds finaux de surveillance.
- API_TOKEN représente le jeton d'API extrait à l'étape 1.
- ACCESS_KEY représente la clé d'accès à désactiver.

Une fois que la clé d'accès est désactivée, les agents qui l'ont utilisée pour se connecter ne peuvent plus envoyer de métriques à cette instance IBM Cloud Monitoring.

Il n'est pas possible de supprimer des clés d'accès pour le moment.

Activation d'une clé d'accès

Pour activer une clé d'accès existante pour une instance IBM Cloud Monitoring, procédez comme suit :

Procurez-vous le jeton d'API à partir de l'interface utilisateur IBM Cloud Monitoring. En savoir plus.
Envoyez à nouveau une demande curl POST au noeud final de surveillance pour activer la clé d'accès donnée.
```
curl -X POST -H 'Authorization: Bearer API_TOKEN' https://ENDPOINT/api/customer/accessKeys/ACCESS_KEY/enable
```
Où
- ENDPOINT est l'URL de la région où se trouve l'instance de surveillance. Pour plus d'informations, voir Noeuds finaux de surveillance.
- API_TOKEN représente le jeton d'API extrait à l'étape 1.
- ACCESS_KEY représente la clé d'accès à activer.

Une fois que la clé d'accès est activée, il est nécessaire de redémarrer manuellement les agents car un agent qui se connecte à l'aide d'une clé d'accès désactivée est arrêté.

Affichage des clés d'accès disponibles

Pour afficher toutes les clés d'accès d'une instance IBM Cloud Monitoring, procédez comme suit :

Procurez-vous le jeton d'API à partir de l'interface utilisateur IBM Cloud Monitoring. En savoir plus.

Envoyez une demande curl GET au noeud final de surveillance régional pour activer la clé d'accès donnée.

curl -X GET -H 'Authorization: Bearer API_TOKEN' https://ENDPOINT/api/customer/accessKeys

Où

ENDPOINT est l'URL de la région où se trouve l'instance de surveillance. Pour plus d'informations, voir Noeuds finaux de surveillance.
API_TOKEN représente le jeton d'API extrait à l'étape 1.

La sortie fournit une liste des clés d'accès dans la réponse et indique si elles sont activées.

{
    "customerAccessKeys": [
        {
            "enabled": true,
            "accessKey": "12345678-1234-1234-1234-123456789012",
            "dateCreated": 1541096409000,
            "dateDisabled": null
        },
        {
            "enabled": false,
            "accessKey": "87654321-1234-1234-1234-123456789012",
            "dateCreated": 1573849361000,
            "dateDisabled": 1573849367000
        }
    ]
}

Suppression de clés d'accès

Pour supprimer une clé d'accès pour une instance IBM Cloud Monitoring, procédez comme suit :

Procurez-vous le jeton d'API à partir de l'interface utilisateur IBM Cloud Monitoring. En savoir plus.
Émettez une requête curl DELETE sur le noeud final de surveillance régional pour supprimer la clé d'accès.
```
curl -X DELETE -H 'Authorization: Bearer API_TOKEN' -H "IBMInstanceID: GUID" https://ENDPOINT/api/customer/accessKeys/ACCESS_KEY
```
Où
- ENDPOINT est l'URL de la région où se trouve l'instance de surveillance. Pour plus d'informations, voir Noeuds finaux de surveillance.
- API_TOKEN représente le jeton d'API extrait à l'étape 1.
- GUID est l'identificateur global unique de l'instance de surveillance associée à la clé d'accès. Voir En-têtes pour les jetons IAM.
- ACCESS_KEY est la clé d'accès à supprimer. Vous pouvez afficher une liste de toutes les clés d'accès pour obtenir les valeurs de clé d'accès.