Alibaba Cloud

v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

getInstances

This data source provides the Ecp Instances of the current Alibaba Cloud user.

NOTE: Available in v1.158.0+.

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(enable_details: Optional[bool] = None,
                  ids: Optional[Sequence[str]] = None,
                  image_id: Optional[str] = None,
                  instance_name: Optional[str] = None,
                  instance_type: Optional[str] = None,
                  key_pair_name: Optional[str] = None,
                  name_regex: Optional[str] = None,
                  output_file: Optional[str] = None,
                  payment_type: Optional[str] = None,
                  resolution: Optional[str] = None,
                  status: Optional[str] = None,
                  zone_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetInstancesResult
def get_instances_output(enable_details: Optional[pulumi.Input[bool]] = None,
                  ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  image_id: Optional[pulumi.Input[str]] = None,
                  instance_name: Optional[pulumi.Input[str]] = None,
                  instance_type: Optional[pulumi.Input[str]] = None,
                  key_pair_name: Optional[pulumi.Input[str]] = None,
                  name_regex: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  payment_type: Optional[pulumi.Input[str]] = None,
                  resolution: Optional[pulumi.Input[str]] = None,
                  status: Optional[pulumi.Input[str]] = None,
                  zone_id: Optional[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)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: alicloud:ecp/getInstances:getInstances
  arguments:
    # arguments dictionary

The following arguments are supported:

EnableDetails bool
Ids List<string>

A list of Ecp Instances IDs.

ImageId string

The ID Of The Image.

InstanceName string

Instance Name.

InstanceType string

Instance Type.

KeyPairName string

The Key Name.

NameRegex string

A regex string to filter results by mobile phone name.

OutputFile string
PaymentType string

The payment type.Valid values: PayAsYouGo,Subscription

Resolution string

Resolution.

Status string

Instance Status.

ZoneId string
EnableDetails bool
Ids []string

A list of Ecp Instances IDs.

ImageId string

The ID Of The Image.

InstanceName string

Instance Name.

InstanceType string

Instance Type.

KeyPairName string

The Key Name.

NameRegex string

A regex string to filter results by mobile phone name.

OutputFile string
PaymentType string

The payment type.Valid values: PayAsYouGo,Subscription

Resolution string

Resolution.

Status string

Instance Status.

ZoneId string
enableDetails Boolean
ids List<String>

A list of Ecp Instances IDs.

imageId String

The ID Of The Image.

instanceName String

Instance Name.

instanceType String

Instance Type.

keyPairName String

The Key Name.

nameRegex String

A regex string to filter results by mobile phone name.

outputFile String
paymentType String

The payment type.Valid values: PayAsYouGo,Subscription

resolution String

Resolution.

status String

Instance Status.

zoneId String
enableDetails boolean
ids string[]

A list of Ecp Instances IDs.

imageId string

The ID Of The Image.

instanceName string

Instance Name.

instanceType string

Instance Type.

keyPairName string

The Key Name.

nameRegex string

A regex string to filter results by mobile phone name.

outputFile string
paymentType string

The payment type.Valid values: PayAsYouGo,Subscription

resolution string

Resolution.

status string

Instance Status.

zoneId string
enable_details bool
ids Sequence[str]

A list of Ecp Instances IDs.

image_id str

The ID Of The Image.

instance_name str

Instance Name.

instance_type str

Instance Type.

key_pair_name str

The Key Name.

name_regex str

A regex string to filter results by mobile phone name.

output_file str
payment_type str

The payment type.Valid values: PayAsYouGo,Subscription

resolution str

Resolution.

status str

Instance Status.

zone_id str
enableDetails Boolean
ids List<String>

A list of Ecp Instances IDs.

imageId String

The ID Of The Image.

instanceName String

Instance Name.

instanceType String

Instance Type.

keyPairName String

The Key Name.

nameRegex String

A regex string to filter results by mobile phone name.

outputFile String
paymentType String

The payment type.Valid values: PayAsYouGo,Subscription

resolution String

Resolution.

status String

Instance Status.

zoneId String

getInstances Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Ids List<string>
Instances List<Pulumi.AliCloud.Ecp.Outputs.GetInstancesInstance>
Names List<string>
EnableDetails bool
ImageId string
InstanceName string
InstanceType string
KeyPairName string
NameRegex string
OutputFile string
PaymentType string
Resolution string
Status string
ZoneId string
Id string

The provider-assigned unique ID for this managed resource.

Ids []string
Instances []GetInstancesInstance
Names []string
EnableDetails bool
ImageId string
InstanceName string
InstanceType string
KeyPairName string
NameRegex string
OutputFile string
PaymentType string
Resolution string
Status string
ZoneId string
id String

The provider-assigned unique ID for this managed resource.

ids List<String>
instances List<GetInstancesInstance>
names List<String>
enableDetails Boolean
imageId String
instanceName String
instanceType String
keyPairName String
nameRegex String
outputFile String
paymentType String
resolution String
status String
zoneId String
id string

The provider-assigned unique ID for this managed resource.

ids string[]
instances GetInstancesInstance[]
names string[]
enableDetails boolean
imageId string
instanceName string
instanceType string
keyPairName string
nameRegex string
outputFile string
paymentType string
resolution string
status string
zoneId string
id str

The provider-assigned unique ID for this managed resource.

ids Sequence[str]
instances Sequence[GetInstancesInstance]
names Sequence[str]
enable_details bool
image_id str
instance_name str
instance_type str
key_pair_name str
name_regex str
output_file str
payment_type str
resolution str
status str
zone_id str
id String

The provider-assigned unique ID for this managed resource.

ids List<String>
instances List<Property Map>
names List<String>
enableDetails Boolean
imageId String
instanceName String
instanceType String
keyPairName String
nameRegex String
outputFile String
paymentType String
resolution String
status String
zoneId String

Supporting Types

GetInstancesInstance

Description string

Instance Description.

Id string

The ID of the Instance.

ImageId string

The ID Of The Image.

InstanceId string

InstanceId.

InstanceName string

Instance Name.

InstanceType string

Instance Type.

KeyPairName string

The Key Name.

PaymentType string

The payment type.Valid values: PayAsYouGo,Subscription

Resolution string

Resolution.

SecurityGroupId string

Security Group ID.

Status string

Instance Status.

VncUrl string

VNC login address.

VswitchId string

The vswitch id.

ZoneId string
Description string

Instance Description.

Id string

The ID of the Instance.

ImageId string

The ID Of The Image.

InstanceId string

InstanceId.

InstanceName string

Instance Name.

InstanceType string

Instance Type.

KeyPairName string

The Key Name.

PaymentType string

The payment type.Valid values: PayAsYouGo,Subscription

Resolution string

Resolution.

SecurityGroupId string

Security Group ID.

Status string

Instance Status.

VncUrl string

VNC login address.

VswitchId string

The vswitch id.

ZoneId string
description String

Instance Description.

id String

The ID of the Instance.

imageId String

The ID Of The Image.

instanceId String

InstanceId.

instanceName String

Instance Name.

instanceType String

Instance Type.

keyPairName String

The Key Name.

paymentType String

The payment type.Valid values: PayAsYouGo,Subscription

resolution String

Resolution.

securityGroupId String

Security Group ID.

status String

Instance Status.

vncUrl String

VNC login address.

vswitchId String

The vswitch id.

zoneId String
description string

Instance Description.

id string

The ID of the Instance.

imageId string

The ID Of The Image.

instanceId string

InstanceId.

instanceName string

Instance Name.

instanceType string

Instance Type.

keyPairName string

The Key Name.

paymentType string

The payment type.Valid values: PayAsYouGo,Subscription

resolution string

Resolution.

securityGroupId string

Security Group ID.

status string

Instance Status.

vncUrl string

VNC login address.

vswitchId string

The vswitch id.

zoneId string
description str

Instance Description.

id str

The ID of the Instance.

image_id str

The ID Of The Image.

instance_id str

InstanceId.

instance_name str

Instance Name.

instance_type str

Instance Type.

key_pair_name str

The Key Name.

payment_type str

The payment type.Valid values: PayAsYouGo,Subscription

resolution str

Resolution.

security_group_id str

Security Group ID.

status str

Instance Status.

vnc_url str

VNC login address.

vswitch_id str

The vswitch id.

zone_id str
description String

Instance Description.

id String

The ID of the Instance.

imageId String

The ID Of The Image.

instanceId String

InstanceId.

instanceName String

Instance Name.

instanceType String

Instance Type.

keyPairName String

The Key Name.

paymentType String

The payment type.Valid values: PayAsYouGo,Subscription

resolution String

Resolution.

securityGroupId String

Security Group ID.

status String

Instance Status.

vncUrl String

VNC login address.

vswitchId String

The vswitch id.

zoneId String

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.