> ## Documentation Index > Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-8c05c8a2.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Obter detalhes do serviço > Retorna um serviço pertencente à organização ## OpenAPI ````yaml /pt-BR/_specs/cloud-openapi.json get /v1/organizations/{organizationId}/services/{serviceId} openapi: 3.0.1 info: contact: email: support@clickhouse.com name: ClickHouse Support url: >- https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-299828 title: OpenAPI spec for ClickHouse Cloud version: '1.0' servers: - url: https://api.clickhouse.cloud security: - basicAuth: [] tags: - name: Organization - name: User management - name: Billing - name: Service - name: Backup - name: OpenAPI - name: Prometheus - name: ClickPipes paths: /v1/organizations/{organizationId}/services/{serviceId}: get: tags: - Service summary: Obter detalhes do serviço description: Retorna um serviço pertencente à organização parameters: - description: ID da organização proprietária do serviço. in: path name: organizationId required: true schema: format: uuid type: string - description: ID do serviço solicitado. in: path name: serviceId required: true schema: format: uuid type: string responses: '200': content: application/json: schema: properties: requestId: description: ID exclusivo atribuído a cada solicitação. UUIDv4 format: uuid type: string result: $ref: '#/components/schemas/Service' status: description: Código de status HTTP. example: 200 type: number type: object description: Resposta bem-sucedida '400': content: application/json: schema: properties: error: description: Descrição detalhada do erro. type: string status: description: Código de status HTTP. example: 400 type: number type: object description: >- O servidor não pode ou não irá processar a solicitação devido a algo percebido como um erro do cliente. components: schemas: Service: properties: availablePrivateEndpointIds: description: >- Lista de IDs de private endpoints disponíveis que podem ser associados ao serviço items: type: string type: array byocId: description: >- Este é o ID retornado após configurar uma região para Bring Your Own Cloud (BYOC). Quando o parâmetro byocId é especificado, os parâmetros minReplicaMemoryGb e maxReplicaGb também são obrigatórios, com valores entre os seguintes tamanhos: 48, 116, 172, 232. type: string clickhouseVersion: description: Versão do ClickHouse do serviço. type: string complianceType: description: Tipo de compliance regulatória do serviço. enum: - hipaa - pci type: string createdAt: description: Timestamp de criação do serviço. ISO-8601. format: date-time type: string dataWarehouseId: description: Data warehouse que contém este serviço type: string encryptionAssumedRoleIdentifier: description: Role opcional a ser usada para criptografia de disk type: string encryptionKey: description: Chave de criptografia de disk fornecida pelo cliente, opcional type: string encryptionRoleId: description: >- O ID da IAM role usada para criptografia. Disponível apenas se hasTransparentDataEncryption for true. type: string endpoints: description: Lista de todos os endpoints do serviço. items: $ref: '#/components/schemas/ServiceEndpoint' type: array hasTransparentDataEncryption: description: >- true se o serviço deve ter o Transparent Data Encryption (TDE) enabled. O TDE está disponível apenas para tiers de organizações ENTERPRISE e só pode ser enabled na criação do serviço. type: boolean iamRole: description: IAM role usada para acessar objetos no S3 type: string id: description: ID exclusivo do serviço. format: uuid type: string idleScaling: description: >- Quando definido como true, o serviço pode reduzir a escala até zero quando estiver idle. true por padrão. type: boolean idleTimeoutMinutes: description: >- Define o timeout mínimo de idling (em minutos). Deve ser >= 5 minutos. type: number ipAccessList: description: Lista de endereços IP com permissão para acessar o serviço items: $ref: '#/components/schemas/IpAccessListEntry' type: array isPrimary: description: true se este serviço for o primary service no data warehouse type: boolean isReadonly: description: >- true se este serviço for read-only. Ele só pode ser read-only se um dataWarehouseId for fornecido. type: boolean maxReplicaMemoryGb: description: >- Memória total máxima de cada réplica durante o scaling automático, em Gb. Deve ser um múltiplo de 4 e menor ou igual a 120* para serviços não pagos ou 356* para serviços pagos. * - o tamanho máximo da réplica está sujeito à disponibilidade de hardware do provedor de Cloud na região selecionada. example: 120 maximum: 356 minimum: 8 multipleOf: 4 type: number maxTotalMemoryGb: deprecated: true description: >- DEPRECATED - impreciso para serviços com números de réplicas fora do padrão. Memória máxima de três workers durante o scaling automático, em Gb. Disponível apenas para serviços 'production'. Deve ser um múltiplo de 12 e menor ou igual a 360 para serviços não pagos ou 1068 para serviços pagos. example: 360 maximum: 1068 minimum: 24 multipleOf: 12 type: number minReplicaMemoryGb: description: >- Memória total mínima de cada réplica durante o scaling automático, em Gb. Deve ser um múltiplo de 4 e maior ou igual a 8. example: 16 maximum: 356 minimum: 8 multipleOf: 4 type: number minTotalMemoryGb: deprecated: true description: >- DEPRECATED - impreciso para serviços com números de réplicas fora do padrão. Memória mínima de três workers durante o scaling automático, em Gb. Disponível apenas para serviços 'production'. Deve ser um múltiplo de 12 e maior ou igual a 24. example: 48 maximum: 1068 minimum: 24 multipleOf: 12 type: number name: description: >- Nome do serviço. String alfanumérica com espaços em branco de até 50 caracteres. type: string numReplicas: description: >- Número de réplicas do serviço. O número de réplicas deve estar entre 2 e 20 para o primeiro serviço em um warehouse. Serviços criados em um warehouse existente podem ter número de réplicas tão baixo quanto 1. Restrições adicionais podem se aplicar com base no tier da sua organização. O padrão é 1 para o tier BASIC e 3 para os tiers SCALE e ENTERPRISE. example: 3 maximum: 20 minimum: 1 type: number privateEndpointIds: description: Lista de private endpoints items: type: string type: array profile: description: >- Profile de instância personalizado. Disponível apenas para tiers de organização ENTERPRISE. enum: - v1-default - v1-highmem-xs - v1-highmem-s - v1-highmem-m - v1-highmem-l - v1-highmem-xl - v1-highcpu-s - v1-highcpu-m - v1-highcpu-l - v1-highcpu-xl type: string provider: description: provedor de Cloud enum: - aws - gcp - azure type: string region: description: Região do serviço. enum: - ap-northeast-1 - ap-south-1 - ap-southeast-1 - ap-southeast-2 - eu-central-1 - eu-west-1 - eu-west-2 - me-central-1 - us-east-1 - us-east-2 - us-west-2 - us-east1 - us-central1 - europe-west4 - asia-southeast1 - eastus - eastus2 - westus3 - germanywestcentral type: string releaseChannel: description: >- Selecione fast se quiser receber novos lançamentos do ClickHouse assim que estiverem disponíveis. Você receberá novos recursos mais rapidamente, mas com maior risco de bugs. Selecione slow se quiser adiar os lançamentos para ter mais tempo para testar. Este recurso está disponível apenas para serviços production. O padrão é o regular release channel. enum: - slow - default - fast type: string state: description: Estado atual do serviço. enum: - starting - stopping - terminating - awaking - partially_running - provisioning - running - stopped - terminated - degraded - failed - idle type: string tier: deprecated: true description: >- DEPRECATED para os tiers de organização BASIC, SCALE e ENTERPRISE. Tier do serviço: 'development', 'production', 'dedicated_high_mem', 'dedicated_high_cpu', 'dedicated_standard', 'dedicated_standard_n2d_standard_4', 'dedicated_standard_n2d_standard_8', 'dedicated_standard_n2d_standard_32', 'dedicated_standard_n2d_standard_128', 'dedicated_standard_n2d_standard_32_16SSD', 'dedicated_standard_n2d_standard_64_24SSD'. Os serviços Production têm scaling, enquanto os Development têm tamanho fixo. Os serviços do Azure não oferecem suporte ao tier Development enum: - development - production - dedicated_high_mem - dedicated_high_cpu - dedicated_standard - dedicated_standard_n2d_standard_4 - dedicated_standard_n2d_standard_8 - dedicated_standard_n2d_standard_32 - dedicated_standard_n2d_standard_128 - dedicated_standard_n2d_standard_32_16SSD - dedicated_standard_n2d_standard_64_24SSD type: string transparentDataEncryptionKeyId: description: >- O ID da chave de Transparent Data Encryption usada para o serviço. Disponível apenas se hasTransparentDataEncryption for true. type: string ServiceEndpoint: properties: host: description: Nome do host do serviço type: string port: description: Porta numérica type: number protocol: description: 'Protocolo do endpoint: ''https'', ''nativesecure'', ''mysql''.' enum: - https - nativesecure - mysql example: mysql type: string username: description: Nome de usuário opcional para o endpoint nullable: true type: string IpAccessListEntry: properties: description: description: >- Descrição opcional do endereço IPv4 ou CIDR IPv4 a partir do qual permitir o acesso type: string source: description: IP ou CIDR type: string securitySchemes: basicAuth: description: >- Use o ID da chave e o segredo da chave obtidos no console do ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi scheme: basic type: http ````