> ## 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 backup

> Retorna as informações de um único backup.



## OpenAPI

````yaml /pt-BR/_specs/cloud-openapi.json get /v1/organizations/{organizationId}/services/{serviceId}/backups/{backupId}
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}/backups/{backupId}:
    get:
      tags:
        - Backup
      summary: Obter detalhes do backup
      description: Retorna as informações de um único backup.
      parameters:
        - description: ID da organização proprietária do backup.
          in: path
          name: organizationId
          required: true
          schema:
            format: uuid
            type: string
        - description: ID do serviço a partir do qual o backup foi criado.
          in: path
          name: serviceId
          required: true
          schema:
            format: uuid
            type: string
        - description: ID do backup solicitado.
          in: path
          name: backupId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  requestId:
                    description: ID único atribuído a cada solicitação. UUIDv4
                    format: uuid
                    type: string
                  result:
                    $ref: '#/components/schemas/Backup'
                  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 quer processar a solicitação devido a
            algo interpretado como um erro do cliente.
components:
  schemas:
    Backup:
      properties:
        backupName:
          description: Nome do backup no bucket de backup externo.
          type: string
        bucket:
          description: Bucket de backup em que o backup está armazenado.
          oneOf:
            - $ref: '#/components/schemas/AwsBackupBucketProperties'
            - $ref: '#/components/schemas/GcpBackupBucketProperties'
            - $ref: '#/components/schemas/AzureBackupBucketProperties'
        durationInSeconds:
          description: >-
            Tempo, em segundos, necessário para executar o backup. Se o status
            ainda for in_progress, este é o tempo, em segundos, decorrido desde
            o início do backup até o momento.
          type: number
        finishedAt:
          description: >-
            Timestamp de término do backup. ISO-8601. Disponível apenas para
            backups concluídos
          format: date-time
          type: string
        id:
          description: ID exclusivo do backup.
          format: uuid
          type: string
        serviceId:
          description: 'Nome '
          type: string
        sizeInBytes:
          description: Tamanho do backup em bytes.
          type: number
        startedAt:
          description: Timestamp de início do backup. ISO-8601.
          format: date-time
          type: string
        status:
          description: 'Status do backup: ''done'', ''error'', ''in_progress''.'
          enum:
            - done
            - error
            - in_progress
          type: string
        type:
          description: Tipo de backup ("full" ou "incremental").
          enum:
            - full
            - incremental
          type: string
    AwsBackupBucketProperties:
      properties:
        bucketPath:
          description: Caminho do bucket
          type: string
        bucketProvider:
          description: Provedor do bucket
          enum:
            - AWS
          type: string
        iamRoleArn:
          description: AWS IAM Role
          type: string
        iamRoleSessionName:
          description: AWS IAM Role
          type: string
    GcpBackupBucketProperties:
      properties:
        accessKeyId:
          description: ID da chave de acesso (chave HMAC)
          type: string
        bucketPath:
          description: Caminho do bucket
          type: string
        bucketProvider:
          description: Provedor do bucket
          enum:
            - GCP
          type: string
    AzureBackupBucketProperties:
      properties:
        bucketProvider:
          description: Provedor do bucket
          enum:
            - AZURE
          type: string
        containerName:
          description: Nome do Container
          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

````