1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. hbase
  5. Instance
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
bytepluscc logo
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus

    表格数据库 HBase 版是基于 Apache HBase 提供的全托管 NoSQL 服务,兼容标准 HBase 访问协议,具备低成本存储、高扩展吞吐等优势。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as bytepluscc from "@byteplus/pulumi-bytepluscc";
    
    const hBaseInstanceDemo = new bytepluscc.hbase.Instance("HBaseInstanceDemo", {
        regionId: "cn-beijing",
        multiAz: false,
        zoneId: "cn-beijing-a",
        instanceName: "HBaseInstanceDemo",
        engineVersion: "HBase_2.0",
        instanceType: "Standard",
        masterSpec: "hbase.x1.medium",
        rsCount: 2,
        rsSpec: "hbase.x1.large",
        storageCapacity: 20000,
        vpcId: "vpc-rrco37ovjq4gv0x5xxxxx",
        projectName: "default",
        chargeType: "PrePaid",
        purchaseMonths: 1,
        autoRenew: false,
        subnetId: "subnet-rrwqhg3qzxfkv0x57xxxxx",
        deletionProtection: "disabled",
        enableCloudStorage: false,
        tags: [{
            key: "env",
            value: "test",
        }],
        storageType: "HdfsSsd",
        enableAuth: true,
    });
    
    import pulumi
    import pulumi_bytepluscc as bytepluscc
    
    h_base_instance_demo = bytepluscc.hbase.Instance("HBaseInstanceDemo",
        region_id="cn-beijing",
        multi_az=False,
        zone_id="cn-beijing-a",
        instance_name="HBaseInstanceDemo",
        engine_version="HBase_2.0",
        instance_type="Standard",
        master_spec="hbase.x1.medium",
        rs_count=2,
        rs_spec="hbase.x1.large",
        storage_capacity=20000,
        vpc_id="vpc-rrco37ovjq4gv0x5xxxxx",
        project_name="default",
        charge_type="PrePaid",
        purchase_months=1,
        auto_renew=False,
        subnet_id="subnet-rrwqhg3qzxfkv0x57xxxxx",
        deletion_protection="disabled",
        enable_cloud_storage=False,
        tags=[{
            "key": "env",
            "value": "test",
        }],
        storage_type="HdfsSsd",
        enable_auth=True)
    
    package main
    
    import (
    	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/hbase"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := hbase.NewInstance(ctx, "HBaseInstanceDemo", &hbase.InstanceArgs{
    			RegionId:           pulumi.String("cn-beijing"),
    			MultiAz:            pulumi.Bool(false),
    			ZoneId:             pulumi.String("cn-beijing-a"),
    			InstanceName:       pulumi.String("HBaseInstanceDemo"),
    			EngineVersion:      pulumi.String("HBase_2.0"),
    			InstanceType:       pulumi.String("Standard"),
    			MasterSpec:         pulumi.String("hbase.x1.medium"),
    			RsCount:            pulumi.Int(2),
    			RsSpec:             pulumi.String("hbase.x1.large"),
    			StorageCapacity:    pulumi.Int(20000),
    			VpcId:              pulumi.String("vpc-rrco37ovjq4gv0x5xxxxx"),
    			ProjectName:        pulumi.String("default"),
    			ChargeType:         pulumi.String("PrePaid"),
    			PurchaseMonths:     pulumi.Int(1),
    			AutoRenew:          pulumi.Bool(false),
    			SubnetId:           pulumi.String("subnet-rrwqhg3qzxfkv0x57xxxxx"),
    			DeletionProtection: pulumi.String("disabled"),
    			EnableCloudStorage: pulumi.Bool(false),
    			Tags: hbase.InstanceTagArray{
    				&hbase.InstanceTagArgs{
    					Key:   pulumi.String("env"),
    					Value: pulumi.String("test"),
    				},
    			},
    			StorageType: pulumi.String("HdfsSsd"),
    			EnableAuth:  pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Bytepluscc = Byteplus.Pulumi.Bytepluscc;
    
    return await Deployment.RunAsync(() => 
    {
        var hBaseInstanceDemo = new Bytepluscc.Hbase.Instance("HBaseInstanceDemo", new()
        {
            RegionId = "cn-beijing",
            MultiAz = false,
            ZoneId = "cn-beijing-a",
            InstanceName = "HBaseInstanceDemo",
            EngineVersion = "HBase_2.0",
            InstanceType = "Standard",
            MasterSpec = "hbase.x1.medium",
            RsCount = 2,
            RsSpec = "hbase.x1.large",
            StorageCapacity = 20000,
            VpcId = "vpc-rrco37ovjq4gv0x5xxxxx",
            ProjectName = "default",
            ChargeType = "PrePaid",
            PurchaseMonths = 1,
            AutoRenew = false,
            SubnetId = "subnet-rrwqhg3qzxfkv0x57xxxxx",
            DeletionProtection = "disabled",
            EnableCloudStorage = false,
            Tags = new[]
            {
                new Bytepluscc.Hbase.Inputs.InstanceTagArgs
                {
                    Key = "env",
                    Value = "test",
                },
            },
            StorageType = "HdfsSsd",
            EnableAuth = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.byteplus.bytepluscc.hbase.Instance;
    import com.byteplus.bytepluscc.hbase.InstanceArgs;
    import com.pulumi.bytepluscc.hbase.inputs.InstanceTagArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var hBaseInstanceDemo = new Instance("hBaseInstanceDemo", InstanceArgs.builder()
                .regionId("cn-beijing")
                .multiAz(false)
                .zoneId("cn-beijing-a")
                .instanceName("HBaseInstanceDemo")
                .engineVersion("HBase_2.0")
                .instanceType("Standard")
                .masterSpec("hbase.x1.medium")
                .rsCount(2)
                .rsSpec("hbase.x1.large")
                .storageCapacity(20000)
                .vpcId("vpc-rrco37ovjq4gv0x5xxxxx")
                .projectName("default")
                .chargeType("PrePaid")
                .purchaseMonths(1)
                .autoRenew(false)
                .subnetId("subnet-rrwqhg3qzxfkv0x57xxxxx")
                .deletionProtection("disabled")
                .enableCloudStorage(false)
                .tags(InstanceTagArgs.builder()
                    .key("env")
                    .value("test")
                    .build())
                .storageType("HdfsSsd")
                .enableAuth(true)
                .build());
    
        }
    }
    
    resources:
      hBaseInstanceDemo:
        type: bytepluscc:hbase:Instance
        name: HBaseInstanceDemo
        properties:
          regionId: cn-beijing
          multiAz: false
          zoneId: cn-beijing-a
          instanceName: HBaseInstanceDemo
          engineVersion: HBase_2.0
          instanceType: Standard
          masterSpec: hbase.x1.medium
          rsCount: 2
          rsSpec: hbase.x1.large
          storageCapacity: 20000
          vpcId: vpc-rrco37ovjq4gv0x5xxxxx
          projectName: default
          chargeType: PrePaid
          purchaseMonths: 1
          autoRenew: false
          subnetId: subnet-rrwqhg3qzxfkv0x57xxxxx
          deletionProtection: disabled
          enableCloudStorage: false
          tags:
            - key: env
              value: test
          storageType: HdfsSsd
          enableAuth: true
    

    Create Instance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
    def Instance(resource_name: str,
                 args: InstanceArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Instance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 rs_count: Optional[int] = None,
                 engine_version: Optional[str] = None,
                 zone_id: Optional[str] = None,
                 vpc_id: Optional[str] = None,
                 subnet_id: Optional[str] = None,
                 storage_type: Optional[str] = None,
                 master_spec: Optional[str] = None,
                 storage_capacity: Optional[int] = None,
                 rs_spec: Optional[str] = None,
                 region_id: Optional[str] = None,
                 charge_type: Optional[str] = None,
                 endpoints: Optional[Sequence[InstanceEndpointArgs]] = None,
                 instance_name: Optional[str] = None,
                 purchase_months: Optional[int] = None,
                 instance_type: Optional[str] = None,
                 auto_renew: Optional[bool] = None,
                 multi_az: Optional[bool] = None,
                 project_name: Optional[str] = None,
                 enable_cloud_storage: Optional[bool] = None,
                 enable_auth: Optional[bool] = None,
                 tags: Optional[Sequence[InstanceTagArgs]] = None,
                 deletion_protection: Optional[str] = None,
                 cold_storage: Optional[int] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
    public Instance(String name, InstanceArgs args, CustomResourceOptions options)
    
    type: bytepluscc:hbase:Instance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleinstanceResourceResourceFromHbaseinstance = new Bytepluscc.Hbase.Instance("exampleinstanceResourceResourceFromHbaseinstance", new()
    {
        RsCount = 0,
        EngineVersion = "string",
        ZoneId = "string",
        VpcId = "string",
        SubnetId = "string",
        StorageType = "string",
        MasterSpec = "string",
        StorageCapacity = 0,
        RsSpec = "string",
        RegionId = "string",
        ChargeType = "string",
        Endpoints = new[]
        {
            new Bytepluscc.Hbase.Inputs.InstanceEndpointArgs
            {
                AddressType = "string",
                EipId = "string",
                EndpointId = "string",
                EndpointStr = "string",
                NetworkType = "string",
                PrivateDnsVisibility = false,
            },
        },
        InstanceName = "string",
        PurchaseMonths = 0,
        InstanceType = "string",
        AutoRenew = false,
        MultiAz = false,
        ProjectName = "string",
        EnableCloudStorage = false,
        EnableAuth = false,
        Tags = new[]
        {
            new Bytepluscc.Hbase.Inputs.InstanceTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        DeletionProtection = "string",
        ColdStorage = 0,
    });
    
    example, err := hbase.NewInstance(ctx, "exampleinstanceResourceResourceFromHbaseinstance", &hbase.InstanceArgs{
    	RsCount:         pulumi.Int(0),
    	EngineVersion:   pulumi.String("string"),
    	ZoneId:          pulumi.String("string"),
    	VpcId:           pulumi.String("string"),
    	SubnetId:        pulumi.String("string"),
    	StorageType:     pulumi.String("string"),
    	MasterSpec:      pulumi.String("string"),
    	StorageCapacity: pulumi.Int(0),
    	RsSpec:          pulumi.String("string"),
    	RegionId:        pulumi.String("string"),
    	ChargeType:      pulumi.String("string"),
    	Endpoints: hbase.InstanceEndpointArray{
    		&hbase.InstanceEndpointArgs{
    			AddressType:          pulumi.String("string"),
    			EipId:                pulumi.String("string"),
    			EndpointId:           pulumi.String("string"),
    			EndpointStr:          pulumi.String("string"),
    			NetworkType:          pulumi.String("string"),
    			PrivateDnsVisibility: pulumi.Bool(false),
    		},
    	},
    	InstanceName:       pulumi.String("string"),
    	PurchaseMonths:     pulumi.Int(0),
    	InstanceType:       pulumi.String("string"),
    	AutoRenew:          pulumi.Bool(false),
    	MultiAz:            pulumi.Bool(false),
    	ProjectName:        pulumi.String("string"),
    	EnableCloudStorage: pulumi.Bool(false),
    	EnableAuth:         pulumi.Bool(false),
    	Tags: hbase.InstanceTagArray{
    		&hbase.InstanceTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	DeletionProtection: pulumi.String("string"),
    	ColdStorage:        pulumi.Int(0),
    })
    
    var exampleinstanceResourceResourceFromHbaseinstance = new com.byteplus.bytepluscc.hbase.Instance("exampleinstanceResourceResourceFromHbaseinstance", com.byteplus.bytepluscc.hbase.InstanceArgs.builder()
        .rsCount(0)
        .engineVersion("string")
        .zoneId("string")
        .vpcId("string")
        .subnetId("string")
        .storageType("string")
        .masterSpec("string")
        .storageCapacity(0)
        .rsSpec("string")
        .regionId("string")
        .chargeType("string")
        .endpoints(InstanceEndpointArgs.builder()
            .addressType("string")
            .eipId("string")
            .endpointId("string")
            .endpointStr("string")
            .networkType("string")
            .privateDnsVisibility(false)
            .build())
        .instanceName("string")
        .purchaseMonths(0)
        .instanceType("string")
        .autoRenew(false)
        .multiAz(false)
        .projectName("string")
        .enableCloudStorage(false)
        .enableAuth(false)
        .tags(InstanceTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .deletionProtection("string")
        .coldStorage(0)
        .build());
    
    exampleinstance_resource_resource_from_hbaseinstance = bytepluscc.hbase.Instance("exampleinstanceResourceResourceFromHbaseinstance",
        rs_count=0,
        engine_version="string",
        zone_id="string",
        vpc_id="string",
        subnet_id="string",
        storage_type="string",
        master_spec="string",
        storage_capacity=0,
        rs_spec="string",
        region_id="string",
        charge_type="string",
        endpoints=[{
            "address_type": "string",
            "eip_id": "string",
            "endpoint_id": "string",
            "endpoint_str": "string",
            "network_type": "string",
            "private_dns_visibility": False,
        }],
        instance_name="string",
        purchase_months=0,
        instance_type="string",
        auto_renew=False,
        multi_az=False,
        project_name="string",
        enable_cloud_storage=False,
        enable_auth=False,
        tags=[{
            "key": "string",
            "value": "string",
        }],
        deletion_protection="string",
        cold_storage=0)
    
    const exampleinstanceResourceResourceFromHbaseinstance = new bytepluscc.hbase.Instance("exampleinstanceResourceResourceFromHbaseinstance", {
        rsCount: 0,
        engineVersion: "string",
        zoneId: "string",
        vpcId: "string",
        subnetId: "string",
        storageType: "string",
        masterSpec: "string",
        storageCapacity: 0,
        rsSpec: "string",
        regionId: "string",
        chargeType: "string",
        endpoints: [{
            addressType: "string",
            eipId: "string",
            endpointId: "string",
            endpointStr: "string",
            networkType: "string",
            privateDnsVisibility: false,
        }],
        instanceName: "string",
        purchaseMonths: 0,
        instanceType: "string",
        autoRenew: false,
        multiAz: false,
        projectName: "string",
        enableCloudStorage: false,
        enableAuth: false,
        tags: [{
            key: "string",
            value: "string",
        }],
        deletionProtection: "string",
        coldStorage: 0,
    });
    
    type: bytepluscc:hbase:Instance
    properties:
        autoRenew: false
        chargeType: string
        coldStorage: 0
        deletionProtection: string
        enableAuth: false
        enableCloudStorage: false
        endpoints:
            - addressType: string
              eipId: string
              endpointId: string
              endpointStr: string
              networkType: string
              privateDnsVisibility: false
        engineVersion: string
        instanceName: string
        instanceType: string
        masterSpec: string
        multiAz: false
        projectName: string
        purchaseMonths: 0
        regionId: string
        rsCount: 0
        rsSpec: string
        storageCapacity: 0
        storageType: string
        subnetId: string
        tags:
            - key: string
              value: string
        vpcId: string
        zoneId: string
    

    Instance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Instance resource accepts the following input properties:

    ChargeType string
    计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
    EngineVersion string
    HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
    MasterSpec string
    Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
    RegionId string
    实例所属的地域 ID。
    RsCount int
    RegionServer 节点的数量。
    RsSpec string
    RegionServer 节点的规格码。
    StorageCapacity int
    实例总存储容量,单位:GiB。
    StorageType string
    实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
    SubnetId string
    实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
    VpcId string
    私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
    ZoneId string
    实例所属的可用区 ID。
    AutoRenew bool
    预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
    ColdStorage int
    实例总容量型存储空间大小,单位 GiB。
    DeletionProtection string
    实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
    EnableAuth bool
    是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
    EnableCloudStorage bool
    是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
    Endpoints List<Byteplus.InstanceEndpoint>
    InstanceName string
    实例名称。
    InstanceType string
    实例类型。当前仅支持标准型,取值默认为 Standard。
    MultiAz bool
    实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
    ProjectName string
    实例所属的项目名称。
    PurchaseMonths int
    购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
    Tags List<Byteplus.InstanceTag>
    ChargeType string
    计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
    EngineVersion string
    HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
    MasterSpec string
    Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
    RegionId string
    实例所属的地域 ID。
    RsCount int
    RegionServer 节点的数量。
    RsSpec string
    RegionServer 节点的规格码。
    StorageCapacity int
    实例总存储容量,单位:GiB。
    StorageType string
    实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
    SubnetId string
    实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
    VpcId string
    私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
    ZoneId string
    实例所属的可用区 ID。
    AutoRenew bool
    预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
    ColdStorage int
    实例总容量型存储空间大小,单位 GiB。
    DeletionProtection string
    实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
    EnableAuth bool
    是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
    EnableCloudStorage bool
    是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
    Endpoints []InstanceEndpointArgs
    InstanceName string
    实例名称。
    InstanceType string
    实例类型。当前仅支持标准型,取值默认为 Standard。
    MultiAz bool
    实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
    ProjectName string
    实例所属的项目名称。
    PurchaseMonths int
    购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
    Tags []InstanceTagArgs
    chargeType String
    计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
    engineVersion String
    HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
    masterSpec String
    Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
    regionId String
    实例所属的地域 ID。
    rsCount Integer
    RegionServer 节点的数量。
    rsSpec String
    RegionServer 节点的规格码。
    storageCapacity Integer
    实例总存储容量,单位:GiB。
    storageType String
    实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
    subnetId String
    实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
    vpcId String
    私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
    zoneId String
    实例所属的可用区 ID。
    autoRenew Boolean
    预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
    coldStorage Integer
    实例总容量型存储空间大小,单位 GiB。
    deletionProtection String
    实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
    enableAuth Boolean
    是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
    enableCloudStorage Boolean
    是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
    endpoints List<InstanceEndpoint>
    instanceName String
    实例名称。
    instanceType String
    实例类型。当前仅支持标准型,取值默认为 Standard。
    multiAz Boolean
    实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
    projectName String
    实例所属的项目名称。
    purchaseMonths Integer
    购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
    tags List<InstanceTag>
    chargeType string
    计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
    engineVersion string
    HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
    masterSpec string
    Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
    regionId string
    实例所属的地域 ID。
    rsCount number
    RegionServer 节点的数量。
    rsSpec string
    RegionServer 节点的规格码。
    storageCapacity number
    实例总存储容量,单位:GiB。
    storageType string
    实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
    subnetId string
    实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
    vpcId string
    私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
    zoneId string
    实例所属的可用区 ID。
    autoRenew boolean
    预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
    coldStorage number
    实例总容量型存储空间大小,单位 GiB。
    deletionProtection string
    实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
    enableAuth boolean
    是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
    enableCloudStorage boolean
    是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
    endpoints InstanceEndpoint[]
    instanceName string
    实例名称。
    instanceType string
    实例类型。当前仅支持标准型,取值默认为 Standard。
    multiAz boolean
    实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
    projectName string
    实例所属的项目名称。
    purchaseMonths number
    购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
    tags InstanceTag[]
    charge_type str
    计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
    engine_version str
    HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
    master_spec str
    Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
    region_id str
    实例所属的地域 ID。
    rs_count int
    RegionServer 节点的数量。
    rs_spec str
    RegionServer 节点的规格码。
    storage_capacity int
    实例总存储容量,单位:GiB。
    storage_type str
    实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
    subnet_id str
    实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
    vpc_id str
    私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
    zone_id str
    实例所属的可用区 ID。
    auto_renew bool
    预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
    cold_storage int
    实例总容量型存储空间大小,单位 GiB。
    deletion_protection str
    实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
    enable_auth bool
    是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
    enable_cloud_storage bool
    是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
    endpoints Sequence[InstanceEndpointArgs]
    instance_name str
    实例名称。
    instance_type str
    实例类型。当前仅支持标准型,取值默认为 Standard。
    multi_az bool
    实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
    project_name str
    实例所属的项目名称。
    purchase_months int
    购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
    tags Sequence[InstanceTagArgs]
    chargeType String
    计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
    engineVersion String
    HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
    masterSpec String
    Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
    regionId String
    实例所属的地域 ID。
    rsCount Number
    RegionServer 节点的数量。
    rsSpec String
    RegionServer 节点的规格码。
    storageCapacity Number
    实例总存储容量,单位:GiB。
    storageType String
    实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
    subnetId String
    实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
    vpcId String
    私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
    zoneId String
    实例所属的可用区 ID。
    autoRenew Boolean
    预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
    coldStorage Number
    实例总容量型存储空间大小,单位 GiB。
    deletionProtection String
    实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
    enableAuth Boolean
    是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
    enableCloudStorage Boolean
    是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
    endpoints List<Property Map>
    instanceName String
    实例名称。
    instanceType String
    实例类型。当前仅支持标准型,取值默认为 Standard。
    multiAz Boolean
    实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
    projectName String
    实例所属的项目名称。
    purchaseMonths Number
    购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
    tags List<Property Map>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

    ChargeStatus string
    计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
    CreateTime string
    实例创建时间(UTC 时间)。
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    实例 ID。
    MasterCount int
    Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
    PrimarySubnetId string
    实时主可用区子网 ID。
    PrimaryZoneId string
    实时主可用区 ID。
    StandbySubnetId string
    实时备可用区子网 ID。
    StandbyZoneId string
    实时备可用区 ID。
    Status string
    实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
    UsedColdStorage int
    实例已使用的容量型存储空间大小,单位 MiB。
    UsedStorage double
    主实例已使用的存储容量,单位:MiB。
    VpcName string
    实例所属的私有网络名称。
    ZoneName string
    实例所属的可用区名称。
    ChargeStatus string
    计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
    CreateTime string
    实例创建时间(UTC 时间)。
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    实例 ID。
    MasterCount int
    Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
    PrimarySubnetId string
    实时主可用区子网 ID。
    PrimaryZoneId string
    实时主可用区 ID。
    StandbySubnetId string
    实时备可用区子网 ID。
    StandbyZoneId string
    实时备可用区 ID。
    Status string
    实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
    UsedColdStorage int
    实例已使用的容量型存储空间大小,单位 MiB。
    UsedStorage float64
    主实例已使用的存储容量,单位:MiB。
    VpcName string
    实例所属的私有网络名称。
    ZoneName string
    实例所属的可用区名称。
    chargeStatus String
    计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
    createTime String
    实例创建时间(UTC 时间)。
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    实例 ID。
    masterCount Integer
    Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
    primarySubnetId String
    实时主可用区子网 ID。
    primaryZoneId String
    实时主可用区 ID。
    standbySubnetId String
    实时备可用区子网 ID。
    standbyZoneId String
    实时备可用区 ID。
    status String
    实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
    usedColdStorage Integer
    实例已使用的容量型存储空间大小,单位 MiB。
    usedStorage Double
    主实例已使用的存储容量,单位:MiB。
    vpcName String
    实例所属的私有网络名称。
    zoneName String
    实例所属的可用区名称。
    chargeStatus string
    计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
    createTime string
    实例创建时间(UTC 时间)。
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    实例 ID。
    masterCount number
    Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
    primarySubnetId string
    实时主可用区子网 ID。
    primaryZoneId string
    实时主可用区 ID。
    standbySubnetId string
    实时备可用区子网 ID。
    standbyZoneId string
    实时备可用区 ID。
    status string
    实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
    usedColdStorage number
    实例已使用的容量型存储空间大小,单位 MiB。
    usedStorage number
    主实例已使用的存储容量,单位:MiB。
    vpcName string
    实例所属的私有网络名称。
    zoneName string
    实例所属的可用区名称。
    charge_status str
    计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
    create_time str
    实例创建时间(UTC 时间)。
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    实例 ID。
    master_count int
    Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
    primary_subnet_id str
    实时主可用区子网 ID。
    primary_zone_id str
    实时主可用区 ID。
    standby_subnet_id str
    实时备可用区子网 ID。
    standby_zone_id str
    实时备可用区 ID。
    status str
    实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
    used_cold_storage int
    实例已使用的容量型存储空间大小,单位 MiB。
    used_storage float
    主实例已使用的存储容量,单位:MiB。
    vpc_name str
    实例所属的私有网络名称。
    zone_name str
    实例所属的可用区名称。
    chargeStatus String
    计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
    createTime String
    实例创建时间(UTC 时间)。
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    实例 ID。
    masterCount Number
    Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
    primarySubnetId String
    实时主可用区子网 ID。
    primaryZoneId String
    实时主可用区 ID。
    standbySubnetId String
    实时备可用区子网 ID。
    standbyZoneId String
    实时备可用区 ID。
    status String
    实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
    usedColdStorage Number
    实例已使用的容量型存储空间大小,单位 MiB。
    usedStorage Number
    主实例已使用的存储容量,单位:MiB。
    vpcName String
    实例所属的私有网络名称。
    zoneName String
    实例所属的可用区名称。

    Look up Existing Instance Resource

    Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_renew: Optional[bool] = None,
            charge_status: Optional[str] = None,
            charge_type: Optional[str] = None,
            cold_storage: Optional[int] = None,
            create_time: Optional[str] = None,
            deletion_protection: Optional[str] = None,
            enable_auth: Optional[bool] = None,
            enable_cloud_storage: Optional[bool] = None,
            endpoints: Optional[Sequence[InstanceEndpointArgs]] = None,
            engine_version: Optional[str] = None,
            instance_id: Optional[str] = None,
            instance_name: Optional[str] = None,
            instance_type: Optional[str] = None,
            master_count: Optional[int] = None,
            master_spec: Optional[str] = None,
            multi_az: Optional[bool] = None,
            primary_subnet_id: Optional[str] = None,
            primary_zone_id: Optional[str] = None,
            project_name: Optional[str] = None,
            purchase_months: Optional[int] = None,
            region_id: Optional[str] = None,
            rs_count: Optional[int] = None,
            rs_spec: Optional[str] = None,
            standby_subnet_id: Optional[str] = None,
            standby_zone_id: Optional[str] = None,
            status: Optional[str] = None,
            storage_capacity: Optional[int] = None,
            storage_type: Optional[str] = None,
            subnet_id: Optional[str] = None,
            tags: Optional[Sequence[InstanceTagArgs]] = None,
            used_cold_storage: Optional[int] = None,
            used_storage: Optional[float] = None,
            vpc_id: Optional[str] = None,
            vpc_name: Optional[str] = None,
            zone_id: Optional[str] = None,
            zone_name: Optional[str] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:hbase:Instance    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoRenew bool
    预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
    ChargeStatus string
    计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
    ChargeType string
    计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
    ColdStorage int
    实例总容量型存储空间大小,单位 GiB。
    CreateTime string
    实例创建时间(UTC 时间)。
    DeletionProtection string
    实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
    EnableAuth bool
    是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
    EnableCloudStorage bool
    是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
    Endpoints List<Byteplus.InstanceEndpoint>
    EngineVersion string
    HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
    InstanceId string
    实例 ID。
    InstanceName string
    实例名称。
    InstanceType string
    实例类型。当前仅支持标准型,取值默认为 Standard。
    MasterCount int
    Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
    MasterSpec string
    Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
    MultiAz bool
    实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
    PrimarySubnetId string
    实时主可用区子网 ID。
    PrimaryZoneId string
    实时主可用区 ID。
    ProjectName string
    实例所属的项目名称。
    PurchaseMonths int
    购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
    RegionId string
    实例所属的地域 ID。
    RsCount int
    RegionServer 节点的数量。
    RsSpec string
    RegionServer 节点的规格码。
    StandbySubnetId string
    实时备可用区子网 ID。
    StandbyZoneId string
    实时备可用区 ID。
    Status string
    实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
    StorageCapacity int
    实例总存储容量,单位:GiB。
    StorageType string
    实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
    SubnetId string
    实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
    Tags List<Byteplus.InstanceTag>
    UsedColdStorage int
    实例已使用的容量型存储空间大小,单位 MiB。
    UsedStorage double
    主实例已使用的存储容量,单位:MiB。
    VpcId string
    私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
    VpcName string
    实例所属的私有网络名称。
    ZoneId string
    实例所属的可用区 ID。
    ZoneName string
    实例所属的可用区名称。
    AutoRenew bool
    预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
    ChargeStatus string
    计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
    ChargeType string
    计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
    ColdStorage int
    实例总容量型存储空间大小,单位 GiB。
    CreateTime string
    实例创建时间(UTC 时间)。
    DeletionProtection string
    实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
    EnableAuth bool
    是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
    EnableCloudStorage bool
    是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
    Endpoints []InstanceEndpointArgs
    EngineVersion string
    HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
    InstanceId string
    实例 ID。
    InstanceName string
    实例名称。
    InstanceType string
    实例类型。当前仅支持标准型,取值默认为 Standard。
    MasterCount int
    Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
    MasterSpec string
    Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
    MultiAz bool
    实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
    PrimarySubnetId string
    实时主可用区子网 ID。
    PrimaryZoneId string
    实时主可用区 ID。
    ProjectName string
    实例所属的项目名称。
    PurchaseMonths int
    购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
    RegionId string
    实例所属的地域 ID。
    RsCount int
    RegionServer 节点的数量。
    RsSpec string
    RegionServer 节点的规格码。
    StandbySubnetId string
    实时备可用区子网 ID。
    StandbyZoneId string
    实时备可用区 ID。
    Status string
    实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
    StorageCapacity int
    实例总存储容量,单位:GiB。
    StorageType string
    实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
    SubnetId string
    实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
    Tags []InstanceTagArgs
    UsedColdStorage int
    实例已使用的容量型存储空间大小,单位 MiB。
    UsedStorage float64
    主实例已使用的存储容量,单位:MiB。
    VpcId string
    私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
    VpcName string
    实例所属的私有网络名称。
    ZoneId string
    实例所属的可用区 ID。
    ZoneName string
    实例所属的可用区名称。
    autoRenew Boolean
    预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
    chargeStatus String
    计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
    chargeType String
    计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
    coldStorage Integer
    实例总容量型存储空间大小,单位 GiB。
    createTime String
    实例创建时间(UTC 时间)。
    deletionProtection String
    实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
    enableAuth Boolean
    是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
    enableCloudStorage Boolean
    是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
    endpoints List<InstanceEndpoint>
    engineVersion String
    HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
    instanceId String
    实例 ID。
    instanceName String
    实例名称。
    instanceType String
    实例类型。当前仅支持标准型,取值默认为 Standard。
    masterCount Integer
    Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
    masterSpec String
    Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
    multiAz Boolean
    实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
    primarySubnetId String
    实时主可用区子网 ID。
    primaryZoneId String
    实时主可用区 ID。
    projectName String
    实例所属的项目名称。
    purchaseMonths Integer
    购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
    regionId String
    实例所属的地域 ID。
    rsCount Integer
    RegionServer 节点的数量。
    rsSpec String
    RegionServer 节点的规格码。
    standbySubnetId String
    实时备可用区子网 ID。
    standbyZoneId String
    实时备可用区 ID。
    status String
    实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
    storageCapacity Integer
    实例总存储容量,单位:GiB。
    storageType String
    实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
    subnetId String
    实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
    tags List<InstanceTag>
    usedColdStorage Integer
    实例已使用的容量型存储空间大小,单位 MiB。
    usedStorage Double
    主实例已使用的存储容量,单位:MiB。
    vpcId String
    私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
    vpcName String
    实例所属的私有网络名称。
    zoneId String
    实例所属的可用区 ID。
    zoneName String
    实例所属的可用区名称。
    autoRenew boolean
    预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
    chargeStatus string
    计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
    chargeType string
    计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
    coldStorage number
    实例总容量型存储空间大小,单位 GiB。
    createTime string
    实例创建时间(UTC 时间)。
    deletionProtection string
    实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
    enableAuth boolean
    是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
    enableCloudStorage boolean
    是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
    endpoints InstanceEndpoint[]
    engineVersion string
    HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
    instanceId string
    实例 ID。
    instanceName string
    实例名称。
    instanceType string
    实例类型。当前仅支持标准型,取值默认为 Standard。
    masterCount number
    Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
    masterSpec string
    Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
    multiAz boolean
    实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
    primarySubnetId string
    实时主可用区子网 ID。
    primaryZoneId string
    实时主可用区 ID。
    projectName string
    实例所属的项目名称。
    purchaseMonths number
    购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
    regionId string
    实例所属的地域 ID。
    rsCount number
    RegionServer 节点的数量。
    rsSpec string
    RegionServer 节点的规格码。
    standbySubnetId string
    实时备可用区子网 ID。
    standbyZoneId string
    实时备可用区 ID。
    status string
    实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
    storageCapacity number
    实例总存储容量,单位:GiB。
    storageType string
    实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
    subnetId string
    实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
    tags InstanceTag[]
    usedColdStorage number
    实例已使用的容量型存储空间大小,单位 MiB。
    usedStorage number
    主实例已使用的存储容量,单位:MiB。
    vpcId string
    私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
    vpcName string
    实例所属的私有网络名称。
    zoneId string
    实例所属的可用区 ID。
    zoneName string
    实例所属的可用区名称。
    auto_renew bool
    预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
    charge_status str
    计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
    charge_type str
    计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
    cold_storage int
    实例总容量型存储空间大小,单位 GiB。
    create_time str
    实例创建时间(UTC 时间)。
    deletion_protection str
    实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
    enable_auth bool
    是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
    enable_cloud_storage bool
    是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
    endpoints Sequence[InstanceEndpointArgs]
    engine_version str
    HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
    instance_id str
    实例 ID。
    instance_name str
    实例名称。
    instance_type str
    实例类型。当前仅支持标准型,取值默认为 Standard。
    master_count int
    Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
    master_spec str
    Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
    multi_az bool
    实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
    primary_subnet_id str
    实时主可用区子网 ID。
    primary_zone_id str
    实时主可用区 ID。
    project_name str
    实例所属的项目名称。
    purchase_months int
    购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
    region_id str
    实例所属的地域 ID。
    rs_count int
    RegionServer 节点的数量。
    rs_spec str
    RegionServer 节点的规格码。
    standby_subnet_id str
    实时备可用区子网 ID。
    standby_zone_id str
    实时备可用区 ID。
    status str
    实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
    storage_capacity int
    实例总存储容量,单位:GiB。
    storage_type str
    实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
    subnet_id str
    实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
    tags Sequence[InstanceTagArgs]
    used_cold_storage int
    实例已使用的容量型存储空间大小,单位 MiB。
    used_storage float
    主实例已使用的存储容量,单位:MiB。
    vpc_id str
    私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
    vpc_name str
    实例所属的私有网络名称。
    zone_id str
    实例所属的可用区 ID。
    zone_name str
    实例所属的可用区名称。
    autoRenew Boolean
    预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
    chargeStatus String
    计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
    chargeType String
    计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
    coldStorage Number
    实例总容量型存储空间大小,单位 GiB。
    createTime String
    实例创建时间(UTC 时间)。
    deletionProtection String
    实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
    enableAuth Boolean
    是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
    enableCloudStorage Boolean
    是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
    endpoints List<Property Map>
    engineVersion String
    HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
    instanceId String
    实例 ID。
    instanceName String
    实例名称。
    instanceType String
    实例类型。当前仅支持标准型,取值默认为 Standard。
    masterCount Number
    Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
    masterSpec String
    Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
    multiAz Boolean
    实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
    primarySubnetId String
    实时主可用区子网 ID。
    primaryZoneId String
    实时主可用区 ID。
    projectName String
    实例所属的项目名称。
    purchaseMonths Number
    购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
    regionId String
    实例所属的地域 ID。
    rsCount Number
    RegionServer 节点的数量。
    rsSpec String
    RegionServer 节点的规格码。
    standbySubnetId String
    实时备可用区子网 ID。
    standbyZoneId String
    实时备可用区 ID。
    status String
    实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
    storageCapacity Number
    实例总存储容量,单位:GiB。
    storageType String
    实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
    subnetId String
    实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
    tags List<Property Map>
    usedColdStorage Number
    实例已使用的容量型存储空间大小,单位 MiB。
    usedStorage Number
    主实例已使用的存储容量,单位:MiB。
    vpcId String
    私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
    vpcName String
    实例所属的私有网络名称。
    zoneId String
    实例所属的可用区 ID。
    zoneName String
    实例所属的可用区名称。

    Supporting Types

    InstanceEndpoint, InstanceEndpointArgs

    AddressType string
    连接地址类型,关于连接地址的更多信息,请参见连接地址类型。取值范围如下:Zk:ZK 地址。Thrift:Thrift2 地址。HBaseReUsedEipId:当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示实例中其他组件(如 RS 节点、Master 节点等)共享绑定使用的 EIP ID 信息。
    EipId string
    当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示 EIP ID。
    EndpointId string
    连接地址 ID。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的 ID。当连接地址类型为 HBaseReUsedEipId 时,连接地址 ID 也固定为 HBaseReUsedEipId。
    EndpointStr string
    连接地址的连接串。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的连接串。当连接地址类型为 HBaseReUsedEipId 时,连接地址的连接串也固定为 HBaseReUsedEipId。
    NetworkType string
    连接地址网络类型。取值范围如下:Public:公网访问地址。Private:私网访问地址。
    PrivateDnsVisibility bool
    私网域名是否开启公网解析。
    AddressType string
    连接地址类型,关于连接地址的更多信息,请参见连接地址类型。取值范围如下:Zk:ZK 地址。Thrift:Thrift2 地址。HBaseReUsedEipId:当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示实例中其他组件(如 RS 节点、Master 节点等)共享绑定使用的 EIP ID 信息。
    EipId string
    当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示 EIP ID。
    EndpointId string
    连接地址 ID。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的 ID。当连接地址类型为 HBaseReUsedEipId 时,连接地址 ID 也固定为 HBaseReUsedEipId。
    EndpointStr string
    连接地址的连接串。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的连接串。当连接地址类型为 HBaseReUsedEipId 时,连接地址的连接串也固定为 HBaseReUsedEipId。
    NetworkType string
    连接地址网络类型。取值范围如下:Public:公网访问地址。Private:私网访问地址。
    PrivateDnsVisibility bool
    私网域名是否开启公网解析。
    addressType String
    连接地址类型,关于连接地址的更多信息,请参见连接地址类型。取值范围如下:Zk:ZK 地址。Thrift:Thrift2 地址。HBaseReUsedEipId:当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示实例中其他组件(如 RS 节点、Master 节点等)共享绑定使用的 EIP ID 信息。
    eipId String
    当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示 EIP ID。
    endpointId String
    连接地址 ID。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的 ID。当连接地址类型为 HBaseReUsedEipId 时,连接地址 ID 也固定为 HBaseReUsedEipId。
    endpointStr String
    连接地址的连接串。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的连接串。当连接地址类型为 HBaseReUsedEipId 时,连接地址的连接串也固定为 HBaseReUsedEipId。
    networkType String
    连接地址网络类型。取值范围如下:Public:公网访问地址。Private:私网访问地址。
    privateDnsVisibility Boolean
    私网域名是否开启公网解析。
    addressType string
    连接地址类型,关于连接地址的更多信息,请参见连接地址类型。取值范围如下:Zk:ZK 地址。Thrift:Thrift2 地址。HBaseReUsedEipId:当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示实例中其他组件(如 RS 节点、Master 节点等)共享绑定使用的 EIP ID 信息。
    eipId string
    当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示 EIP ID。
    endpointId string
    连接地址 ID。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的 ID。当连接地址类型为 HBaseReUsedEipId 时,连接地址 ID 也固定为 HBaseReUsedEipId。
    endpointStr string
    连接地址的连接串。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的连接串。当连接地址类型为 HBaseReUsedEipId 时,连接地址的连接串也固定为 HBaseReUsedEipId。
    networkType string
    连接地址网络类型。取值范围如下:Public:公网访问地址。Private:私网访问地址。
    privateDnsVisibility boolean
    私网域名是否开启公网解析。
    address_type str
    连接地址类型,关于连接地址的更多信息,请参见连接地址类型。取值范围如下:Zk:ZK 地址。Thrift:Thrift2 地址。HBaseReUsedEipId:当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示实例中其他组件(如 RS 节点、Master 节点等)共享绑定使用的 EIP ID 信息。
    eip_id str
    当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示 EIP ID。
    endpoint_id str
    连接地址 ID。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的 ID。当连接地址类型为 HBaseReUsedEipId 时,连接地址 ID 也固定为 HBaseReUsedEipId。
    endpoint_str str
    连接地址的连接串。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的连接串。当连接地址类型为 HBaseReUsedEipId 时,连接地址的连接串也固定为 HBaseReUsedEipId。
    network_type str
    连接地址网络类型。取值范围如下:Public:公网访问地址。Private:私网访问地址。
    private_dns_visibility bool
    私网域名是否开启公网解析。
    addressType String
    连接地址类型,关于连接地址的更多信息,请参见连接地址类型。取值范围如下:Zk:ZK 地址。Thrift:Thrift2 地址。HBaseReUsedEipId:当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示实例中其他组件(如 RS 节点、Master 节点等)共享绑定使用的 EIP ID 信息。
    eipId String
    当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示 EIP ID。
    endpointId String
    连接地址 ID。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的 ID。当连接地址类型为 HBaseReUsedEipId 时,连接地址 ID 也固定为 HBaseReUsedEipId。
    endpointStr String
    连接地址的连接串。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的连接串。当连接地址类型为 HBaseReUsedEipId 时,连接地址的连接串也固定为 HBaseReUsedEipId。
    networkType String
    连接地址网络类型。取值范围如下:Public:公网访问地址。Private:私网访问地址。
    privateDnsVisibility Boolean
    私网域名是否开启公网解析。

    InstanceTag, InstanceTagArgs

    Key string
    实例所绑定标签的标签键。
    Value string
    实例所绑定标签的标签值。
    Key string
    实例所绑定标签的标签键。
    Value string
    实例所绑定标签的标签值。
    key String
    实例所绑定标签的标签键。
    value String
    实例所绑定标签的标签值。
    key string
    实例所绑定标签的标签键。
    value string
    实例所绑定标签的标签值。
    key str
    实例所绑定标签的标签键。
    value str
    实例所绑定标签的标签值。
    key String
    实例所绑定标签的标签键。
    value String
    实例所绑定标签的标签值。

    Import

    $ pulumi import bytepluscc:hbase/instance:Instance example "instance_id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
      Meet Neo: Your AI Platform Teammate