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

Resource Orchestration Service:ALIYUN::HBase::Cluster

最終更新日:Mar 17, 2025

ALIYUN::HBase::Cluster は、ApsaraDB for HBase クラスタを作成するために使用されます。

構文

{
  "Type": "ALIYUN::HBase::Cluster",
  "Properties": {
    "AutoRenewPeriod": Integer,
    "ColdStorageSize": Integer,
    "EngineVersion": String,
    "ResourceGroupId": String,
    "NodeCount": Integer,
    "ZoneId": String,
    "VSwitchId": String,
    "Period": Integer,
    "EncryptionKey": String,
    "PayType": String,
    "MasterInstanceType": String,
    "DiskType": String,
    "VpcId": String,
    "SecurityIPList": String,
    "CoreInstanceType": String,
    "DiskSize": Integer,
    "ClusterName": String,
    "Engine": String,
    "PeriodUnit": String,
    "DeletionProtection": Boolean
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

AutoRenewPeriod

Integer

いいえ

いいえ

クラスタの自動更新期間。

単位:月。

このプロパティを 2 に設定すると、クラスタの有効期限が切れたときに、システムは自動的に 2 か月間クラスタを更新します。

説明

デフォルト値:0。値 0 は、クラスタの有効期限が切れたときに、システムがクラスタを自動的に更新しないことを示します。

ColdStorageSize

Integer

いいえ

いいえ

クラスタのコールドストレージ容量。

単位:GB。有効な値:

  • 0:このプロパティを 0 に設定すると、コールドストレージは無効になります。

  • 800 から 1000000:このプロパティをこれらの値のいずれかに設定すると、コールドストレージが有効になります。

説明

Engine が hbaseue に設定されている場合にのみ、コールドストレージ機能を有効にできます。

EngineVersion

String

はい

いいえ

クラスタのエンジンバージョン。

EngineVersion の有効な値は、Engine の値によって異なります。

  • Engine が hbase に設定されている場合の EngineVersion の有効な値:1.1 および 2.0

  • Engine が hbaseue に設定されている場合の EngineVersion の有効な値:2.0

  • Engine が bds に設定されている場合の EngineVersion の有効な値:1.0

ResourceGroupId

String

いいえ

いいえ

リソースグループの ID。

なし。

NodeCount

Integer

はい

はい

コアノードの数。

  • クラスタが単一ノードクラスタの場合の有効な値:1。

  • クラスタがクラウドディスクを使用する場合の有効な値:2 から 100。

  • クラスタがローカルディスクを使用する場合の有効な値:4 から 100。

ZoneId

String

はい

いいえ

ゾーン ID。

なし。

VSwitchId

String

いいえ

いいえ

VPC (Virtual Private Cloud) に属する vSwitch の ID。

なし。

Period

Integer

いいえ

いいえ

クラスタのサブスクリプション期間。

  • PeriodUnit が year に設定されている場合の有効な値:1 から 3

  • PeriodUnit が month に設定されている場合の有効な値:1 から 9

説明

PayType が Prepaid に設定されている場合にのみ、このプロパティを指定する必要があります。

EncryptionKey

String

いいえ

いいえ

暗号鍵の ID。

暗号化を有効にしない場合、値は空です。クラウドディスクを使用するクラスタで暗号化が有効になっている場合、クラスタの暗号化を無効にすることはできません。

PayType

String

はい

いいえ

クラスタの課金方法。

有効な値:

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

  • Postpaid:従量課金

MasterInstanceType

String

いいえ

はい

マスターノードのインスタンスタイプ。

DescribeAvailableResource 操作を呼び出して、インスタンスタイプをクエリできます。

DiskType

String

いいえ

いいえ

クラスタのコアノードのディスクカテゴリ。

有効な値:

  • cloud_efficiency: Ultra ディスク

  • cloud_ssd: 標準 SSD

  • local_hdd_pro: ローカル HDD

  • local_ssd_pro: ローカル SSD

  • cloud_essd_pl1: 企業向け SSD (ESSD)

VpcId

String

いいえ

いいえ

VPC ID。

このプロパティと VswitchId を空のままにすると、クラスタはクラシックネットワークを使用します。

SecurityIPList

String

いいえ

はい

クラスタのホワイトリストに追加する IP アドレスまたは CIDR ブロック。

複数の IP アドレスはコンマ (,) で区切ります。

説明

このプロパティを 127.0.0.1 に設定すると、すべての IP アドレスがクラスタにアクセスできなくなります。このプロパティを 192.168.0.0/24 に設定すると、192.168.0.XX 形式の IP アドレスがクラスタにアクセスできるようになります。

CoreInstanceType

String

はい

はい

コアノードのインスタンスタイプ。

DescribeAvailableResource 操作を呼び出して、インスタンスタイプをクエリできます。

DiskSize

Integer

いいえ

はい

コアノードのディスクサイズ。

単位:GB。

  • クラスタが単一ノードクラスタの場合の有効な値:20 から 500。単位:GB。値は 1 GB 単位です。

  • クラスタがクラウドディスクを使用する場合の有効な値:400 から 64000。単位:GB。値は 40 GB 単位です。

  • クラスタがローカルディスクを使用する場合、コアノードのインスタンスタイプによって有効な値が異なります。

    • コアノードのインスタンスタイプが hbase.d1.4xlarge の場合の有効な値:44000。

    • コアノードのインスタンスタイプが hbase.d1.6xlarge の場合の有効な値:66000。

    • コアノードのインスタンスタイプが hbase.d1.8xlarge の場合の有効な値:88000。

    • コアノードのインスタンスタイプが hbase.i2.xlarge の場合の有効な値:894。

    • コアノードのインスタンスタイプが hbase.i2.2xlarge の場合の有効な値:1788。

    • コアノードのインスタンスタイプが hbase.i2.4xlarge の場合の有効な値:3576。

    • コアノードのインスタンスタイプが hbase.i2.8xlarge の場合の有効な値:7152。

    • コアノードのインスタンスタイプが hbase.d2s.5xlarge の場合の有効な値:58400。

    • コアノードのインスタンスタイプが hbase.d2s.10xlarge の場合の有効な値:109500。

ClusterName

String

いいえ

はい

クラスタ名。

名前は次のルールに準拠する必要があります。

  • 名前の長さは 2 ~ 128 文字である必要があります。

  • 文字で始まる必要があります。

  • 数字と特殊文字を含めることができます。特殊文字には、ピリオド (.)、ハイフン (-)、アンダースコア (_) が含まれます。

Engine

String

はい

いいえ

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

有効な値:

  • hbase: ApsaraDB for HBase Standard Edition または ApsaraDB for HBase Standalone Edition

  • hbaseue: ApsaraDB for HBase Performance-enhanced Edition

  • bds: Lindorm Tunnel Service (LTS)

PeriodUnit

String

いいえ

いいえ

クラスタのサブスクリプション期間の単位。

有効な値:

  • year

  • month

説明

PayType が Prepaid に設定されている場合にのみ、このプロパティを指定する必要があります。

DeletionProtection

Boolean

いいえ

はい

削除保護機能を有効にするかどうかを指定します。

有効な値:

  • true: 削除保護機能を有効にします。この機能を有効にすると、クラスタを直接リリースすることはできません。クラスタをリリースする前に、この機能を無効にする必要があります。

  • false: 削除保護機能を無効にします。

戻り値

Fn::GetAtt

  • UiProxyConnAddrInfo: Web コンソールの接続アドレス。

  • ClusterId: クラスタ ID。

  • ServiceConnAddrs: サブサービスのアドレス。

  • ThriftConn: Thrift 接続のアドレス。

  • SlbConnAddrs: Server Load Balancer (SLB) インスタンスとの接続のアドレス。

  • ZkConnAddrs: Zookeeper 接続のアドレス。

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Required: false
    Type: String
    Description:
      ja: |-
        仮想プライベートクラウド (VPC) の ID。このパラメーターと VSwitchId パラメーターを空のままにすると、クラシックネットワークタイプが使用されます。VPC ネットワークタイプが優先されます。
  VSwitchId:
    AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId}
    Required: false
    Type: String
    Description:
      ja: vSwitch の ID。
  PayType:
    Default: Postpaid
    Required: true
    Type: String
    Description:
      ja: |-
        課金方法。
        Prepaid: サブスクリプション課金方法が使用されます。
        Postpaid: 従量課金方法が使用されます。
    AllowedValues:
      - Prepaid
      - Postpaid
  ZoneId:
    AssociationProperty: ZoneId
    Required: true
    Type: String
    Description:
      ja: ゾーンの ID。
Resources:
  Cluster:
    Type: ALIYUN::HBase::Cluster
    Properties:
      Engine: hbaseue
      VpcId:
        Ref: VpcId
      CoreInstanceType: hbase.sn1.2xlarge
      PayType:
        Ref: PayType
      ZoneId:
        Ref: ZoneId
      MasterInstanceType: hbase.sn1.large
      VSwitchId:
        Ref: VSwitchId
      EngineVersion: '2.0'
      NodeCount: 2
      DiskSize: 400
      DiskType: cloud_ssd
Outputs:
  ServiceConnAddrs:
    Description: ServiceConnAddr のリスト。
    Value:
      Fn::GetAtt:
        - Cluster
        - ServiceConnAddrs
  UiProxyConnAddrInfo:
    Description: WebUI 接続情報リスト。
    Value:
      Fn::GetAtt:
        - Cluster
        - UiProxyConnAddrInfo
  ThriftConn:
    Description: Thrift 接続アドレスリスト。
    Value:
      Fn::GetAtt:
        - Cluster
        - ThriftConn
  SlbConnAddrs:
    Description: SlbConnAddr のリスト。
    Value:
      Fn::GetAtt:
        - Cluster
        - SlbConnAddrs
  ClusterId:
    Description: インスタンスの ID。
    Value:
      Fn::GetAtt:
        - Cluster
        - ClusterId
  ZkConnAddrs:
    Description: ZkConnAddr のリスト。
    Value:
      Fn::GetAtt:
        - Cluster
        - ZkConnAddrs
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ZoneId": {
      "AssociationProperty": "ZoneId",
      "Type": "String",
      "Description": {
        "ja": "ゾーンの ID。"
      },
      "Required": true
    },
    "VSwitchId": {
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId}"
      },
      "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
      "Type": "String",
      "Description": {
        "ja": "vSwitch の ID。"
      },
      "Required": false
    },
    "PayType": {
      "Type": "String",
      "Description": {
        "ja": "課金方法。\nPrepaid: サブスクリプション課金方法が使用されます。\nPostpaid: 従量課金方法が使用されます。"
      },
      "AllowedValues": [
        "Prepaid",
        "Postpaid"
      ],
      "Required": true,
      "Default": "Postpaid"
    },
    "VpcId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": {
        "ja": "仮想プライベートクラウド (VPC) の ID。このパラメーターと VSwitchId パラメーターを空のままにすると、クラシックネットワークタイプが使用されます。VPC ネットワークタイプが優先されます。"
      },
      "Required": false
    }
  },
  "Resources": {
    "Cluster": {
      "Type": "ALIYUN::HBase::Cluster",
      "Properties": {
        "EngineVersion": "2.0",
        "NodeCount": 2,
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "PayType": {
          "Ref": "PayType"
        },
        "MasterInstanceType": "hbase.sn1.large",
        "DiskType": "cloud_ssd",
        "VpcId": {
          "Ref": "VpcId"
        },
        "CoreInstanceType": "hbase.sn1.2xlarge",
        "Engine": "hbaseue",
        "DiskSize": 400
      }
    }
  },
  "Outputs": {
    "UiProxyConnAddrInfo": {
      "Description": "WebUI 接続情報リスト。",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "UiProxyConnAddrInfo"
        ]
      }
    },
    "ClusterId": {
      "Description": "インスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ClusterId"
        ]
      }
    },
    "ServiceConnAddrs": {
      "Description": "ServiceConnAddr のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ServiceConnAddrs"
        ]
      }
    },
    "ThriftConn": {
      "Description": "Thrift 接続アドレスリスト。",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ThriftConn"
        ]
      }
    },
    "SlbConnAddrs": {
      "Description": "SlbConnAddr のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "SlbConnAddrs"

        ]
      }
    },
    "ZkConnAddrs": {
      "Description": "ZkConnAddr のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ZkConnAddrs"
        ]
      }
    }
  }
}