Méthodes d'API

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

Vous pouvez utiliser le site ENDPOINT public ou privé pour gérer les extensions. Pour plus d'informations sur les points de terminaison, voir Points de terminaison de l'API de service.

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

Obtenir la liste des extensions disponibles via l'interface utilisateur

Pour voir les extensions disponibles via l'interface utilisateur IBM Cloud Logs, suivez les étapes suivantes :

1. Lancez l'interface utilisateur IBM Cloud Logs.

2. Cliquez sur l'icône Intégrations > Extensions.

La liste des extensions disponibles s'affiche.

Obtenir la liste des extensions disponibles en utilisant l'API

Pour obtenir la liste des extensions disponibles pour le déploiement, y compris des détails supplémentaires pour celles qui sont déployées, suivez les étapes suivantes :

1. Obtenir le jeton d'authentification. Voir Authentification via API.

2. Obtenez le point de terminaison de l'instance dans laquelle vous souhaitez gérer les extensions. Voir les points de terminaison de l'API de service.

3. Liste de toutes les extensions, y compris la version et les ressources déployées par extension.

   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions"
   

Obtenir la liste des extensions déployées en utilisant l'API

Pour obtenir des informations sur les extensions déployées dans une instance IBM Cloud Logs, vous pouvez utiliser la méthode Get list of extensions. Les informations comprennent des détails sur la version et les ressources déployées.

Par exemple, suivez les étapes suivantes :

1. Obtenir le jeton d'authentification. Voir Authentification via API.

2. Obtenir le point de terminaison de l'instance dans laquelle vous souhaitez déployer une extension. Voir les points de terminaison de l'API de service.

3. Obtenir les détails d'une extension déployée.

   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions?deployed=true"
   

Obtenir la liste des extensions qui ne sont pas déployées en utilisant l'API

Pour obtenir des informations sur les extensions qui ne sont pas encore déployées dans une instance IBM Cloud Logs, vous pouvez utiliser la méthode Get list of extensions.

Par exemple, suivez les étapes suivantes :

1. Obtenir le jeton d'authentification. Voir Authentification via API.

2. Obtenir le point de terminaison de l'instance dans laquelle vous souhaitez déployer une extension. Voir les points de terminaison de l'API de service.

3. Obtenir les détails d'une extension déployée.

   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions?deployed=false"
   

Déployer une extension en utilisant l'API

Pour déployer les ressources incluses dans une extension, vous pouvez utiliser la méthode API Déployer ou mettre à jour le déploiement d'une extension....

Suivez les étapes suivantes pour déployer une extension :

1. Obtenir le jeton d'authentification. Voir Authentification via API.

2. Obtenir le point de terminaison de l'instance dans laquelle vous souhaitez déployer une extension. Voir les points de terminaison de l'API de service.

3. Obtenez l'ID de l'extension que vous souhaitez déployer. Voir la liste des extensions disponibles.

4. Obtenir les détails d'une extension par ID, y compris les informations sur les ressources déployées.

   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions/<ExtensionID>"
   

   Par exemple, pour obtenir les informations relatives à l'extension Kubernetes, exécutez :

   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<ENDPOINT>/v1/extensions/IBMCloudKubernetes"
   

   Vous obtiendrez une réponse qui se présente comme suit :

   {
   "id": "IBMCloudKubernetes",
   "name": "IBM Cloud Kubernetes Service",
   "revisions": [
       {
           "version": "1.0.0",
           "description": "# IBM Cloud Kubernetes Service\nThe dashboard provides an in-depth analysis of IBM Cloud Kubernetes Service, offering a comprehensive view of cluster performance, node activity, pod logs, and error analysis. It enables quick issue identification, trend analysis, and efficient Kubernetes monitoring.\n",
           "excerpt": "",
           "labels": [
               "IBM",
               "Kubernetes",
               "Сluster",
               "K8S",
               "Cloud",
               "Compute",
               "Observability"
           ],
           "items": [
               {
                   "id": "1405e028-dd50-48a0-86c5-b361e029a3f1",
                   "name": "IBM Kubernetes",
                   "description": "Dashboard for IBM Cloud Kubernetes Service.",
                   "target_domain": "dashboard"
               },
               {
                   "id": "93cda01a-526e-4872-b29a-125645abf784",
                   "name": "IBM Kubernetes - No logs from service",
                   "description": "No logs have been received from the kubernetes service, indicating potential issues with logging configuration, service downtime, or connectivity problems affecting log transmission.",
                   "target_domain": "alert"
               },
               {
                   "id": "9e2099ee-78f4-4070-a1fd-7be109f136ce",
                   "name": "IBM Kubernetes - More than 5 erroneous cluster logs within 15 minutes",
                   "description": "Over five error logs have been recorded at the cluster level within a 15-minute window, indicating potential issues affecting the Kubernetes cluster's overall health or configuration.",
                   "target_domain": "alert"
               },
               {
                   "id": "f242dd8a-138a-4dcc-92b9-09f5ec1b4840",
                   "name": "IBM Kubernetes - More than 5 erroneous pod logs within 15 minutes",
                   "description": "More than five error logs have been detected in pod-level operations within 15 minutes, suggesting issues with workloads or pod-level configurations.",
                   "target_domain": "alert"
               },
               {
                   "id": "504c4f1a-4185-4619-bc7c-9d011b3f3245",
                   "name": "IBM Kubernetes - Host change",
                   "description": "A host change event has been detected, which might indicate a node replacement, scaling operation, or unexpected infrastructure changes.",
                   "target_domain": "alert"
               },
               {
                   "id": "c179c165-b12e-4f40-8e87-e4627d6dbdef",
                   "name": "IBM Kubernetes - Permission denied",
                   "description": "A permission denial has occurred during a Kubernetes operation, possibly caused by misconfigured access controls or insufficient permissions for the requested action.",
                   "target_domain": "alert"
               }
           ]
       }
   ],
   "changelog": [
       {
           "version": "1.0.0",
           "description_md": "### Changed\nRelease of an extension for the IBM Cloud Kubernetes Service.\n"
       }
   ]
   }
   

5. Déployez l'extension. Par exemple, vous pouvez exécuter la commande suivante cURL pour déployer partiellement l'extension Kubernetes. Cet exemple crée un tableau de bord et deux alertes :

   curl -X PUT --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data   '{
   "version": "1.0.0",
   "item_ids": [
     "1405e028-dd50-48a0-86c5-b361e029a3f1",
     "93cda01a-526e-4872-b29a-125645abf784",
     "9e2099ee-78f4-4070-a1fd-7be109f136ce"
   ],
   "applications": [
     "myapp"
   ],
   "subsystems": [
     "mysubsystem"
   ]
   
   

}' "https:// /v1/extensions/IBMCloudKubernetes/deployment"

## Mise à jour d'une extension à l'aide de l'API {: #extensions-mgmt-update-api api}

Vous pouvez vouloir déployer une nouvelle version d'une extension, déployer des ressources supplémentaires ou modifier les applications et les sous-systèmes qui sont configurés comme sources de données pertinentes pour l'extension. Pour mettre à jour les ressources incluses dans une extension, vous pouvez utiliser la méthode API [Déployer ou mettre à jour le déploiement d'une extension....](/apidocs/logs-service-api#update-extension-deployment)

Suivez les étapes suivantes pour mettre à jour une extension :

Veillez à spécifier dans l'appel API toutes les ressources de cette extension qui sont actuellement déployées. Si vous avez modifié des ressources précédemment déployées à partir de cette extension, détachez les ressources avant d'exécuter la mise à jour. Si vous n'incluez pas toutes les ressources précédemment déployées, celles qui ne sont pas incluses sont supprimées.
{: attention}

1. Obtenir le jeton d'authentification. Voir [Authentification via API](/apidocs/logs-service-api#authentication).

2. Obtenir le point de terminaison de l'instance dans laquelle vous souhaitez déployer une extension. Voir les [points de terminaison de l'API de service](/docs/cloud-logs?topic=cloud-logs-endpoints_api).

3. Obtenez l'ID de l'extension que vous souhaitez déployer. Voir la [liste des extensions disponibles](#extensions-mgmt-list).

4. Obtenir les détails d'une extension par ID, y compris les informations sur les ressources déployées. Vérifiez la section de déploiement pour voir quelles ressources sont déjà déployées.

   ```text {: codeblock}
   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions/<ExtensionID>"

5. Mettre à jour l'extension. Par exemple, vous pouvez exécuter la commande suivante cURL pour mettre à jour l'extension Kubernetes et ne conserver qu'un tableau de bord et une alerte :

   curl -X PUT --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data   '{
   "version": "1.0.0",
   "item_ids": [
     "1405e028-dd50-48a0-86c5-b361e029a3f1",
     "93cda01a-526e-4872-b29a-125645abf784"
   ],
   "applications": [
     "myapp"
   ],
   "subsystems": [
     "mysubsystem"
   ]
   
   

}' "https:// /v1/extensions/IBMCloudKubernetes/deployment"

## Déployer une extension {: #extensions-mgmt-deploy-ui ui}

Pour déployer une extension, suivez les étapes suivantes :

1. [Connectez-vous à votre compte IBM Cloud](https://cloud.ibm.com/login){: external}.

2. [Accédez à votre instance IBM Cloud Logs](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Cliquez sur l'**icône Intégrations** ![Intégrations](/icons/integrations.svg "Intégrations") > **Extensions**.

4. Cliquez sur **Déployer** sur la tuile de l'extension que vous souhaitez déployer.

5. Sélectionnez les *applications* et les *sous-systèmes* auxquels l'extension sera appliquée.

6. Par défaut, tout ce qui est défini dans l'extension sera déployé. Vous pouvez décocher les éléments que vous ne souhaitez pas déployer.

7. Cliquez sur **+ Deploy** pour installer l'extension dans vos instances IBM Cloud Logs.


## Modifier une extension déployée {: #extensions-mgmt-modify-ui ui}

Vous pouvez vouloir déployer une nouvelle version d'une extension, déployer des ressources supplémentaires ou modifier les applications et les sous-systèmes qui sont configurés comme sources de données pertinentes pour l'extension.

Veillez à conserver toutes les ressources de cette extension qui sont actuellement déployées. Si vous avez modifié des ressources précédemment déployées à partir de cette extension, détachez les ressources avant d'exécuter la mise à jour. Si vous n'incluez pas toutes les ressources précédemment déployées, celles qui ne sont pas incluses sont supprimées.
{: attention}

Suivez les étapes suivantes pour mettre à jour une extension :

1. [Connectez-vous à votre compte IBM Cloud](https://cloud.ibm.com/login){: external}.

2. [Accédez à votre instance IBM Cloud Logs](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Cliquez sur l'**icône Intégrations** ![Intégrations](/icons/integrations.svg "Intégrations") > **Extensions**.

4. Cliquez sur la tuile de l'extension déployée que vous souhaitez modifier.

5. Modifiez les valeurs *Applications* et *Sous-systèmes* si nécessaire.

   Lorsque vous mettez à jour les valeurs des *applications* et des *sous-systèmes* dans l'extension, toutes les ressources de l'extension que vous déployez sont mises à jour avec la nouvelle liste des valeurs des *applications* et des *sous-systèmes*.
   {: attention}

6. Cliquez sur **Mettre à jour**.

## Suppression d'une extension {: #extensions-mgmt-remove-ui ui}


Pour supprimer une extension que vous avez déjà déployée dans votre instance, suivez les étapes suivantes :

1. [Connectez-vous à votre compte IBM Cloud](https://cloud.ibm.com/login){: external}.

2. [Accédez à votre instance IBM Cloud Logs](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Cliquez sur l'**icône Intégrations** ![Intégrations](/icons/integrations.svg "Intégrations") > **Extensions**.

4. Cliquez sur la tuile de l'extension déployée que vous souhaitez supprimer.

5. Cliquez sur **Supprimer**.

6. Indiquez si vous souhaitez supprimer ou conserver les ressources déployées.

   Si vous choisissez de supprimer les ressources déployées, l'extension est supprimée en même temps que les ressources déployées par l'extension dans votre instance IBM Cloud Logs.

   Si vous choisissez de conserver les ressources déployées lors de la suppression de l'extension, les ressources déployées par l'extension resteront dans votre instance IBM Cloud Logs, mais ne seront plus associées à l'extension. Si vous déployez à nouveau l'extension, une nouvelle copie de l'extension sera déployée et les ressources précédemment déployées resteront dans votre instance IBM Cloud Logs et ne seront pas écrasées.

7. Cliquez sur **Remove**.

## Détacher les ressources d'une extension déployée {: #extensions-mgmt-dettach-ui ui}

Pour détacher les ressources d'une extension déployée, procédez comme suit :

1. [Connectez-vous à votre compte IBM Cloud](https://cloud.ibm.com/login){: external}.

2. [Accédez à votre instance IBM Cloud Logs](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Cliquez sur l'**icône Intégrations** ![Intégrations](/icons/integrations.svg "Intégrations") > **Extensions**.

4. Cliquez sur la tuile de l'extension déployée que vous souhaitez supprimer.

5. Cliquez sur **Supprimer**.

6. Choisissez `Retain all assets` pour conserver les actifs modifiés qui sont déployés par l'extension dans votre instance IBM Cloud Logs.

7. Cliquez sur **Remove**.

   Les ressources détachées ne seront plus associées à l'extension.

   Si vous déployez à nouveau l'extension, une nouvelle copie de l'extension sera déployée et les ressources précédemment déployées resteront dans votre instance IBM Cloud Logs et ne seront pas écrasées.


## Suppression d'une extension {: #extensions-mgmt-remove-api api}


Pour supprimer une extension, vous pouvez exécuter l'appel API suivant :

```text {: codeblock}
% curl -X DELETE --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<ENDPOINT>/v1/extensions/<ExtensionID>/deployment"