> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-fbfa8bee.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Liste des services de l'organisation

> Renvoie la liste de tous les services de l’organisation.



## OpenAPI

````yaml /fr/_specs/cloud-openapi.json get /v1/organizations/{organizationId}/services
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:
    get:
      tags:
        - Service
      summary: Liste des services de l'organisation
      description: Renvoie la liste de tous les services de l’organisation.
      parameters:
        - description: ID de l’organisation demandée.
          in: path
          name: organizationId
          required: true
          schema:
            format: uuid
            type: string
        - description: >-
            Critères de filtre à appliquer lors de la récupération de la
            ressource. Actuellement, seul le filtrage par tags de ressource est
            pris en charge.
          example: >-
            tag:Environment=Production&filter=tag:Department=Engineering&filter=tag:isActive
          in: query
          name: filter
          schema:
            items:
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  requestId:
                    description: ID unique attribué à chaque requête. UUIDv4
                    format: uuid
                    type: string
                  result:
                    items:
                      $ref: '#/components/schemas/Service'
                    type: array
                  status:
                    description: Code de statut HTTP.
                    example: 200
                    type: number
                type: object
          description: Réponse réussie
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    description: Description détaillée de l’erreur.
                    type: string
                  status:
                    description: Code de statut HTTP.
                    example: 400
                    type: number
                type: object
          description: >-
            Le serveur ne peut pas ou ne veut pas traiter la requête en raison
            d’un élément considéré comme une erreur côté client.
components:
  schemas:
    Service:
      properties:
        availablePrivateEndpointIds:
          description: >-
            Liste des ID des private endpoints disponibles pouvant être
            rattachés au service
          items:
            type: string
          type: array
        byocId:
          description: "Il s'agit de l'ID renvoyé après la configuration d'une région pour Bring Your Own Cloud (BYOC). Lorsque le paramètre byocId est spécifié, les paramètres minReplicaMemoryGb et maxReplicaGb sont également requis, avec des valeurs parmi les tailles suivantes\_: 48, 116, 172, 232."
          type: string
        clickhouseVersion:
          description: Version de ClickHouse du service.
          type: string
        complianceType:
          description: Type de conformité réglementaire du service.
          enum:
            - hipaa
            - pci
          type: string
        createdAt:
          description: Horodatage de création du service. ISO-8601.
          format: date-time
          type: string
        dataWarehouseId:
          description: Data warehouse contenant ce service
          type: string
        encryptionAssumedRoleIdentifier:
          description: Rôle facultatif à utiliser pour le chiffrement du disque
          type: string
        encryptionKey:
          description: Clé facultative de chiffrement du disque fournie par le client
          type: string
        encryptionRoleId:
          description: >-
            ID du rôle IAM utilisé pour le chiffrement. Disponible uniquement si
            hasTransparentDataEncryption vaut true.
          type: string
        endpoints:
          description: Liste de tous les endpoints du service.
          items:
            $ref: '#/components/schemas/ServiceEndpoint'
          type: array
        hasTransparentDataEncryption:
          description: >-
            True si Transparent Data Encryption (TDE) doit être activé pour le
            service. TDE est disponible uniquement pour les niveaux
            d'organization ENTERPRISE et ne peut être activé qu'à la création du
            service.
          type: boolean
        iamRole:
          description: Rôle IAM utilisé pour accéder aux objets dans s3
          type: string
        id:
          description: ID unique du service.
          format: uuid
          type: string
        idleScaling:
          description: >-
            Lorsqu'il est défini sur true, le service peut être ramené à zéro
            lorsqu'il est inactif. True par défaut.
          type: boolean
        idleTimeoutMinutes:
          description: >-
            Définit le timeout minimal d'inactivité (en minutes). Doit être >= 5
            minutes.
          type: number
        ipAccessList:
          description: Liste des adresses IP autorisées à accéder au service
          items:
            $ref: '#/components/schemas/IpAccessListEntry'
          type: array
        isPrimary:
          description: True si ce service est le service principal du data warehouse
          type: boolean
        isReadonly:
          description: >-
            True si ce service est en lecture seule. Il ne peut être en lecture
            seule que si un dataWarehouseId est fourni.
          type: boolean
        maxReplicaMemoryGb:
          description: >-
            Mémoire totale maximale de chaque réplique pendant la mise à
            l'échelle automatique, en Go. Doit être un multiple de 4 et
            inférieure ou égale à 120* pour les services non payants, ou à 356*
            pour les services payants. * - la taille maximale d'une réplique
            dépend de la disponibilité du matériel chez le fournisseur Cloud
            dans la région sélectionnée. 
          example: 120
          maximum: 356
          minimum: 8
          multipleOf: 4
          type: number
        maxTotalMemoryGb:
          deprecated: true
          description: >-
            DÉCONSEILLÉ - imprécis pour les services avec un nombre de répliques
            différent de la valeur par défaut. Mémoire maximale de trois workers
            pendant la mise à l'échelle automatique, en Go. Disponible
            uniquement pour les services 'production'. Doit être un multiple de
            12 et inférieur ou égal à 360 pour les services non payants, ou à
            1068 pour les services payants.
          example: 360
          maximum: 1068
          minimum: 24
          multipleOf: 12
          type: number
        minReplicaMemoryGb:
          description: >-
            Mémoire totale minimale de chaque réplique pendant la mise à
            l'échelle automatique, en Go. Doit être un multiple de 4 et
            supérieure ou égale à 8.
          example: 16
          maximum: 356
          minimum: 8
          multipleOf: 4
          type: number
        minTotalMemoryGb:
          deprecated: true
          description: >-
            DÉCONSEILLÉ - imprécis pour les services avec un nombre de répliques
            différent de la valeur par défaut. Mémoire minimale de trois workers
            pendant la mise à l'échelle automatique, en Go. Disponible
            uniquement pour les services 'production'. Doit être un multiple de
            12 et supérieur ou égal à 24.
          example: 48
          maximum: 1068
          minimum: 24
          multipleOf: 12
          type: number
        name:
          description: >-
            Nom du service. Chaîne alphanumérique pouvant contenir des espaces,
            jusqu'à 50 caractères.
          type: string
        numReplicas:
          description: >-
            Nombre de répliques du service. Le nombre de répliques doit être
            compris entre 2 et 20 pour le premier service d'un warehouse. Les
            services créés dans un warehouse existant peuvent n'avoir qu'1
            réplique. D'autres restrictions peuvent s'appliquer selon le niveau
            de votre organization. La valeur par défaut est 1 pour le niveau
            BASIC et 3 pour les niveaux SCALE et ENTERPRISE.
          example: 3
          maximum: 20
          minimum: 1
          type: number
        privateEndpointIds:
          description: Liste des private endpoints
          items:
            type: string
          type: array
        profile:
          description: >-
            Profil d'instance personnalisé. Disponible uniquement pour les
            niveaux d'organisation 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: Fournisseur Cloud
          enum:
            - aws
            - gcp
            - azure
          type: string
        region:
          description: Région du service.
          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: >-
            Sélectionnez fast si vous souhaitez obtenir les nouvelles releases
            de ClickHouse dès qu'elles sont disponibles. Vous bénéficierez ainsi
            plus rapidement des nouvelles fonctionnalités, mais avec un risque
            plus élevé de bugs. Sélectionnez slow si vous souhaitez différer les
            releases afin de disposer de plus de temps pour les tester. Cette
            fonctionnalité est disponible uniquement pour les services de
            production. La valeur par défaut est le canal de release standard.
          enum:
            - slow
            - default
            - fast
          type: string
        state:
          description: État actuel du service.
          enum:
            - starting
            - stopping
            - terminating
            - awaking
            - partially_running
            - provisioning
            - running
            - stopped
            - terminated
            - degraded
            - failed
            - idle
          type: string
        tier:
          deprecated: true
          description: "DÉCONSEILLÉ pour les niveaux d'organisation BASIC, SCALE et ENTERPRISE. Niveau du service\_: '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'. Les services Production sont extensibles, ceux de Development ont une taille fixe. Les services Azure ne prennent pas en charge le niveau 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: >-
            ID de la clé Transparent Data Encryption utilisée pour le service.
            Disponible uniquement si hasTransparentDataEncryption vaut true.
          type: string
    ServiceEndpoint:
      properties:
        host:
          description: Nom d’hôte du service
          type: string
        port:
          description: Port numérique
          type: number
        protocol:
          description: "Protocole du endpoint\_: 'https', 'nativesecure', 'mysql'."
          enum:
            - https
            - nativesecure
            - mysql
          example: mysql
          type: string
        username:
          description: Nom d’utilisateur facultatif pour le endpoint
          nullable: true
          type: string
    IpAccessListEntry:
      properties:
        description:
          description: >-
            Description facultative de l’adresse IPv4 ou du CIDR IPv4 à partir
            desquels autoriser l’accès
          type: string
        source:
          description: IP ou CIDR
          type: string
  securitySchemes:
    basicAuth:
      description: "Utilisez l’ID de la clé et le secret de la clé obtenus dans la ClickHouse Cloud console\_: https://clickhouse.com/docs/cloud/manage/openapi"
      scheme: basic
      type: http

````