Gestión de claves de API

ClickHouse Cloud ofrece una API basada en OpenAPI que le permite gestionar mediante programación su cuenta y algunos aspectos de sus servicios.

ClickHouse Cloud ofrece una API basada en OpenAPI que le permite gestionar mediante programación su cuenta y algunos aspectos de sus servicios.

Este documento trata sobre la API de ClickHouse Cloud. Para los endpoints de API de la base de datos, consulte Cloud Endpoints API

1. Puede usar la pestaña claves de API del menú de la izquierda para crear y gestionar sus claves de API.

2. La página claves de API mostrará inicialmente una opción para crear su primera clave de API, como se muestra a continuación. Una vez creada la primera clave, podrá crear otras nuevas con el botón New API Key, que aparece en la esquina superior derecha.

3. Para crear una clave de API, especifique el nombre de la clave, sus permisos y el tiempo de expiración, y luego haga clic en Generate API Key.

Los permisos se corresponden con los roles predefinidos de ClickHouse Cloud. El rol de desarrollador tiene permisos de solo lectura para los servicios asignados, y el rol de administrador tiene permisos completos de lectura y escritura.

Query API Endpoints

Para usar claves de API con Query API Endpoints, establezca Organization Role en Member (como mínimo) y conceda acceso de Service Role a Query Endpoints.

4. La siguiente pantalla mostrará su ID de clave y el secreto de la clave. Copie estos valores y guárdelos en un lugar seguro, como una bóveda. Estos valores dejarán de mostrarse cuando salga de esta pantalla.

5. La API de ClickHouse Cloud utiliza autenticación básica de HTTP para verificar la validez de sus claves de API. A continuación se muestra un ejemplo de cómo usar sus claves de API para enviar solicitudes a la API de ClickHouse Cloud con curl:

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

$ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations

6. Al volver a la página de Claves de API, verá el nombre de la clave, los últimos cuatro caracteres del ID de la clave, los permisos, el estado, la fecha de vencimiento y el creador. Desde esta pantalla, puede editar el nombre de la clave, los permisos y la fecha de vencimiento. También puede desactivar o eliminar claves desde esta pantalla.

Eliminar una clave de API es una acción permanente. Cualquier servicio que use la clave perderá inmediatamente el acceso a ClickHouse Cloud.

​

Endpoints

Para obtener más información sobre los endpoints, consulta la Referencia de la API. Usa tu clave de API y tu secreto de API con la URL base https://api.clickhouse.cloud/v1.