ApsaraDB for ClickHouse クラスターに関する情報を照会するために DATASOURCE::ClickHouse::DBClusters を使用する方法 - Resource Orchestration Service

DATASOURCE::ClickHouse::DBClusters は、ApsaraDB for 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	Alibaba Cloud アカウントの ID。	なし。
DBClusterId	String	クラスター ID。	なし。
Bid	String	サイト ID。	なし。
RegionId	String	リージョン ID。	なし。
`VSwitchId`	String	vSwitch ID。	なし。
DbNodeClass	String	クラスターの仕様。	なし。
DbNodeStorage	String	ノードのストレージ容量。	なし。
CommodityCode	String	クラスターの商品コード。	なし。
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: インスタンス ID。
    Type: String
  DBClusterName:
    Description: クラスターの説明情報。
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      DBClusterId:
        Ref: DBClusterId
      DBClusterName:
        Ref: DBClusterName
    Type: DATASOURCE::ClickHouse::DBClusters
Outputs:
  DBClusterIds:
    Description: DB クラスター ID のリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBClusterIds
  DBClusters:
    Description: DB クラスターのリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBClusters

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBClusterName": {
      "Type": "String",
      "Description": "クラスターの説明情報。"
    },
    "DBClusterId": {
      "Type": "String",
      "Description": "インスタンス ID。"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ClickHouse::DBClusters",
      "Properties": {
        "DBClusterName": {
          "Ref": "DBClusterName"
        },
        "DBClusterId": {
          "Ref": "DBClusterId"
        }
      }
    }
  },
  "Outputs": {
    "DBClusterIds": {
      "Description": "DB クラスター ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusterIds"
        ]
      }
    },
    "DBClusters": {
      "Description": "DB クラスターのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusters"
        ]
      }
    }
  }
}

構文

プロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式