Tous les produits
Search
Centre de documentation

Resource Orchestration Service:DATASOURCE::ClickHouse::DBClusters

Dernière mise à jour :Aug 10, 2026

Interroge les informations relatives aux clusters ApsaraDB for ClickHouse.

Syntaxe

{
  "Type": "DATASOURCE::ClickHouse::DBClusters",
  "Properties": {
    "DBClusterName": String,
    "DBClusterId": String,
    "RefreshOptions": String
  }
}

Propriétés

Propriété

Type

Obligatoire

Modifiable

Description

Contrainte

DBClusterName

String

Non

Oui

Description du cluster.

Aucune.

DBClusterId

String

Non

Oui

ID du cluster.

Aucune.

RefreshOptions

String

Non

Oui

Politique d'actualisation des ressources de la source de données lors de la mise à jour de la pile.

Valeurs valides :

  • Never (par défaut) : n'actualise pas les ressources de la source de données lors de la mise à jour de la pile.

  • Always : actualise les ressources de la source de données lors de la mise à jour de la pile.

Valeurs de retour

Fn::GetAtt

  • DBClusterIds : ID des clusters.

  • DBClusters : détails des clusters.

Propriété

Type

Description

Contrainte

DBClusterIds

List

ID des clusters.

Aucune.

DBClusters

List

Détails des clusters.

Aucune.

Category

String

Edition du cluster.

Aucune.

DBClusterName

String

Description du cluster.

Aucune.

LockMode

String

Mode de verrouillage du cluster.

Aucune.

ConnectionString

String

Endpoint VPC (Virtual Private Cloud) du cluster.

Aucune.

DbNodeCount

String

Nombre de nœuds.

Aucune.

DbClusterNetworkType

String

Type de réseau.

Aucune.

IsExpired

String

Indique si le cluster a expiré.

Aucune.

LockReason

String

Raison du verrouillage du cluster.

Aucune.

Status

String

État du cluster.

Aucune.

VpcId

String

ID du VPC.

Aucune.

AliUid

String

ID du compte Alibaba Cloud.

Aucune.

DBClusterId

String

ID du cluster.

Aucune.

Bid

String

ID du site.

Aucune.

RegionId

String

ID de la région.

Aucune.

VSwitchId

String

ID du vSwitch.

Aucune.

DbNodeClass

String

Spécifications du cluster.

Aucune.

DbNodeStorage

String

Espace de stockage du nœud.

Aucune.

CommodityCode

String

Code de produit du cluster.

Aucune.

ZoneId

String

ID de la zone.

Aucune.

VpcCloudInstanceId

String

ID de la ressource déployée dans le VPC.

Aucune.

StorageType

String

Type de stockage.

Aucune.

Port

String

Numéro de port HTTP.

Aucune.

ExpireTime

String

Date d'expiration du cluster.

Aucune.

PaymentType

String

Méthode de facturation.

Aucune.

ScaleOutStatus

String

État de la tâche de migration des données.

Aucune.

CreateTime

String

Date de création du cluster.

Aucune.

Exemples

Format YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBClusterId:
    Description: Instance ID.
    Type: String
  DBClusterName:
    Description: The cluster description information.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      DBClusterId:
        Ref: DBClusterId
      DBClusterName:
        Ref: DBClusterName
    Type: DATASOURCE::ClickHouse::DBClusters
Outputs:
  DBClusterIds:
    Description: The list of db cluster IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBClusterIds
  DBClusters:
    Description: The list of db clusters.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBClusters

Format JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBClusterName": {
      "Type": "String",
      "Description": "The cluster description information."
    },
    "DBClusterId": {
      "Type": "String",
      "Description": "Instance ID."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ClickHouse::DBClusters",
      "Properties": {
        "DBClusterName": {
          "Ref": "DBClusterName"
        },
        "DBClusterId": {
          "Ref": "DBClusterId"
        }
      }
    }
  },
  "Outputs": {
    "DBClusterIds": {
      "Description": "The list of db cluster IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusterIds"
        ]
      }
    },
    "DBClusters": {
      "Description": "The list of db clusters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusters"
        ]
      }
    }
  }
}