Todos os produtos
Search
Central de documentação

Resource Orchestration Service:ALIYUN::HBase::Cluster

Última atualização: Jun 27, 2026

Cria um cluster do ApsaraDB for HBase.

Sintaxe

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

Propriedades

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

AutoRenewPeriod

Integer

Não

Não

Período de renovação automática.

Unidade: mês.

Exemplo: 2 indica renovação automática por 2 meses após o vencimento.

Nota

Padrão: 0 (sem renovação automática).

ColdStorageSize

Integer

Não

Não

Capacidade de armazenamento frio.

Unidade: GB. Valores válidos:

  • 0: armazenamento frio desativado.

  • 800 a 1.000.000: armazenamento frio ativado.

Nota

Disponível apenas quando Engine é definido como hbaseue.

EngineVersion

String

Sim

Não

Versão do mecanismo.

Os valores válidos dependem do Engine:

  • hbase: 1,1 e 2,0.

  • hbaseue: 2,0.

  • bds: 1,0.

ResourceGroupId

String

Não

Não

ID do grupo de recursos.

Nenhuma.

NodeCount

Integer

Sim

Sim

Número de nós principais.

  • Cluster de nó único: 1.

  • Discos em nuvem: 2 a 100.

  • Discos locais: 4 a 100.

ZoneId

String

Sim

Não

ID da zona.

Nenhuma.

VSwitchId

String

Não

Não

ID do vSwitch na VPC.

Nenhuma.

Period

Integer

Não

Não

Duração da assinatura.

  • year: 1 a 3.

  • month: 1 a 9.

Nota

Obrigatório apenas quando PayType é definido como Prepaid.

EncryptionKey

String

Não

Não

ID da chave de criptografia.

Vazio se a criptografia estiver desativada. Após ativar a criptografia em clusters com discos em nuvem, não é possível desativá-la.

PayType

String

Sim

Não

Método de faturamento.

Valores válidos:

  • Prepaid: assinatura

  • Postpaid: pagamento conforme o uso

MasterInstanceType

String

Não

Sim

Tipo de instância do nó mestre.

Use a operação DescribeAvailableResource para consultar o tipo de instância.

DiskType

String

Não

Não

Categoria do disco do nó principal.

Valores válidos:

  • cloud_efficiency: disco ultra

  • cloud_ssd: SSD padrão

  • local_hdd_pro: HDD local

  • local_ssd_pro: SSD local

  • cloud_essd_pl1: Enterprise SSD (ESSD)

VpcId

String

Não

Não

ID da VPC.

Se esta propriedade e VswitchId estiverem vazias, o sistema usará a rede clássica.

SecurityIPList

String

Não

Sim

Endereços IP ou blocos CIDR na lista de permissões do cluster.

Separe vários endereços com vírgulas (,).

Nota

Exemplo: 127.0.0.1 bloqueia todo o acesso. 192.168.0.0/24 permite o bloco CIDR 192.168.0.0/24.

CoreInstanceType

String

Sim

Sim

Tipo de instância do nó principal.

Use a operação DescribeAvailableResource para consultar o tipo de instância.

DiskSize

Integer

Não

Sim

Tamanho do disco do nó principal.

Unidade: GB.

  • Cluster de nó único: 20 a 500 (incrementos de 1 GB).

  • Discos em nuvem: 400 a 64.000 (incrementos de 40 GB).

  • Discos locais (varia conforme o tipo de instância do nó principal):

    • hbase.d1.4xlarge: 44.000.

    • hbase.d1.6xlarge: 66.000.

    • hbase.d1.8xlarge: 88.000.

    • hbase.i2.xlarge: 894.

    • hbase.i2.2xlarge: 1.788.

    • hbase.i2.4xlarge: 3.576.

    • hbase.i2.8xlarge: 7.152.

    • hbase.d2s.5xlarge: 58.400.

    • hbase.d2s.10xlarge: 109.500.

ClusterName

String

Não

Sim

Nome do cluster.

Regras de nomenclatura:

  • Comprimento entre 2 e 128 caracteres.

  • Deve começar com uma letra.

  • Pode conter dígitos, pontos (.), hífens (-) e sublinhados (_).

Engine

String

Sim

Não

Tipo de mecanismo de banco de dados.

Valores válidos:

  • hbase: ApsaraDB for HBase Standard Edition ou ApsaraDB for HBase Standalone Edition

  • hbaseue: ApsaraDB for HBase Performance-enhanced Edition

  • bds: Lindorm Tunnel Service (LTS)

PeriodUnit

String

Não

Não

Unidade da duração da assinatura.

Valores válidos:

  • year

  • month

Nota

Obrigatório apenas quando PayType é definido como Prepaid.

DeletionProtection

Boolean

Não

Sim

Indica se a proteção contra exclusão deve ser ativada.

Valores válidos:

  • true: ativa a proteção contra exclusão. O cluster não pode ser liberado enquanto este recurso estiver ativado.

  • false: desativa a proteção contra exclusão.

Valores de retorno

Fn::GetAtt

  • UiProxyConnAddrInfo: endereços de conexão do console web.

  • ClusterId: ID do cluster.

  • ServiceConnAddrs: endereços de conexão de subserviços.

  • ThriftConn: endereços de conexão Thrift.

  • SlbConnAddrs: endereços de conexão SLB.

  • ZkConnAddrs: endereços de conexão ZooKeeper.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Required: false
    Type: String
    Description:
      en: |-
        The ID of the virtual private cloud (VPC). If you leave this parameter and the VSwitchId
        parameter empty, the classic network type is used. The VPC network type is preferred.
  VSwitchId:
    AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId}
    Required: false
    Type: String
    Description:
      en: The ID of the vSwitch.
  PayType:
    Default: Postpaid
    Required: true
    Type: String
    Description:
      en: |-
        The billing method.
        Prepaid: The subscription billing method is used.
        Postpaid: The pay-as-you-go billing method is used.
    AllowedValues:
      - Prepaid
      - Postpaid
  ZoneId:
    AssociationProperty: ZoneId
    Required: true
    Type: String
    Description:
      en: The ID of the zone.
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: LIST of ServiceConnAddr.
    Value:
      Fn::GetAtt:
        - Cluster
        - ServiceConnAddrs
  UiProxyConnAddrInfo:
    Description: WebUI connection information list.
    Value:
      Fn::GetAtt:
        - Cluster
        - UiProxyConnAddrInfo
  ThriftConn:
    Description: Thrift Connection address list.
    Value:
      Fn::GetAtt:
        - Cluster
        - ThriftConn
  SlbConnAddrs:
    Description: LIST of SlbConnAddr.
    Value:
      Fn::GetAtt:
        - Cluster
        - SlbConnAddrs
  ClusterId:
    Description: The ID of the instance.
    Value:
      Fn::GetAtt:
        - Cluster
        - ClusterId
  ZkConnAddrs:
    Description: List of ZkConnAddr.
    Value:
      Fn::GetAtt:
        - Cluster
        - ZkConnAddrs
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ZoneId": {
      "AssociationProperty": "ZoneId",
      "Type": "String",
      "Description": {
        "en": "The ID of the zone."
      },
      "Required": true
    },
    "VSwitchId": {
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId}"
      },
      "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
      "Type": "String",
      "Description": {
        "en": "The ID of the vSwitch."
      },
      "Required": false
    },
    "PayType": {
      "Type": "String",
      "Description": {
        "en": "The billing method.\nPrepaid: The subscription billing method is used.\nPostpaid: The pay-as-you-go billing method is used."
      },
      "AllowedValues": [
        "Prepaid",
        "Postpaid"
      ],
      "Required": true,
      "Default": "Postpaid"
    },
    "VpcId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": {
        "en": "The ID of the virtual private cloud (VPC). If you leave this parameter and the VSwitchId\nparameter empty, the classic network type is used. The VPC network type is preferred."
      },
      "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 connection information list.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "UiProxyConnAddrInfo"
        ]
      }
    },
    "ClusterId": {
      "Description": "The ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ClusterId"
        ]
      }
    },
    "ServiceConnAddrs": {
      "Description": "LIST of ServiceConnAddr.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ServiceConnAddrs"
        ]
      }
    },
    "ThriftConn": {
      "Description": "Thrift Connection address list.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ThriftConn"
        ]
      }
    },
    "SlbConnAddrs": {
      "Description": "LIST of SlbConnAddr.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "SlbConnAddrs"
        ]
      }
    },
    "ZkConnAddrs": {
      "Description": "List of ZkConnAddr.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ZkConnAddrs"
        ]
      }
    }
  }
}