Gerenciamento de chaves de API

O ClickHouse Cloud fornece uma API com OpenAPI que permite gerenciar programaticamente sua conta e aspectos dos seus serviços.

O ClickHouse Cloud fornece uma API com OpenAPI que permite gerenciar programaticamente sua conta e aspectos dos seus serviços.

Este documento aborda a ClickHouse Cloud API. Para endpoints de API do banco de dados, consulte Cloud Endpoints API

1. Você pode usar a aba API Keys no menu à esquerda para criar e gerenciar suas chaves de API.

2. A página API Keys exibirá inicialmente uma solicitação para criar sua primeira chave de API, como mostrado abaixo. Depois que a primeira chave for criada, você poderá criar novas chaves usando o botão New API Key, que aparece no canto superior direito.

3. Para criar uma chave de API, especifique o nome da chave, as permissões e o tempo de expiração e, em seguida, clique em Generate API Key.

As permissões correspondem aos roles predefinidos do ClickHouse Cloud. O role developer tem permissões somente leitura para os serviços atribuídos, e o role admin tem permissões completas de leitura e gravação.

Query API Endpoints

Para usar chaves de API com Query API Endpoints, defina Organization Role como Member (no mínimo) e conceda ao Service Role acesso a Query Endpoints.

4. A próxima tela exibirá o ID da chave e o segredo da chave. Copie esses valores e guarde-os em um local seguro, como um cofre. Esses valores não serão exibidos depois que você sair desta tela.

5. A ClickHouse Cloud API usa HTTP Basic Authentication para verificar a validade das suas chaves de API. Veja um exemplo de como usar suas chaves de API para enviar solicitações à ClickHouse Cloud API com curl:

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

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

6. Ao voltar para a página API Keys, você verá o nome da chave, os últimos quatro caracteres do ID da chave, as permissões, o status, a data de expiração e o criador. Nesta tela, você pode editar o nome da chave, as permissões e a data de expiração. As chaves também podem ser desativadas ou excluídas nesta tela.

Excluir uma chave de API é uma ação permanente. Todos os serviços que usam a chave perderão imediatamente o acesso ao ClickHouse Cloud.

​

Endpoints

Para mais detalhes sobre os endpoints, consulte a referência da API. Use sua chave de API e seu API Secret com a URL base https://api.clickhouse.cloud/v1.