すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:DATASOURCE::POLARDB::DBClusters

最終更新日:Jan 16, 2025

DATASOURCE::POLARDB::DBClusters は、PolarDB クラスタに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::POLARDB::DBClusters",
  "Properties": {
    "Description": String,
    "DbVersion": String,
    "ResourceGroupId": String,
    "DbClusterId": String,
    "Expired": String,
    "DbType": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

Description

String

いいえ

はい

クラスタの説明。

なし。

DbVersion

String

いいえ

はい

データベースエンジンのバージョン。

有効な値:

  • 5.6

  • 5.7

  • 8.0

  • 11

  • 14

ResourceGroupId

String

いいえ

はい

リソースグループの ID。

なし。

DbClusterId

String

いいえ

はい

クラスタ ID。

なし。

Expired

String

いいえ

はい

クラスタが期限切れかどうかを指定します。

有効な値:

  • true

  • false

DbType

String

いいえ

はい

データベースエンジンのタイプ。

なし。

RefreshOptions

String

いいえ

はい

スタックが更新されたときのデータソースリソースの更新ポリシー。

有効な値:

  • Never (デフォルト): スタックが更新されたときにデータソースリソースを更新しません。

  • Always: スタックが更新されたときにデータソースリソースを更新します。

戻り値

Fn::GetAtt

  • DbClusterIds: クラスタの ID。

  • DBClusters: クラスタの詳細。

プロパティ

タイプ

説明

制約

DbClusterIds

List

クラスタの ID。

なし。

DBClusters

List

クラスタの詳細。

なし。

Category

String

クラスタのエディション。

有効な値:

  • Normal: クラスタ版

  • Basic: シングルノード版

  • Archive: X-Engine 版

  • NormalMultimaster: マルチマスタークラスタ (データベース/テーブル) 版

LockMode

String

クラスタのロックモード。

有効な値:

  • Unlock: クラスタはロックされていません。

  • ManualLock: クラスタは手動でロックされています。

  • LockByExpiration: クラスタの期限が切れると、クラスタは自動的にロックされます。

DeletionLock

String

クラスタがロックされていて削除できないかどうかを示します。

有効な値:

  • 0: クラスタはロックされておらず、削除できます。

  • 1: クラスタはロックされていて、削除できません。

説明

このプロパティを 1 に設定すると、クラスタを削除できません。

DbClusterId

String

クラスタ ID。

なし。

VpcId

String

仮想プライベートクラウド (VPC) の ID。

なし。

Description

String

クラスタの説明。

なし。

Tags

List

タグ。

例:

[ {
      "Key" : "MySQL",
      "Value" : "5.6"
    } ]

ClusterNetworkType

String

クラスタのネットワークタイプ。

なし。

RegionId

String

リージョン ID。

なし。

ResourceGroupId

String

リソースグループの ID。

なし。

DbNodes

List

ノードの詳細。

例:

[ {
      "DBNodeClass" : "polar.mysql.x4.large",
      "ZoneId" : "cn-hangzhou-i",
      "DBNodeRole" : "Reader",
      "DBNodeId" : "pi-****************",
      "RegionId" : "cn-hangzhou"
    } ]

DbNodeClass

String

ノードタイプ。

なし。

Expired

String

クラスタが期限切れかどうかを示します。

有効な値:

  • true

  • false

説明

このプロパティは、PaymentType が Prepaid に設定されている場合に戻されます。

Status

String

クラスタのステータス。

なし。

DbVersion

String

データベースエンジンのバージョン。

なし。

ZoneId

String

ゾーン ID。

なし。

StorageUsed

String

クラスタの使用済みストレージ。

単位: バイト。

Engine

String

クラスタのデータベースエンジン。

なし。

StorageSpace

String

サブスクリプション課金方法を使用するストレージスペース。

単位: バイト。

DbType

String

データベースエンジンのタイプ。

なし。

DbNodeNumber

Integer

ノード数。

なし。

ExpireTime

String

クラスタの有効期限。

  • PaymentType が Prepaid に設定されている場合は、特定の値が返されます。

  • PaymentType が Postpaid に設定されている場合は、空の文字列が返されます。

PaymentType

String

課金方法。

有効な値:

  • Postpaid: 従量課金制

  • Prepaid: サブスクリプション

CreateTime

String

作成時刻。

なし。

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::POLARDB::DBClusters
    Properties:
      DbVersion: '5.7'
Outputs:
  DbClusterIds:
    Description: クラスタの ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbClusterIds
  DBClusters:
    Description: DB クラスタのリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBClusters
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::POLARDB::DBClusters",
      "Properties": {
        "DbVersion": "5.7"
      }
    }
  },
  "Outputs": {
    "DbClusterIds": {
      "Description": "クラスタの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbClusterIds"
        ]
      }
    },
    "DBClusters": {
      "Description": "DB クラスタのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusters"
        ]
      }
    }
  }
}