如何使用DATASOURCE::ClickHouse::DBClusters类型查询ClickHouse集群信息

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

语法

属性

返回值

示例

YAML格式

JSON格式

`YAML`格式

`JSON`格式