全部產品
Search
文件中心

Resource Orchestration Service:DATASOURCE::ClickHouse::DBClusters

更新時間:Sep 19, 2024

DATASOURCE::ClickHouse::DBClusters類型用於查詢ClickHouse叢集的資訊。

文法

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

屬性

屬性名稱

類型

必須

允許更新

描述

約束

DBClusterName

String

否

是

叢集描述資訊。

無

DBClusterId

String

否

是

叢集ID。

無

RefreshOptions

String

否

是

當資源棧更新時,資料來源資源的重新整理策略。

有效值:

  • Never(預設值):更新堆棧時,從不重新整理資料來源資源。

  • Always:更新堆棧時,始終重新整理資料來源資源。

傳回值

Fn::GetAtt

  • DBClusterIds:叢集ID列表。

  • DBClusters:叢集詳情列表。

屬性名稱

類型

描述

約束

DBClusterIds

List

叢集ID列表。

無

DBClusters

List

叢集詳情列表。

無

Category

String

副本配置。

無

DBClusterName

String

叢集描述資訊。

無

LockMode

String

叢集的鎖定模式。

無

ConnectionString

String

VPC串連地址。

無

DbNodeCount

String

節點數量。

無

DbClusterNetworkType

String

網路類型。

無

IsExpired

String

叢集是否到期。

無

LockReason

String

鎖定原因。

無

Status

String

叢集狀態。

無

VpcId

String

VPC ID。

無

AliUid

String

阿里雲帳號ID。

無

DBClusterId

String

叢集ID。

無

Bid

String

網站ID。

無

RegionId

String

地區ID。

無

VSwitchId

String

交換器ID。

無

DbNodeClass

String

叢集規格。

無

DbNodeStorage

String

單節點儲存空間。

無

CommodityCode

String

售賣商品Code。

無

ZoneId

String

可用性區域ID。

無

VpcCloudInstanceId

String

VPC資源ID。

無

StorageType

String

儲存類型。

無

Port

String

HTTP連接埠號碼。

無

ExpireTime

String

叢集的到期時間。

無

PaymentType

String

付費類型。

無

ScaleOutStatus

String

資料搬遷狀態。

無

CreateTime

String

叢集的建立時間。

無

樣本

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

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"
        ]
      }
    }
  }
}