表格数据库 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:
- Charge
Type string - 计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
- Engine
Version string - HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
- Master
Spec string - Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
- Region
Id string - 实例所属的地域 ID。
- Rs
Count int - RegionServer 节点的数量。
- Rs
Spec string - RegionServer 节点的规格码。
- Storage
Capacity int - 实例总存储容量,单位:GiB。
- Storage
Type string - 实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
- Subnet
Id string - 实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
- Vpc
Id string - 私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
- Zone
Id string - 实例所属的可用区 ID。
- Auto
Renew bool - 预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
- Cold
Storage int - 实例总容量型存储空间大小,单位 GiB。
- Deletion
Protection string - 实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
- Enable
Auth bool - 是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
- Enable
Cloud boolStorage - 是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
- Endpoints
List<Byteplus.
Instance Endpoint> - Instance
Name string - 实例名称。
- Instance
Type string - 实例类型。当前仅支持标准型,取值默认为 Standard。
- Multi
Az bool - 实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
- Project
Name string - 实例所属的项目名称。
- Purchase
Months int - 购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
-
List<Byteplus.
Instance Tag>
- Charge
Type string - 计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
- Engine
Version string - HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
- Master
Spec string - Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
- Region
Id string - 实例所属的地域 ID。
- Rs
Count int - RegionServer 节点的数量。
- Rs
Spec string - RegionServer 节点的规格码。
- Storage
Capacity int - 实例总存储容量,单位:GiB。
- Storage
Type string - 实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
- Subnet
Id string - 实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
- Vpc
Id string - 私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
- Zone
Id string - 实例所属的可用区 ID。
- Auto
Renew bool - 预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
- Cold
Storage int - 实例总容量型存储空间大小,单位 GiB。
- Deletion
Protection string - 实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
- Enable
Auth bool - 是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
- Enable
Cloud boolStorage - 是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
- Endpoints
[]Instance
Endpoint Args - Instance
Name string - 实例名称。
- Instance
Type string - 实例类型。当前仅支持标准型,取值默认为 Standard。
- Multi
Az bool - 实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
- Project
Name string - 实例所属的项目名称。
- Purchase
Months int - 购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
-
[]Instance
Tag Args
- charge
Type String - 计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
- engine
Version String - HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
- master
Spec String - Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
- region
Id String - 实例所属的地域 ID。
- rs
Count Integer - RegionServer 节点的数量。
- rs
Spec String - RegionServer 节点的规格码。
- storage
Capacity Integer - 实例总存储容量,单位:GiB。
- storage
Type String - 实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
- subnet
Id String - 实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
- vpc
Id String - 私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
- zone
Id String - 实例所属的可用区 ID。
- auto
Renew Boolean - 预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
- cold
Storage Integer - 实例总容量型存储空间大小,单位 GiB。
- deletion
Protection String - 实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
- enable
Auth Boolean - 是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
- enable
Cloud BooleanStorage - 是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
- endpoints
List<Instance
Endpoint> - instance
Name String - 实例名称。
- instance
Type String - 实例类型。当前仅支持标准型,取值默认为 Standard。
- multi
Az Boolean - 实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
- project
Name String - 实例所属的项目名称。
- purchase
Months Integer - 购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
-
List<Instance
Tag>
- charge
Type string - 计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
- engine
Version string - HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
- master
Spec string - Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
- region
Id string - 实例所属的地域 ID。
- rs
Count number - RegionServer 节点的数量。
- rs
Spec string - RegionServer 节点的规格码。
- storage
Capacity number - 实例总存储容量,单位:GiB。
- storage
Type string - 实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
- subnet
Id string - 实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
- vpc
Id string - 私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
- zone
Id string - 实例所属的可用区 ID。
- auto
Renew boolean - 预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
- cold
Storage number - 实例总容量型存储空间大小,单位 GiB。
- deletion
Protection string - 实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
- enable
Auth boolean - 是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
- enable
Cloud booleanStorage - 是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
- endpoints
Instance
Endpoint[] - instance
Name string - 实例名称。
- instance
Type string - 实例类型。当前仅支持标准型,取值默认为 Standard。
- multi
Az boolean - 实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
- project
Name string - 实例所属的项目名称。
- purchase
Months number - 购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
-
Instance
Tag[]
- 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_ boolstorage - 是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
- endpoints
Sequence[Instance
Endpoint Args] - 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时,该参数必填。
-
Sequence[Instance
Tag Args]
- charge
Type String - 计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
- engine
Version String - HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
- master
Spec String - Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
- region
Id String - 实例所属的地域 ID。
- rs
Count Number - RegionServer 节点的数量。
- rs
Spec String - RegionServer 节点的规格码。
- storage
Capacity Number - 实例总存储容量,单位:GiB。
- storage
Type String - 实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
- subnet
Id String - 实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
- vpc
Id String - 私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
- zone
Id String - 实例所属的可用区 ID。
- auto
Renew Boolean - 预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
- cold
Storage Number - 实例总容量型存储空间大小,单位 GiB。
- deletion
Protection String - 实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
- enable
Auth Boolean - 是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
- enable
Cloud BooleanStorage - 是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
- endpoints List<Property Map>
- instance
Name String - 实例名称。
- instance
Type String - 实例类型。当前仅支持标准型,取值默认为 Standard。
- multi
Az Boolean - 实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
- project
Name String - 实例所属的项目名称。
- purchase
Months Number - 购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- Charge
Status string - 计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
- Create
Time string - 实例创建时间(UTC 时间)。
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Id string - 实例 ID。
- Master
Count int - Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
- Primary
Subnet stringId - 实时主可用区子网 ID。
- Primary
Zone stringId - 实时主可用区 ID。
- Standby
Subnet stringId - 实时备可用区子网 ID。
- Standby
Zone stringId - 实时备可用区 ID。
- Status string
- 实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
- Used
Cold intStorage - 实例已使用的容量型存储空间大小,单位 MiB。
- Used
Storage double - 主实例已使用的存储容量,单位:MiB。
- Vpc
Name string - 实例所属的私有网络名称。
- Zone
Name string - 实例所属的可用区名称。
- Charge
Status string - 计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
- Create
Time string - 实例创建时间(UTC 时间)。
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Id string - 实例 ID。
- Master
Count int - Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
- Primary
Subnet stringId - 实时主可用区子网 ID。
- Primary
Zone stringId - 实时主可用区 ID。
- Standby
Subnet stringId - 实时备可用区子网 ID。
- Standby
Zone stringId - 实时备可用区 ID。
- Status string
- 实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
- Used
Cold intStorage - 实例已使用的容量型存储空间大小,单位 MiB。
- Used
Storage float64 - 主实例已使用的存储容量,单位:MiB。
- Vpc
Name string - 实例所属的私有网络名称。
- Zone
Name string - 实例所属的可用区名称。
- charge
Status String - 计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
- create
Time String - 实例创建时间(UTC 时间)。
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Id String - 实例 ID。
- master
Count Integer - Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
- primary
Subnet StringId - 实时主可用区子网 ID。
- primary
Zone StringId - 实时主可用区 ID。
- standby
Subnet StringId - 实时备可用区子网 ID。
- standby
Zone StringId - 实时备可用区 ID。
- status String
- 实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
- used
Cold IntegerStorage - 实例已使用的容量型存储空间大小,单位 MiB。
- used
Storage Double - 主实例已使用的存储容量,单位:MiB。
- vpc
Name String - 实例所属的私有网络名称。
- zone
Name String - 实例所属的可用区名称。
- charge
Status string - 计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
- create
Time string - 实例创建时间(UTC 时间)。
- id string
- The provider-assigned unique ID for this managed resource.
- instance
Id string - 实例 ID。
- master
Count number - Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
- primary
Subnet stringId - 实时主可用区子网 ID。
- primary
Zone stringId - 实时主可用区 ID。
- standby
Subnet stringId - 实时备可用区子网 ID。
- standby
Zone stringId - 实时备可用区 ID。
- status string
- 实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
- used
Cold numberStorage - 实例已使用的容量型存储空间大小,单位 MiB。
- used
Storage number - 主实例已使用的存储容量,单位:MiB。
- vpc
Name string - 实例所属的私有网络名称。
- zone
Name 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_ strid - 实时主可用区子网 ID。
- primary_
zone_ strid - 实时主可用区 ID。
- standby_
subnet_ strid - 实时备可用区子网 ID。
- standby_
zone_ strid - 实时备可用区 ID。
- status str
- 实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
- used_
cold_ intstorage - 实例已使用的容量型存储空间大小,单位 MiB。
- used_
storage float - 主实例已使用的存储容量,单位:MiB。
- vpc_
name str - 实例所属的私有网络名称。
- zone_
name str - 实例所属的可用区名称。
- charge
Status String - 计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
- create
Time String - 实例创建时间(UTC 时间)。
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Id String - 实例 ID。
- master
Count Number - Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
- primary
Subnet StringId - 实时主可用区子网 ID。
- primary
Zone StringId - 实时主可用区 ID。
- standby
Subnet StringId - 实时备可用区子网 ID。
- standby
Zone StringId - 实时备可用区 ID。
- status String
- 实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
- used
Cold NumberStorage - 实例已使用的容量型存储空间大小,单位 MiB。
- used
Storage Number - 主实例已使用的存储容量,单位:MiB。
- vpc
Name String - 实例所属的私有网络名称。
- zone
Name 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) -> Instancefunc 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.
- Auto
Renew bool - 预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
- Charge
Status string - 计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
- Charge
Type string - 计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
- Cold
Storage int - 实例总容量型存储空间大小,单位 GiB。
- Create
Time string - 实例创建时间(UTC 时间)。
- Deletion
Protection string - 实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
- Enable
Auth bool - 是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
- Enable
Cloud boolStorage - 是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
- Endpoints
List<Byteplus.
Instance Endpoint> - Engine
Version string - HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
- Instance
Id string - 实例 ID。
- Instance
Name string - 实例名称。
- Instance
Type string - 实例类型。当前仅支持标准型,取值默认为 Standard。
- Master
Count int - Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
- Master
Spec string - Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
- Multi
Az bool - 实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
- Primary
Subnet stringId - 实时主可用区子网 ID。
- Primary
Zone stringId - 实时主可用区 ID。
- Project
Name string - 实例所属的项目名称。
- Purchase
Months int - 购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
- Region
Id string - 实例所属的地域 ID。
- Rs
Count int - RegionServer 节点的数量。
- Rs
Spec string - RegionServer 节点的规格码。
- Standby
Subnet stringId - 实时备可用区子网 ID。
- Standby
Zone stringId - 实时备可用区 ID。
- Status string
- 实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
- Storage
Capacity int - 实例总存储容量,单位:GiB。
- Storage
Type string - 实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
- Subnet
Id string - 实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
-
List<Byteplus.
Instance Tag> - Used
Cold intStorage - 实例已使用的容量型存储空间大小,单位 MiB。
- Used
Storage double - 主实例已使用的存储容量,单位:MiB。
- Vpc
Id string - 私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
- Vpc
Name string - 实例所属的私有网络名称。
- Zone
Id string - 实例所属的可用区 ID。
- Zone
Name string - 实例所属的可用区名称。
- Auto
Renew bool - 预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
- Charge
Status string - 计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
- Charge
Type string - 计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
- Cold
Storage int - 实例总容量型存储空间大小,单位 GiB。
- Create
Time string - 实例创建时间(UTC 时间)。
- Deletion
Protection string - 实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
- Enable
Auth bool - 是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
- Enable
Cloud boolStorage - 是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
- Endpoints
[]Instance
Endpoint Args - Engine
Version string - HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
- Instance
Id string - 实例 ID。
- Instance
Name string - 实例名称。
- Instance
Type string - 实例类型。当前仅支持标准型,取值默认为 Standard。
- Master
Count int - Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
- Master
Spec string - Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
- Multi
Az bool - 实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
- Primary
Subnet stringId - 实时主可用区子网 ID。
- Primary
Zone stringId - 实时主可用区 ID。
- Project
Name string - 实例所属的项目名称。
- Purchase
Months int - 购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
- Region
Id string - 实例所属的地域 ID。
- Rs
Count int - RegionServer 节点的数量。
- Rs
Spec string - RegionServer 节点的规格码。
- Standby
Subnet stringId - 实时备可用区子网 ID。
- Standby
Zone stringId - 实时备可用区 ID。
- Status string
- 实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
- Storage
Capacity int - 实例总存储容量,单位:GiB。
- Storage
Type string - 实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
- Subnet
Id string - 实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
-
[]Instance
Tag Args - Used
Cold intStorage - 实例已使用的容量型存储空间大小,单位 MiB。
- Used
Storage float64 - 主实例已使用的存储容量,单位:MiB。
- Vpc
Id string - 私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
- Vpc
Name string - 实例所属的私有网络名称。
- Zone
Id string - 实例所属的可用区 ID。
- Zone
Name string - 实例所属的可用区名称。
- auto
Renew Boolean - 预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
- charge
Status String - 计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
- charge
Type String - 计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
- cold
Storage Integer - 实例总容量型存储空间大小,单位 GiB。
- create
Time String - 实例创建时间(UTC 时间)。
- deletion
Protection String - 实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
- enable
Auth Boolean - 是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
- enable
Cloud BooleanStorage - 是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
- endpoints
List<Instance
Endpoint> - engine
Version String - HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
- instance
Id String - 实例 ID。
- instance
Name String - 实例名称。
- instance
Type String - 实例类型。当前仅支持标准型,取值默认为 Standard。
- master
Count Integer - Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
- master
Spec String - Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
- multi
Az Boolean - 实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
- primary
Subnet StringId - 实时主可用区子网 ID。
- primary
Zone StringId - 实时主可用区 ID。
- project
Name String - 实例所属的项目名称。
- purchase
Months Integer - 购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
- region
Id String - 实例所属的地域 ID。
- rs
Count Integer - RegionServer 节点的数量。
- rs
Spec String - RegionServer 节点的规格码。
- standby
Subnet StringId - 实时备可用区子网 ID。
- standby
Zone StringId - 实时备可用区 ID。
- status String
- 实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
- storage
Capacity Integer - 实例总存储容量,单位:GiB。
- storage
Type String - 实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
- subnet
Id String - 实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
-
List<Instance
Tag> - used
Cold IntegerStorage - 实例已使用的容量型存储空间大小,单位 MiB。
- used
Storage Double - 主实例已使用的存储容量,单位:MiB。
- vpc
Id String - 私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
- vpc
Name String - 实例所属的私有网络名称。
- zone
Id String - 实例所属的可用区 ID。
- zone
Name String - 实例所属的可用区名称。
- auto
Renew boolean - 预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
- charge
Status string - 计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
- charge
Type string - 计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
- cold
Storage number - 实例总容量型存储空间大小,单位 GiB。
- create
Time string - 实例创建时间(UTC 时间)。
- deletion
Protection string - 实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
- enable
Auth boolean - 是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
- enable
Cloud booleanStorage - 是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
- endpoints
Instance
Endpoint[] - engine
Version string - HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
- instance
Id string - 实例 ID。
- instance
Name string - 实例名称。
- instance
Type string - 实例类型。当前仅支持标准型,取值默认为 Standard。
- master
Count number - Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
- master
Spec string - Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
- multi
Az boolean - 实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
- primary
Subnet stringId - 实时主可用区子网 ID。
- primary
Zone stringId - 实时主可用区 ID。
- project
Name string - 实例所属的项目名称。
- purchase
Months number - 购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
- region
Id string - 实例所属的地域 ID。
- rs
Count number - RegionServer 节点的数量。
- rs
Spec string - RegionServer 节点的规格码。
- standby
Subnet stringId - 实时备可用区子网 ID。
- standby
Zone stringId - 实时备可用区 ID。
- status string
- 实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
- storage
Capacity number - 实例总存储容量,单位:GiB。
- storage
Type string - 实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
- subnet
Id string - 实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
-
Instance
Tag[] - used
Cold numberStorage - 实例已使用的容量型存储空间大小,单位 MiB。
- used
Storage number - 主实例已使用的存储容量,单位:MiB。
- vpc
Id string - 私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
- vpc
Name string - 实例所属的私有网络名称。
- zone
Id string - 实例所属的可用区 ID。
- zone
Name 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_ boolstorage - 是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
- endpoints
Sequence[Instance
Endpoint Args] - 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_ strid - 实时主可用区子网 ID。
- primary_
zone_ strid - 实时主可用区 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_ strid - 实时备可用区子网 ID。
- standby_
zone_ strid - 实时备可用区 ID。
- status str
- 实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
- storage_
capacity int - 实例总存储容量,单位:GiB。
- storage_
type str - 实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
- subnet_
id str - 实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
-
Sequence[Instance
Tag Args] - used_
cold_ intstorage - 实例已使用的容量型存储空间大小,单位 MiB。
- used_
storage float - 主实例已使用的存储容量,单位:MiB。
- vpc_
id str - 私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
- vpc_
name str - 实例所属的私有网络名称。
- zone_
id str - 实例所属的可用区 ID。
- zone_
name str - 实例所属的可用区名称。
- auto
Renew Boolean - 预付费场景下是否自动续费。取值:true:自动续费。false:不自动续费。
- charge
Status String - 计费状态。取值:Normal:正常。Overdue:欠费。Shutdown:关停。
- charge
Type String - 计费类型,取值:PostPaid:按量计费(后付费)。PrePaid:包年包月(预付费)。
- cold
Storage Number - 实例总容量型存储空间大小,单位 GiB。
- create
Time String - 实例创建时间(UTC 时间)。
- deletion
Protection String - 实例删除保护功能开关状态。取值范围:enabled:已开启。disabled:未开启。说明关于实例删除保护的更多信息,请参见实例删除保护。
- enable
Auth Boolean - 是否开启登录认证。取值:true:已开启登录认证。false:未开启登录认证。
- enable
Cloud BooleanStorage - 是否开通存储型容量,取值:true:开通容量型存储。false:不开通容量型存储。说明容量型存储的详细介绍,请参见冷热分离介绍。仅当 MultiAZ(部署方式)取值为 false(单可用区部署)时,支持冷热分离功能。
- endpoints List<Property Map>
- engine
Version String - HBase 数据库引擎版本。当前仅支持 HBase 2.0 版本,取值默认为 HBase_2.0。
- instance
Id String - 实例 ID。
- instance
Name String - 实例名称。
- instance
Type String - 实例类型。当前仅支持标准型,取值默认为 Standard。
- master
Count Number - Master 节点个数。单可用区部署,默认包含 2 个 Master 节点。
- master
Spec String - Master 节点的规格码。说明关于 Master 节点所支持的规格信息,请参见实例规格。Master 节点数量为固定值,不支持增减。
- multi
Az Boolean - 实例的部署方式,取值:true:多可用区部署。false:单可用区部署。目前仅支持单可用区部署。
- primary
Subnet StringId - 实时主可用区子网 ID。
- primary
Zone StringId - 实时主可用区 ID。
- project
Name String - 实例所属的项目名称。
- purchase
Months Number - 购买时长,单位:月。取值范围如下:1,2,3,4,5,6,7,8,9,12,24,36。说明当 ChargeType 为 PrePaid时,该参数必填。
- region
Id String - 实例所属的地域 ID。
- rs
Count Number - RegionServer 节点的数量。
- rs
Spec String - RegionServer 节点的规格码。
- standby
Subnet StringId - 实时备可用区子网 ID。
- standby
Zone StringId - 实时备可用区 ID。
- status String
- 实例当前状态。关于实例状态的更多说明,请参见实例状态说明。
- storage
Capacity Number - 实例总存储容量,单位:GiB。
- storage
Type String - 实例的存储类型,取值:HdfsHdd:HDD 文件存储。HdfsSsd:SSD 文件存储。
- subnet
Id String - 实例所属的子网 ID。单可用区实例,仅包含一个可用区的子网 ID。
- List<Property Map>
- used
Cold NumberStorage - 实例已使用的容量型存储空间大小,单位 MiB。
- used
Storage Number - 主实例已使用的存储容量,单位:MiB。
- vpc
Id String - 私有网络 ID。说明您可以调用 DescribeVpcs 接口查询可创建 HBase 实例的私有网络信息,包括私有网络 ID。
- vpc
Name String - 实例所属的私有网络名称。
- zone
Id String - 实例所属的可用区 ID。
- zone
Name String - 实例所属的可用区名称。
Supporting Types
InstanceEndpoint, InstanceEndpointArgs
- Address
Type string - 连接地址类型,关于连接地址的更多信息,请参见连接地址类型。取值范围如下:Zk:ZK 地址。Thrift:Thrift2 地址。HBaseReUsedEipId:当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示实例中其他组件(如 RS 节点、Master 节点等)共享绑定使用的 EIP ID 信息。
- Eip
Id string - 当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示 EIP ID。
- Endpoint
Id string - 连接地址 ID。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的 ID。当连接地址类型为 HBaseReUsedEipId 时,连接地址 ID 也固定为 HBaseReUsedEipId。
- Endpoint
Str string - 连接地址的连接串。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的连接串。当连接地址类型为 HBaseReUsedEipId 时,连接地址的连接串也固定为 HBaseReUsedEipId。
- Network
Type string - 连接地址网络类型。取值范围如下:Public:公网访问地址。Private:私网访问地址。
- Private
Dns boolVisibility - 私网域名是否开启公网解析。
- Address
Type string - 连接地址类型,关于连接地址的更多信息,请参见连接地址类型。取值范围如下:Zk:ZK 地址。Thrift:Thrift2 地址。HBaseReUsedEipId:当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示实例中其他组件(如 RS 节点、Master 节点等)共享绑定使用的 EIP ID 信息。
- Eip
Id string - 当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示 EIP ID。
- Endpoint
Id string - 连接地址 ID。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的 ID。当连接地址类型为 HBaseReUsedEipId 时,连接地址 ID 也固定为 HBaseReUsedEipId。
- Endpoint
Str string - 连接地址的连接串。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的连接串。当连接地址类型为 HBaseReUsedEipId 时,连接地址的连接串也固定为 HBaseReUsedEipId。
- Network
Type string - 连接地址网络类型。取值范围如下:Public:公网访问地址。Private:私网访问地址。
- Private
Dns boolVisibility - 私网域名是否开启公网解析。
- address
Type String - 连接地址类型,关于连接地址的更多信息,请参见连接地址类型。取值范围如下:Zk:ZK 地址。Thrift:Thrift2 地址。HBaseReUsedEipId:当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示实例中其他组件(如 RS 节点、Master 节点等)共享绑定使用的 EIP ID 信息。
- eip
Id String - 当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示 EIP ID。
- endpoint
Id String - 连接地址 ID。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的 ID。当连接地址类型为 HBaseReUsedEipId 时,连接地址 ID 也固定为 HBaseReUsedEipId。
- endpoint
Str String - 连接地址的连接串。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的连接串。当连接地址类型为 HBaseReUsedEipId 时,连接地址的连接串也固定为 HBaseReUsedEipId。
- network
Type String - 连接地址网络类型。取值范围如下:Public:公网访问地址。Private:私网访问地址。
- private
Dns BooleanVisibility - 私网域名是否开启公网解析。
- address
Type string - 连接地址类型,关于连接地址的更多信息,请参见连接地址类型。取值范围如下:Zk:ZK 地址。Thrift:Thrift2 地址。HBaseReUsedEipId:当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示实例中其他组件(如 RS 节点、Master 节点等)共享绑定使用的 EIP ID 信息。
- eip
Id string - 当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示 EIP ID。
- endpoint
Id string - 连接地址 ID。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的 ID。当连接地址类型为 HBaseReUsedEipId 时,连接地址 ID 也固定为 HBaseReUsedEipId。
- endpoint
Str string - 连接地址的连接串。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的连接串。当连接地址类型为 HBaseReUsedEipId 时,连接地址的连接串也固定为 HBaseReUsedEipId。
- network
Type string - 连接地址网络类型。取值范围如下:Public:公网访问地址。Private:私网访问地址。
- private
Dns booleanVisibility - 私网域名是否开启公网解析。
- 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_ boolvisibility - 私网域名是否开启公网解析。
- address
Type String - 连接地址类型,关于连接地址的更多信息,请参见连接地址类型。取值范围如下:Zk:ZK 地址。Thrift:Thrift2 地址。HBaseReUsedEipId:当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示实例中其他组件(如 RS 节点、Master 节点等)共享绑定使用的 EIP ID 信息。
- eip
Id String - 当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示 EIP ID。
- endpoint
Id String - 连接地址 ID。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的 ID。当连接地址类型为 HBaseReUsedEipId 时,连接地址 ID 也固定为 HBaseReUsedEipId。
- endpoint
Str String - 连接地址的连接串。说明默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的连接串。当连接地址类型为 HBaseReUsedEipId 时,连接地址的连接串也固定为 HBaseReUsedEipId。
- network
Type String - 连接地址网络类型。取值范围如下:Public:公网访问地址。Private:私网访问地址。
- private
Dns BooleanVisibility - 私网域名是否开启公网解析。
InstanceTag, InstanceTagArgs
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
byteplusccTerraform Provider.
