Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
alicloud.hbase.getInstances
Explore with Pulumi AI
The alicloud.hbase.getInstances data source provides a collection of HBase instances available in Alicloud account.
Filters support regular expression for the instance name, ids or availability_zone.
NOTE: Available in 1.67.0+
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const hbase = alicloud.hbase.getInstances({
    nameRegex: "tf_testAccHBase",
    availabilityZone: "cn-shenzhen-b",
});
import pulumi
import pulumi_alicloud as alicloud
hbase = alicloud.hbase.get_instances(name_regex="tf_testAccHBase",
    availability_zone="cn-shenzhen-b")
package main
import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbase"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hbase.GetInstances(ctx, &hbase.GetInstancesArgs{
			NameRegex:        pulumi.StringRef("tf_testAccHBase"),
			AvailabilityZone: pulumi.StringRef("cn-shenzhen-b"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() => 
{
    var hbase = AliCloud.Hbase.GetInstances.Invoke(new()
    {
        NameRegex = "tf_testAccHBase",
        AvailabilityZone = "cn-shenzhen-b",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.hbase.HbaseFunctions;
import com.pulumi.alicloud.hbase.inputs.GetInstancesArgs;
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) {
        final var hbase = HbaseFunctions.getInstances(GetInstancesArgs.builder()
            .nameRegex("tf_testAccHBase")
            .availabilityZone("cn-shenzhen-b")
            .build());
    }
}
variables:
  hbase:
    fn::invoke:
      function: alicloud:hbase:getInstances
      arguments:
        nameRegex: tf_testAccHBase
        availabilityZone: cn-shenzhen-b
Using getInstances
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
function getInstancesOutput(args: GetInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancesResult>def get_instances(availability_zone: Optional[str] = None,
                  ids: Optional[Sequence[str]] = None,
                  name_regex: Optional[str] = None,
                  output_file: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetInstancesResult
def get_instances_output(availability_zone: Optional[pulumi.Input[str]] = None,
                  ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  name_regex: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput> Note: This function is named GetInstances in the Go SDK.
public static class GetInstances 
{
    public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetInstancesResult> Invoke(GetInstancesInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
public static Output<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
fn::invoke:
  function: alicloud:hbase/getInstances:getInstances
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Availability
Zone string - Instance availability zone.
 - Ids List<string>
 - The ids list of HBase instances
 - Name
Regex string - A regex string to apply to the instance name.
 - Output
File string - The name of file that can save the collection of instances after running 
pulumi preview. - Dictionary<string, string>
 - A mapping of tags to assign to the resource.
 
- Availability
Zone string - Instance availability zone.
 - Ids []string
 - The ids list of HBase instances
 - Name
Regex string - A regex string to apply to the instance name.
 - Output
File string - The name of file that can save the collection of instances after running 
pulumi preview. - map[string]string
 - A mapping of tags to assign to the resource.
 
- availability
Zone String - Instance availability zone.
 - ids List<String>
 - The ids list of HBase instances
 - name
Regex String - A regex string to apply to the instance name.
 - output
File String - The name of file that can save the collection of instances after running 
pulumi preview. - Map<String,String>
 - A mapping of tags to assign to the resource.
 
- availability
Zone string - Instance availability zone.
 - ids string[]
 - The ids list of HBase instances
 - name
Regex string - A regex string to apply to the instance name.
 - output
File string - The name of file that can save the collection of instances after running 
pulumi preview. - {[key: string]: string}
 - A mapping of tags to assign to the resource.
 
- availability_
zone str - Instance availability zone.
 - ids Sequence[str]
 - The ids list of HBase instances
 - name_
regex str - A regex string to apply to the instance name.
 - output_
file str - The name of file that can save the collection of instances after running 
pulumi preview. - Mapping[str, str]
 - A mapping of tags to assign to the resource.
 
- availability
Zone String - Instance availability zone.
 - ids List<String>
 - The ids list of HBase instances
 - name
Regex String - A regex string to apply to the instance name.
 - output
File String - The name of file that can save the collection of instances after running 
pulumi preview. - Map<String>
 - A mapping of tags to assign to the resource.
 
getInstances Result
The following output properties are available:
- Id string
 - The provider-assigned unique ID for this managed resource.
 - Ids List<string>
 - The ids list of HBase instances
 - Instances
List<Pulumi.
Ali Cloud. Hbase. Outputs. Get Instances Instance>  - A list of HBase instances. Its every element contains the following attributes:
 - Names List<string>
 - The names list of HBase instances
 - Availability
Zone string - Name
Regex string - Output
File string - Dictionary<string, string>
 - A mapping of tags to assign to the resource.
 
- Id string
 - The provider-assigned unique ID for this managed resource.
 - Ids []string
 - The ids list of HBase instances
 - Instances
[]Get
Instances Instance  - A list of HBase instances. Its every element contains the following attributes:
 - Names []string
 - The names list of HBase instances
 - Availability
Zone string - Name
Regex string - Output
File string - map[string]string
 - A mapping of tags to assign to the resource.
 
- id String
 - The provider-assigned unique ID for this managed resource.
 - ids List<String>
 - The ids list of HBase instances
 - instances
List<Get
Instances Instance>  - A list of HBase instances. Its every element contains the following attributes:
 - names List<String>
 - The names list of HBase instances
 - availability
Zone String - name
Regex String - output
File String - Map<String,String>
 - A mapping of tags to assign to the resource.
 
- id string
 - The provider-assigned unique ID for this managed resource.
 - ids string[]
 - The ids list of HBase instances
 - instances
Get
Instances Instance[]  - A list of HBase instances. Its every element contains the following attributes:
 - names string[]
 - The names list of HBase instances
 - availability
Zone string - name
Regex string - output
File string - {[key: string]: string}
 - A mapping of tags to assign to the resource.
 
- id str
 - The provider-assigned unique ID for this managed resource.
 - ids Sequence[str]
 - The ids list of HBase instances
 - instances
Sequence[Get
Instances Instance]  - A list of HBase instances. Its every element contains the following attributes:
 - names Sequence[str]
 - The names list of HBase instances
 - availability_
zone str - name_
regex str - output_
file str - Mapping[str, str]
 - A mapping of tags to assign to the resource.
 
- id String
 - The provider-assigned unique ID for this managed resource.
 - ids List<String>
 - The ids list of HBase instances
 - instances List<Property Map>
 - A list of HBase instances. Its every element contains the following attributes:
 - names List<String>
 - The names list of HBase instances
 - availability
Zone String - name
Regex String - output
File String - Map<String>
 - A mapping of tags to assign to the resource.
 
Supporting Types
GetInstancesInstance  
- Backup
Status string - The Backup Status of the instance.
 - Core
Disk intSize  - Core node disk size, unit:GB.
 - Core
Disk stringType  - Cloud_ssd or cloud_efficiency
 - Core
Instance stringType  - Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
 - Core
Node intCount  - Same with "core_instance_quantity"
 - Created
Time string - The created time of the instance.
 - Deletion
Protection bool - The switch of delete protection.
 - Engine string
 - The engine of the instance.
 - Engine
Version string - The engine_version of the instance.
 - Expire
Time string - The expire time of the instance.
 - Id string
 - The ID of the HBase instance.
 - Master
Instance stringType  - Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
 - Master
Node intCount  - The node count of master
 - Name string
 - The name of the HBase instance.
 - Network
Type string - Classic network or VPC.
 - Pay
Type string - Billing method. Value options are 
PostPaidfor Pay-As-You-Go andPrePaidfor yearly or monthly subscription. - Region
Id string - Region ID the instance belongs to.
 - Status string
 - Status of the instance.
 - Vpc
Id string - VPC ID the instance belongs to.
 - Vswitch
Id string - VSwitch ID the instance belongs to.
 - Zone
Id string - Zone ID the instance belongs to.
 - Dictionary<string, string>
 - A mapping of tags to assign to the resource.
 
- Backup
Status string - The Backup Status of the instance.
 - Core
Disk intSize  - Core node disk size, unit:GB.
 - Core
Disk stringType  - Cloud_ssd or cloud_efficiency
 - Core
Instance stringType  - Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
 - Core
Node intCount  - Same with "core_instance_quantity"
 - Created
Time string - The created time of the instance.
 - Deletion
Protection bool - The switch of delete protection.
 - Engine string
 - The engine of the instance.
 - Engine
Version string - The engine_version of the instance.
 - Expire
Time string - The expire time of the instance.
 - Id string
 - The ID of the HBase instance.
 - Master
Instance stringType  - Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
 - Master
Node intCount  - The node count of master
 - Name string
 - The name of the HBase instance.
 - Network
Type string - Classic network or VPC.
 - Pay
Type string - Billing method. Value options are 
PostPaidfor Pay-As-You-Go andPrePaidfor yearly or monthly subscription. - Region
Id string - Region ID the instance belongs to.
 - Status string
 - Status of the instance.
 - Vpc
Id string - VPC ID the instance belongs to.
 - Vswitch
Id string - VSwitch ID the instance belongs to.
 - Zone
Id string - Zone ID the instance belongs to.
 - map[string]string
 - A mapping of tags to assign to the resource.
 
- backup
Status String - The Backup Status of the instance.
 - core
Disk IntegerSize  - Core node disk size, unit:GB.
 - core
Disk StringType  - Cloud_ssd or cloud_efficiency
 - core
Instance StringType  - Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
 - core
Node IntegerCount  - Same with "core_instance_quantity"
 - created
Time String - The created time of the instance.
 - deletion
Protection Boolean - The switch of delete protection.
 - engine String
 - The engine of the instance.
 - engine
Version String - The engine_version of the instance.
 - expire
Time String - The expire time of the instance.
 - id String
 - The ID of the HBase instance.
 - master
Instance StringType  - Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
 - master
Node IntegerCount  - The node count of master
 - name String
 - The name of the HBase instance.
 - network
Type String - Classic network or VPC.
 - pay
Type String - Billing method. Value options are 
PostPaidfor Pay-As-You-Go andPrePaidfor yearly or monthly subscription. - region
Id String - Region ID the instance belongs to.
 - status String
 - Status of the instance.
 - vpc
Id String - VPC ID the instance belongs to.
 - vswitch
Id String - VSwitch ID the instance belongs to.
 - zone
Id String - Zone ID the instance belongs to.
 - Map<String,String>
 - A mapping of tags to assign to the resource.
 
- backup
Status string - The Backup Status of the instance.
 - core
Disk numberSize  - Core node disk size, unit:GB.
 - core
Disk stringType  - Cloud_ssd or cloud_efficiency
 - core
Instance stringType  - Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
 - core
Node numberCount  - Same with "core_instance_quantity"
 - created
Time string - The created time of the instance.
 - deletion
Protection boolean - The switch of delete protection.
 - engine string
 - The engine of the instance.
 - engine
Version string - The engine_version of the instance.
 - expire
Time string - The expire time of the instance.
 - id string
 - The ID of the HBase instance.
 - master
Instance stringType  - Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
 - master
Node numberCount  - The node count of master
 - name string
 - The name of the HBase instance.
 - network
Type string - Classic network or VPC.
 - pay
Type string - Billing method. Value options are 
PostPaidfor Pay-As-You-Go andPrePaidfor yearly or monthly subscription. - region
Id string - Region ID the instance belongs to.
 - status string
 - Status of the instance.
 - vpc
Id string - VPC ID the instance belongs to.
 - vswitch
Id string - VSwitch ID the instance belongs to.
 - zone
Id string - Zone ID the instance belongs to.
 - {[key: string]: string}
 - A mapping of tags to assign to the resource.
 
- backup_
status str - The Backup Status of the instance.
 - core_
disk_ intsize  - Core node disk size, unit:GB.
 - core_
disk_ strtype  - Cloud_ssd or cloud_efficiency
 - core_
instance_ strtype  - Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
 - core_
node_ intcount  - Same with "core_instance_quantity"
 - created_
time str - The created time of the instance.
 - deletion_
protection bool - The switch of delete protection.
 - engine str
 - The engine of the instance.
 - engine_
version str - The engine_version of the instance.
 - expire_
time str - The expire time of the instance.
 - id str
 - The ID of the HBase instance.
 - master_
instance_ strtype  - Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
 - master_
node_ intcount  - The node count of master
 - name str
 - The name of the HBase instance.
 - network_
type str - Classic network or VPC.
 - pay_
type str - Billing method. Value options are 
PostPaidfor Pay-As-You-Go andPrePaidfor yearly or monthly subscription. - region_
id str - Region ID the instance belongs to.
 - status str
 - Status of the instance.
 - vpc_
id str - VPC ID the instance belongs to.
 - vswitch_
id str - VSwitch ID the instance belongs to.
 - zone_
id str - Zone ID the instance belongs to.
 - Mapping[str, str]
 - A mapping of tags to assign to the resource.
 
- backup
Status String - The Backup Status of the instance.
 - core
Disk NumberSize  - Core node disk size, unit:GB.
 - core
Disk StringType  - Cloud_ssd or cloud_efficiency
 - core
Instance StringType  - Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
 - core
Node NumberCount  - Same with "core_instance_quantity"
 - created
Time String - The created time of the instance.
 - deletion
Protection Boolean - The switch of delete protection.
 - engine String
 - The engine of the instance.
 - engine
Version String - The engine_version of the instance.
 - expire
Time String - The expire time of the instance.
 - id String
 - The ID of the HBase instance.
 - master
Instance StringType  - Like hbase.sn2.2xlarge, hbase.sn2.4xlarge, hbase.sn2.8xlarge and so on.
 - master
Node NumberCount  - The node count of master
 - name String
 - The name of the HBase instance.
 - network
Type String - Classic network or VPC.
 - pay
Type String - Billing method. Value options are 
PostPaidfor Pay-As-You-Go andPrePaidfor yearly or monthly subscription. - region
Id String - Region ID the instance belongs to.
 - status String
 - Status of the instance.
 - vpc
Id String - VPC ID the instance belongs to.
 - vswitch
Id String - VSwitch ID the instance belongs to.
 - zone
Id String - Zone ID the instance belongs to.
 - Map<String>
 - A mapping of tags to assign to the resource.
 
Package Details
- Repository
 - Alibaba Cloud pulumi/pulumi-alicloud
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
alicloudTerraform Provider.