Gerenciamento de chaves de API - ClickHouse Documentation

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

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

Abra a página API Keys

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

Comece a criar uma chave de API

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.

Configure a chave de API

Especifique o nome da chave, as permissões e o prazo de expiração.

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

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

Adicione endereços IP permitidos

Para restringir quais clientes podem usar a chave de API, na seção Allow access to this API Key, selecione Specific locations. Insira um endereço IP ou intervalo CIDR, como 203.0.113.1 ou 203.0.113.0/24, e adicione outras entradas conforme necessário.Os Query API endpoints respeitam allowlists de IP no nível da chave de API. Como as requisições são encaminhadas por proxy de dentro da infraestrutura do ClickHouse, allowlists de IP no nível do serviço não se aplicam. Consulte IP Access Control para mais detalhes.Clique em Generate API Key quando terminar de configurar a chave.

Salve as credenciais da chave de API

A próxima tela exibirá seu Key ID e Key secret. Copie esses valores e guarde-os em um local seguro, como um cofre. Eles não serão exibidos novamente depois que você sair desta tela.

Autentique requisições de API

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 requisições à ClickHouse Cloud API com curl:

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

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

Gerencie chaves de API existentes

Ao retornar à página API Keys, você verá o nome da chave, os quatro últimos caracteres do Key ID, 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 expiração. As chaves também podem ser desabilitadas ou excluídas nesta tela.

Excluir uma chave de API é uma ação permanente. Todos os serviços que usam essa 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.

​Endpoints

Endpoints