GetEnterpriseInstances

This data source provides a list of DMS Enterprise Instances in an Alibaba Cloud account according to the specified filters.

NOTE: Available in 1.88.0+

Using GetEnterpriseInstances

function getEnterpriseInstances(args: GetEnterpriseInstancesArgs, opts?: InvokeOptions): Promise<GetEnterpriseInstancesResult>

function  get_enterprise_instances(env_type=None, instance_alias_regex=None, instance_source=None, instance_type=None, net_type=None, output_file=None, search_key=None, status=None, tid=None, opts=None)

func GetEnterpriseInstances(ctx *Context, args *GetEnterpriseInstancesArgs, opts ...InvokeOption) (*GetEnterpriseInstancesResult, error)

public static class GetEnterpriseInstances {
    public static Task<GetEnterpriseInstancesResult> InvokeAsync(GetEnterpriseInstancesArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

EnvType string: The type of the environment to which the database instance belongs.
InstanceAliasRegex string: A regex string to filter the results by the DMS Enterprise Instance instance_alias.
InstanceSource string: The source of the database instance.
InstanceType string: The ID of the database instance.
NetType string: The network type of the database instance. Valid values: CLASSIC and VPC. For more information about the valid values, see the description of the RegisterInstance operation.
OutputFile string
SearchKey string: The keyword used to query database instances.
Status string: Filter the results by status of the DMS Enterprise Instances. Valid values: NORMAL, UNAVAILABLE, UNKNOWN, DELETED, DISABLE.
Tid int: The ID of the tenant in Data Management (DMS) Enterprise.

EnvType string: The type of the environment to which the database instance belongs.
InstanceAliasRegex string: A regex string to filter the results by the DMS Enterprise Instance instance_alias.
InstanceSource string: The source of the database instance.
InstanceType string: The ID of the database instance.
NetType string: The network type of the database instance. Valid values: CLASSIC and VPC. For more information about the valid values, see the description of the RegisterInstance operation.
OutputFile string
SearchKey string: The keyword used to query database instances.
Status string: Filter the results by status of the DMS Enterprise Instances. Valid values: NORMAL, UNAVAILABLE, UNKNOWN, DELETED, DISABLE.
Tid int: The ID of the tenant in Data Management (DMS) Enterprise.

envType string: The type of the environment to which the database instance belongs.
instanceAliasRegex string: A regex string to filter the results by the DMS Enterprise Instance instance_alias.
instanceSource string: The source of the database instance.
instanceType string: The ID of the database instance.
netType string: The network type of the database instance. Valid values: CLASSIC and VPC. For more information about the valid values, see the description of the RegisterInstance operation.
outputFile string
searchKey string: The keyword used to query database instances.
status string: Filter the results by status of the DMS Enterprise Instances. Valid values: NORMAL, UNAVAILABLE, UNKNOWN, DELETED, DISABLE.
tid number: The ID of the tenant in Data Management (DMS) Enterprise.

env_type str: The type of the environment to which the database instance belongs.
instance_alias_regex str: A regex string to filter the results by the DMS Enterprise Instance instance_alias.
instance_source str: The source of the database instance.
instance_type str: The ID of the database instance.
net_type str: The network type of the database instance. Valid values: CLASSIC and VPC. For more information about the valid values, see the description of the RegisterInstance operation.
output_file str
search_key str: The keyword used to query database instances.
status str: Filter the results by status of the DMS Enterprise Instances. Valid values: NORMAL, UNAVAILABLE, UNKNOWN, DELETED, DISABLE.
tid float: The ID of the tenant in Data Management (DMS) Enterprise.

GetEnterpriseInstances Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Instances List<Pulumi.AliCloud.Dms.Outputs.GetEnterpriseInstancesInstance>: A list of KMS keys. Each element contains the following attributes:
EnvType string: The type of the environment to which the database instance belongs..
InstanceAliasRegex string
InstanceSource string: The ID of the database instance.
InstanceType string: The ID of the database instance.
NetType string
OutputFile string
SearchKey string
Status string: The status of the database instance.
Tid int

Id string: The provider-assigned unique ID for this managed resource.
Instances []GetEnterpriseInstancesInstance: A list of KMS keys. Each element contains the following attributes:
EnvType string: The type of the environment to which the database instance belongs..
InstanceAliasRegex string
InstanceSource string: The ID of the database instance.
InstanceType string: The ID of the database instance.
NetType string
OutputFile string
SearchKey string
Status string: The status of the database instance.
Tid int

id string: The provider-assigned unique ID for this managed resource.
instances GetEnterpriseInstancesInstance[]: A list of KMS keys. Each element contains the following attributes:
envType string: The type of the environment to which the database instance belongs..
instanceAliasRegex string
instanceSource string: The ID of the database instance.
instanceType string: The ID of the database instance.
netType string
outputFile string
searchKey string
status string: The status of the database instance.
tid number

id str: The provider-assigned unique ID for this managed resource.
instances List[GetEnterpriseInstancesInstance]: A list of KMS keys. Each element contains the following attributes:
env_type str: The type of the environment to which the database instance belongs..
instance_alias_regex str
instance_source str: The ID of the database instance.
instance_type str: The ID of the database instance.
net_type str
output_file str
search_key str
status str: The status of the database instance.
tid float

Supporting Types

GetEnterpriseInstancesInstance

See the output API doc for this type.

DataLinkName string: The name of the data link for the database instance.
DatabasePassword string: The logon password of the database instance.
DatabaseUser string: The logon username of the database instance.
DbaId string: The ID of the database administrator (DBA) of the database instance.
DbaNickName string: The nickname of the DBA.
DdlOnline int: Indicates whether the online data description language (DDL) service was enabled for the database instance.
EcsInstanceId string: The ID of the Elastic Compute Service (ECS) instance to which the database instance belongs.
EcsRegion string: The region where the database instance resides.
EnvType string: The type of the environment to which the database instance belongs.
ExportTimeout int: The timeout period for exporting the database instance.
Host string: The endpoint of the database instance.
InstanceAlias string: The alias of the database instance.
InstanceId string: The ID of the database instance.
InstanceSource string: The source of the database instance.
InstanceType string: The ID of the database instance.
Port int: The connection port of the database instance.
QueryTimeout int: The timeout period for querying the database instance.
SafeRuleId string: The ID of the security rule for the database instance.
Sid string: The system ID (SID) of the database instance.
Status string: Filter the results by status of the DMS Enterprise Instances. Valid values: NORMAL, UNAVAILABLE, UNKNOWN, DELETED, DISABLE.
UseDsql int: Indicates whether cross-database query was enabled for the database instance.
VpcId string: The ID of the Virtual Private Cloud (VPC) to which the database instance belongs.

DataLinkName string: The name of the data link for the database instance.
DatabasePassword string: The logon password of the database instance.
DatabaseUser string: The logon username of the database instance.
DbaId string: The ID of the database administrator (DBA) of the database instance.
DbaNickName string: The nickname of the DBA.
DdlOnline int: Indicates whether the online data description language (DDL) service was enabled for the database instance.
EcsInstanceId string: The ID of the Elastic Compute Service (ECS) instance to which the database instance belongs.
EcsRegion string: The region where the database instance resides.
EnvType string: The type of the environment to which the database instance belongs.
ExportTimeout int: The timeout period for exporting the database instance.
Host string: The endpoint of the database instance.
InstanceAlias string: The alias of the database instance.
InstanceId string: The ID of the database instance.
InstanceSource string: The source of the database instance.
InstanceType string: The ID of the database instance.
Port int: The connection port of the database instance.
QueryTimeout int: The timeout period for querying the database instance.
SafeRuleId string: The ID of the security rule for the database instance.
Sid string: The system ID (SID) of the database instance.
Status string: Filter the results by status of the DMS Enterprise Instances. Valid values: NORMAL, UNAVAILABLE, UNKNOWN, DELETED, DISABLE.
UseDsql int: Indicates whether cross-database query was enabled for the database instance.
VpcId string: The ID of the Virtual Private Cloud (VPC) to which the database instance belongs.

dataLinkName string: The name of the data link for the database instance.
databasePassword string: The logon password of the database instance.
databaseUser string: The logon username of the database instance.
dbaId string: The ID of the database administrator (DBA) of the database instance.
dbaNickName string: The nickname of the DBA.
ddlOnline number: Indicates whether the online data description language (DDL) service was enabled for the database instance.
ecsInstanceId string: The ID of the Elastic Compute Service (ECS) instance to which the database instance belongs.
ecsRegion string: The region where the database instance resides.
envType string: The type of the environment to which the database instance belongs.
exportTimeout number: The timeout period for exporting the database instance.
host string: The endpoint of the database instance.
instanceAlias string: The alias of the database instance.
instanceId string: The ID of the database instance.
instanceSource string: The source of the database instance.
instanceType string: The ID of the database instance.
port number: The connection port of the database instance.
queryTimeout number: The timeout period for querying the database instance.
safeRuleId string: The ID of the security rule for the database instance.
sid string: The system ID (SID) of the database instance.
status string: Filter the results by status of the DMS Enterprise Instances. Valid values: NORMAL, UNAVAILABLE, UNKNOWN, DELETED, DISABLE.
useDsql number: Indicates whether cross-database query was enabled for the database instance.
vpcId string: The ID of the Virtual Private Cloud (VPC) to which the database instance belongs.

data_link_name str: The name of the data link for the database instance.
database_password str: The logon password of the database instance.
database_user str: The logon username of the database instance.
dba_id str: The ID of the database administrator (DBA) of the database instance.
dba_nick_name str: The nickname of the DBA.
ddl_online float: Indicates whether the online data description language (DDL) service was enabled for the database instance.
ecs_instance_id str: The ID of the Elastic Compute Service (ECS) instance to which the database instance belongs.
ecs_region str: The region where the database instance resides.
env_type str: The type of the environment to which the database instance belongs.
export_timeout float: The timeout period for exporting the database instance.
host str: The endpoint of the database instance.
instance_alias str: The alias of the database instance.
instance_id str: The ID of the database instance.
instance_source str: The source of the database instance.
instance_type str: The ID of the database instance.
port float: The connection port of the database instance.
query_timeout float: The timeout period for querying the database instance.
safe_rule_id str: The ID of the security rule for the database instance.
sid str: The system ID (SID) of the database instance.
status str: Filter the results by status of the DMS Enterprise Instances. Valid values: NORMAL, UNAVAILABLE, UNKNOWN, DELETED, DISABLE.
use_dsql float: Indicates whether cross-database query was enabled for the database instance.
vpc_id str: The ID of the Virtual Private Cloud (VPC) to which the database instance belongs.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud