Pular para o conteúdo principal
GET
/
v1
/
organizations
/
{organizationId}
/
services
/
{serviceId}
Obter detalhes do serviço
curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "availablePrivateEndpointIds": [
      "<string>"
    ],
    "byocId": "<string>",
    "clickhouseVersion": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "dataWarehouseId": "<string>",
    "encryptionAssumedRoleIdentifier": "<string>",
    "encryptionKey": "<string>",
    "encryptionRoleId": "<string>",
    "endpoints": [
      {
        "host": "<string>",
        "port": 123,
        "protocol": "mysql",
        "username": "<string>"
      }
    ],
    "hasTransparentDataEncryption": true,
    "iamRole": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "idleScaling": true,
    "idleTimeoutMinutes": 123,
    "ipAccessList": [
      {
        "description": "<string>",
        "source": "<string>"
      }
    ],
    "isPrimary": true,
    "isReadonly": true,
    "maxReplicaMemoryGb": 120,
    "maxTotalMemoryGb": 360,
    "minReplicaMemoryGb": 16,
    "minTotalMemoryGb": 48,
    "name": "<string>",
    "numReplicas": 3,
    "privateEndpointIds": [
      "<string>"
    ],
    "transparentDataEncryptionKeyId": "<string>"
  },
  "status": 200
}

Autorizações

​
Authorization
string
header
obrigatório

Use o ID da chave e o segredo da chave obtidos no ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Parâmetros de caminho

​
organizationId
string<uuid>
obrigatório

ID da organização proprietária do service.

​
serviceId
string<uuid>
obrigatório

ID do service solicitado.

Resposta

Resposta bem-sucedida

​
requestId
string<uuid>

ID único atribuído a cada solicitação. UUIDv4

​
result
object
​
status
number

Código de status HTTP.

Exemplo:

200

Última modificação em 10 de junho de 2026