Métodos de API

La siguiente tabla enumera las acciones que puede ejecutar para gestionar extensiones:

Puede utilizar la dirección pública o privada ENDPOINT para gestionar las extensiones. Para obtener más información sobre los puntos finales, consulte Puntos finales de la API de servicio.

Para más información sobre la API REST, consulte Extensiones.

Obtener la lista de extensiones disponibles a través de la interfaz de usuario

Para ver las extensiones disponibles a través de la interfaz de usuario IBM Cloud Logs, siga estos pasos:

1. Inicie la interfaz de usuario de IBM Cloud Logs.

2. Haga clic en el icono Integraciones > Extensiones.

Aparece la lista de extensiones disponibles.

Obtención de la lista de extensiones disponibles mediante la API

Para obtener la lista de extensiones disponibles para su despliegue, incluyendo detalles adicionales para las que están desplegadas, complete los siguientes pasos:

1. Obtener el token de autenticación. Véase Autenticación mediante API.

2. Obtenga el endpoint de la instancia donde desea gestionar las extensiones. Véase Puntos finales de la API de servicio.

3. Lista de todas las extensiones, incluida la versión y los recursos desplegados por extensión.

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

Obtención de la lista de extensiones desplegadas mediante la API

Para obtener información sobre las extensiones desplegadas en una instancia de IBM Cloud Logs, puede utilizar el método Get list of extensions. La información incluye detalles sobre la versión y los recursos desplegados.

Por ejemplo, siga los siguientes pasos:

1. Obtener el token de autenticación. Véase Autenticación mediante API.

2. Obtenga el endpoint de la instancia en la que desea desplegar una extensión. Véase Puntos finales de la API de servicio.

3. Obtener detalles de una extensión desplegada.

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

Obtención de la lista de extensiones no desplegadas mediante la API

Para obtener información sobre las extensiones que aún no están desplegadas en una instancia de IBM Cloud Logs, puede utilizar el método Get list of extensions.

Por ejemplo, siga los siguientes pasos:

1. Obtener el token de autenticación. Véase Autenticación mediante API.

2. Obtenga el endpoint de la instancia en la que desea desplegar una extensión. Véase Puntos finales de la API de servicio.

3. Obtener detalles de una extensión desplegada.

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

Despliegue de una extensión mediante la API

Para desplegar los recursos incluidos en una extensión, puede utilizar el método de la API Desplegar o actualizar el despliegue de una extensión..

Complete los siguientes pasos para desplegar una extensión:

1. Obtener el token de autenticación. Véase Autenticación mediante API.

2. Obtenga el endpoint de la instancia en la que desea desplegar una extensión. Véase Puntos finales de la API de servicio.

3. Obtener el ID de la extensión y que desea implementar. Ver Lista de extensiones disponibles.

4. Obtener detalles de una extensión por ID incluyendo información sobre los recursos desplegados.

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

   Por ejemplo, para obtener la información de la extensión Kubernetes, ejecute:

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

   Verá una respuesta con el siguiente aspecto:

   {
   "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. Despliegue la extensión. Por ejemplo, puede ejecutar el siguiente comando cURL para desplegar parcialmente la extensión Kubernetes. Este ejemplo crea un panel de control y 2 alertas:

   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"

## Actualización de una extensión mediante la API {: #extensions-mgmt-update-api api}

Es posible que desee desplegar una nueva versión de una extensión, desplegar recursos adicionales o modificar las aplicaciones y subsistemas configurados como fuentes de datos relevantes para la extensión. Para actualizar los recursos incluidos en una extensión, puede utilizar el método de la API [Desplegar o actualizar el despliegue de una extensión](/apidocs/logs-service-api#update-extension-deployment)..

Complete los siguientes pasos para actualizar una extensión:

Asegúrese de especificar en la llamada a la API todos los recursos de esa extensión que estén desplegados en ese momento. Si ha modificado algún recurso desplegado previamente desde esta extensión, separe los recursos antes de ejecutar la actualización. Si no incluye todos los recursos desplegados anteriormente, se eliminarán los que no estén incluidos.
{: attention}

1. Obtener el token de autenticación. Véase [Autenticación mediante API](/apidocs/logs-service-api#authentication).

2. Obtenga el endpoint de la instancia en la que desea desplegar una extensión. Véase [Puntos finales de la API de servicio](/docs/cloud-logs?topic=cloud-logs-endpoints_api).

3. Obtener el ID de la extensión y que desea implementar. Ver [Lista de extensiones disponibles](#extensions-mgmt-list).

4. Obtener detalles de una extensión por ID incluyendo información sobre los recursos desplegados. Compruebe la sección de despliegue para ver qué recursos están ya desplegados.

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

5. Actualice la extensión. Por ejemplo, puede ejecutar el siguiente comando cURL para actualizar la extensión Kubernetes y mantener sólo 1 cuadro de mandos y 1 alerta:

   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"

## Desplegar una extensión {: #extensions-mgmt-deploy-ui ui}

Para desplegar una extensión, siga estos pasos:

1. Conéctese [a su cuenta IBM Cloud](https://cloud.ibm.com/login){: external}.

2. [Acceda a su instancia IBM Cloud Logs](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Haga clic en el **icono Integraciones** ![](/icons/integrations.svg "Integraciones") > **Extensiones**.

4. Haga clic en **Desplegar** en el mosaico de la extensión que desea desplegar.

5. Seleccione las *Aplicaciones* y *Subsistemas* donde se aplicará la extensión.

6. Por defecto se desplegará todo lo definido en la extensión. Puede quitar la marca de verificación de cualquier elemento que no desee desplegar.

7. Haga clic en **+ Desplegar** para instalar la extensión en sus instancias de IBM Cloud Logs.


## Modificación de una extensión desplegada {: #extensions-mgmt-modify-ui ui}

Es posible que desee desplegar una nueva versión de una extensión, desplegar recursos adicionales o modificar las aplicaciones y subsistemas configurados como fuentes de datos relevantes para la extensión.

Asegúrese de mantener seleccionados todos los recursos de esa extensión que estén desplegados en ese momento. Si ha modificado algún recurso desplegado previamente desde esta extensión, separe los recursos antes de ejecutar la actualización. Si no incluye todos los recursos desplegados anteriormente, se eliminarán los que no estén incluidos.
{: attention}

Complete los siguientes pasos para actualizar una extensión:

1. Conéctese [a su cuenta IBM Cloud](https://cloud.ibm.com/login){: external}.

2. [Acceda a su instancia IBM Cloud Logs](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Haga clic en el **icono Integraciones** ![](/icons/integrations.svg "Integraciones") > **Extensiones**.

4. Haga clic en el mosaico de la extensión desplegada que desee modificar.

5. Cambie los valores de *Aplicaciones* y *Subsistemas* según sea necesario.

   Cuando actualice los valores *Aplicaciones* y *Subsistemas* en la extensión, todos los recursos de la extensión que despliegue se actualizarán con la nueva lista de valores *Aplicaciones* y *Subsistemas*.
   {: attention}

6. Pulse **Actualizar**.

## Eliminar una extensión {: #extensions-mgmt-remove-ui ui}


Para eliminar una extensión que ya tenga desplegada en su instancia, siga estos pasos:

1. Conéctese [a su cuenta IBM Cloud](https://cloud.ibm.com/login){: external}.

2. [Acceda a su instancia IBM Cloud Logs](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Haga clic en el **icono Integraciones** ![](/icons/integrations.svg "Integraciones") > **Extensiones**.

4. Haga clic en la ficha de la extensión desplegada que desea eliminar.

5. Haga clic en **- Eliminar**.

6. Seleccione si desea eliminar o conservar los activos desplegados.

   Si decide eliminar los activos desplegados, la extensión se eliminará junto con los activos desplegados por la extensión en su instancia de IBM Cloud Logs.

   Si decide conservar los activos desplegados al eliminar la extensión, los activos desplegados por la extensión permanecerán en su instancia de IBM Cloud Logs, pero dejarán de estar asociados a la extensión. Si vuelve a desplegar la extensión, se desplegará una nueva copia de la extensión y los activos desplegados anteriormente permanecerán en su instancia de IBM Cloud Logs y no se sobrescribirán.

7. Pulse **Eliminar**.

## Separación de recursos de una extensión desplegada {: #extensions-mgmt-dettach-ui ui}

Para desinstalar recursos de una extensión desplegada, siga estos pasos:

1. Conéctese [a su cuenta IBM Cloud](https://cloud.ibm.com/login){: external}.

2. [Acceda a su instancia IBM Cloud Logs](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Haga clic en el **icono Integraciones** ![](/icons/integrations.svg "Integraciones") > **Extensiones**.

4. Haga clic en la ficha de la extensión desplegada que desea eliminar.

5. Haga clic en **- Eliminar**.

6. Elija `Retain all assets` para conservar los activos modificados que despliegue la extensión en su instancia de IBM Cloud Logs.

7. Pulse **Eliminar**.

   Los recursos Dettach dejarán de estar asociados a la extensión.

   Si vuelve a desplegar la extensión, se desplegará una nueva copia de la extensión y los activos desplegados anteriormente permanecerán en su instancia de IBM Cloud Logs y no se sobrescribirán.


## Eliminar una extensión {: #extensions-mgmt-remove-api api}


Para eliminar una extensión, puede ejecutar la siguiente llamada a la API:

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