Alibaba Cloud
getInstances
This data source provides the Time Series Database (TSDB) Instances of the current Alibaba Cloud user.
NOTE: Available in v1.112.0+.
Example Usage
using Pulumi;
using AliCloud = Pulumi.AliCloud;
class MyStack : Stack
{
public MyStack()
{
var example = Output.Create(AliCloud.Tsdb.GetInstances.InvokeAsync(new AliCloud.Tsdb.GetInstancesArgs
{
Ids =
{
"example_value",
},
}));
this.FirstTsdbInstanceId = example.Apply(example => example.Instances?[0]?.Id);
}
[Output("firstTsdbInstanceId")]
public Output<string> FirstTsdbInstanceId { get; set; }
}
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/tsdb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := tsdb.GetInstances(ctx, &tsdb.GetInstancesArgs{
Ids: []string{
"example_value",
},
}, nil)
if err != nil {
return err
}
ctx.Export("firstTsdbInstanceId", example.Instances[0].Id)
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.tsdb.TsdbFunctions;
import com.pulumi.alicloud.actiontrail.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 example = TsdbFunctions.getInstances(GetInstancesArgs.builder()
.ids("example_value")
.build());
ctx.export("firstTsdbInstanceId", example.applyValue(getInstancesResult -> getInstancesResult.instances()[0].id()));
}
}
import pulumi
import pulumi_alicloud as alicloud
example = alicloud.tsdb.get_instances(ids=["example_value"])
pulumi.export("firstTsdbInstanceId", example.instances[0].id)
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const example = alicloud.tsdb.getInstances({
ids: ["example_value"],
});
export const firstTsdbInstanceId = example.then(example => example.instances?[0]?.id);
variables:
example:
Fn::Invoke:
Function: alicloud:tsdb:getInstances
Arguments:
ids:
- example_value
outputs:
firstTsdbInstanceId: ${example.instances[0].id}
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(app_key: Optional[str] = None,
enable_details: Optional[bool] = None,
engine_type: Optional[str] = None,
ids: Optional[Sequence[str]] = None,
output_file: Optional[str] = None,
query_str: Optional[str] = None,
status: Optional[str] = None,
status_list: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetInstancesResult
def get_instances_output(app_key: Optional[pulumi.Input[str]] = None,
enable_details: Optional[pulumi.Input[bool]] = None,
engine_type: Optional[pulumi.Input[str]] = None,
ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
output_file: Optional[pulumi.Input[str]] = None,
query_str: Optional[pulumi.Input[str]] = None,
status: Optional[pulumi.Input[str]] = None,
status_list: 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:tsdb/getInstances:getInstances
Arguments:
# Arguments dictionary
The following arguments are supported:
- App
Key string The app key.
- Enable
Details bool Default to
false
. Set it totrue
can output more details about resource attributes.- Engine
Type string The engine type of instance. Enumerative:
tsdb_tsdb
refers to TSDB,tsdb_influxdb
refers to TSDB for InfluxDB️.- Ids List<string>
A list of Instance IDs.
- Output
File string - Query
Str string The query str.
- Status string
Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.
- Status
List string The status list.
- App
Key string The app key.
- Enable
Details bool Default to
false
. Set it totrue
can output more details about resource attributes.- Engine
Type string The engine type of instance. Enumerative:
tsdb_tsdb
refers to TSDB,tsdb_influxdb
refers to TSDB for InfluxDB️.- Ids []string
A list of Instance IDs.
- Output
File string - Query
Str string The query str.
- Status string
Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.
- Status
List string The status list.
- app
Key String The app key.
- enable
Details Boolean Default to
false
. Set it totrue
can output more details about resource attributes.- engine
Type String The engine type of instance. Enumerative:
tsdb_tsdb
refers to TSDB,tsdb_influxdb
refers to TSDB for InfluxDB️.- ids List<String>
A list of Instance IDs.
- output
File String - query
Str String The query str.
- status String
Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.
- status
List String The status list.
- app
Key string The app key.
- enable
Details boolean Default to
false
. Set it totrue
can output more details about resource attributes.- engine
Type string The engine type of instance. Enumerative:
tsdb_tsdb
refers to TSDB,tsdb_influxdb
refers to TSDB for InfluxDB️.- ids string[]
A list of Instance IDs.
- output
File string - query
Str string The query str.
- status string
Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.
- status
List string The status list.
- app_
key str The app key.
- enable_
details bool Default to
false
. Set it totrue
can output more details about resource attributes.- engine_
type str The engine type of instance. Enumerative:
tsdb_tsdb
refers to TSDB,tsdb_influxdb
refers to TSDB for InfluxDB️.- ids Sequence[str]
A list of Instance IDs.
- output_
file str - query_
str str The query str.
- status str
Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.
- status_
list str The status list.
- app
Key String The app key.
- enable
Details Boolean Default to
false
. Set it totrue
can output more details about resource attributes.- engine
Type String The engine type of instance. Enumerative:
tsdb_tsdb
refers to TSDB,tsdb_influxdb
refers to TSDB for InfluxDB️.- ids List<String>
A list of Instance IDs.
- output
File String - query
Str String The query str.
- status String
Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.
- status
List String The status list.
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.
Ali Cloud. Tsdb. Outputs. Get Instances Instance> - App
Key string - Enable
Details bool - Engine
Type string - Output
File string - Query
Str string - Status string
- Status
List string
- Id string
The provider-assigned unique ID for this managed resource.
- Ids []string
- Instances
[]Get
Instances Instance - App
Key string - Enable
Details bool - Engine
Type string - Output
File string - Query
Str string - Status string
- Status
List string
- id String
The provider-assigned unique ID for this managed resource.
- ids List<String>
- instances
List<Get
Instances Instance> - app
Key String - enable
Details Boolean - engine
Type String - output
File String - query
Str String - status String
- status
List String
- id string
The provider-assigned unique ID for this managed resource.
- ids string[]
- instances
Get
Instances Instance[] - app
Key string - enable
Details boolean - engine
Type string - output
File string - query
Str string - status string
- status
List string
- id str
The provider-assigned unique ID for this managed resource.
- ids Sequence[str]
- instances
Sequence[Get
Instances Instance] - app_
key str - enable_
details bool - engine_
type str - output_
file str - query_
str str - status str
- status_
list str
- id String
The provider-assigned unique ID for this managed resource.
- ids List<String>
- instances List<Property Map>
- app
Key String - enable
Details Boolean - engine
Type String - output
File String - query
Str String - status String
- status
List String
Supporting Types
GetInstancesInstance
- Auto
Renew string Auto renew.
- Cpu
Number string The cpu core number of instance.
- Disk
Category string The disk type of instance.
cloud_ssd
refers to SSD disk,cloud_efficiency
refers to efficiency disk,cloud_essd refers to ESSD PL1 disk.- Engine
Type string The engine type of instance. Enumerative:
tsdb_tsdb
refers to TSDB,tsdb_influxdb
refers to TSDB for InfluxDB️.- Expired
Time int Instance expiration time.
- Id string
The ID of the Instance.
- Instance
Alias string The alias of the instance.
- Instance
Class string The specification of the instance.
- Instance
Id string The ID of the instance.
- Instance
Storage string The storage capacity of the instance. Unit: GB. For example, the value 50 indicates 50 GB.
- Memory
Size string The memory size of instance.
- Network
Type string Instance network type.
- Payment
Type string The billing method. Valid values:
PayAsYouGo
andSubscription
. ThePayAsYouGo
value indicates the pay-as-you-go method, and theSubscription
value indicates the subscription method.- Status string
Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.
- Vpc
Connection stringAddress The vpc connection address of instance.
- Vpc
Id string The ID of the virtual private cloud (VPC) that is connected to the instance.
- Vswitch
Id string The vswitch id.
- Zone
Id string The zone ID of the instance.
- Auto
Renew string Auto renew.
- Cpu
Number string The cpu core number of instance.
- Disk
Category string The disk type of instance.
cloud_ssd
refers to SSD disk,cloud_efficiency
refers to efficiency disk,cloud_essd refers to ESSD PL1 disk.- Engine
Type string The engine type of instance. Enumerative:
tsdb_tsdb
refers to TSDB,tsdb_influxdb
refers to TSDB for InfluxDB️.- Expired
Time int Instance expiration time.
- Id string
The ID of the Instance.
- Instance
Alias string The alias of the instance.
- Instance
Class string The specification of the instance.
- Instance
Id string The ID of the instance.
- Instance
Storage string The storage capacity of the instance. Unit: GB. For example, the value 50 indicates 50 GB.
- Memory
Size string The memory size of instance.
- Network
Type string Instance network type.
- Payment
Type string The billing method. Valid values:
PayAsYouGo
andSubscription
. ThePayAsYouGo
value indicates the pay-as-you-go method, and theSubscription
value indicates the subscription method.- Status string
Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.
- Vpc
Connection stringAddress The vpc connection address of instance.
- Vpc
Id string The ID of the virtual private cloud (VPC) that is connected to the instance.
- Vswitch
Id string The vswitch id.
- Zone
Id string The zone ID of the instance.
- auto
Renew String Auto renew.
- cpu
Number String The cpu core number of instance.
- disk
Category String The disk type of instance.
cloud_ssd
refers to SSD disk,cloud_efficiency
refers to efficiency disk,cloud_essd refers to ESSD PL1 disk.- engine
Type String The engine type of instance. Enumerative:
tsdb_tsdb
refers to TSDB,tsdb_influxdb
refers to TSDB for InfluxDB️.- expired
Time Integer Instance expiration time.
- id String
The ID of the Instance.
- instance
Alias String The alias of the instance.
- instance
Class String The specification of the instance.
- instance
Id String The ID of the instance.
- instance
Storage String The storage capacity of the instance. Unit: GB. For example, the value 50 indicates 50 GB.
- memory
Size String The memory size of instance.
- network
Type String Instance network type.
- payment
Type String The billing method. Valid values:
PayAsYouGo
andSubscription
. ThePayAsYouGo
value indicates the pay-as-you-go method, and theSubscription
value indicates the subscription method.- status String
Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.
- vpc
Connection StringAddress The vpc connection address of instance.
- vpc
Id String The ID of the virtual private cloud (VPC) that is connected to the instance.
- vswitch
Id String The vswitch id.
- zone
Id String The zone ID of the instance.
- auto
Renew string Auto renew.
- cpu
Number string The cpu core number of instance.
- disk
Category string The disk type of instance.
cloud_ssd
refers to SSD disk,cloud_efficiency
refers to efficiency disk,cloud_essd refers to ESSD PL1 disk.- engine
Type string The engine type of instance. Enumerative:
tsdb_tsdb
refers to TSDB,tsdb_influxdb
refers to TSDB for InfluxDB️.- expired
Time number Instance expiration time.
- id string
The ID of the Instance.
- instance
Alias string The alias of the instance.
- instance
Class string The specification of the instance.
- instance
Id string The ID of the instance.
- instance
Storage string The storage capacity of the instance. Unit: GB. For example, the value 50 indicates 50 GB.
- memory
Size string The memory size of instance.
- network
Type string Instance network type.
- payment
Type string The billing method. Valid values:
PayAsYouGo
andSubscription
. ThePayAsYouGo
value indicates the pay-as-you-go method, and theSubscription
value indicates the subscription method.- status string
Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.
- vpc
Connection stringAddress The vpc connection address of instance.
- vpc
Id string The ID of the virtual private cloud (VPC) that is connected to the instance.
- vswitch
Id string The vswitch id.
- zone
Id string The zone ID of the instance.
- auto_
renew str Auto renew.
- cpu_
number str The cpu core number of instance.
- disk_
category str The disk type of instance.
cloud_ssd
refers to SSD disk,cloud_efficiency
refers to efficiency disk,cloud_essd refers to ESSD PL1 disk.- engine_
type str The engine type of instance. Enumerative:
tsdb_tsdb
refers to TSDB,tsdb_influxdb
refers to TSDB for InfluxDB️.- expired_
time int Instance expiration time.
- id str
The ID of the Instance.
- instance_
alias str The alias of the instance.
- instance_
class str The specification of the instance.
- instance_
id str The ID of the instance.
- instance_
storage str The storage capacity of the instance. Unit: GB. For example, the value 50 indicates 50 GB.
- memory_
size str The memory size of instance.
- network_
type str Instance network type.
- payment_
type str The billing method. Valid values:
PayAsYouGo
andSubscription
. ThePayAsYouGo
value indicates the pay-as-you-go method, and theSubscription
value indicates the subscription method.- status str
Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.
- vpc_
connection_ straddress The vpc connection address of instance.
- vpc_
id str The ID of the virtual private cloud (VPC) that is connected to the instance.
- vswitch_
id str The vswitch id.
- zone_
id str The zone ID of the instance.
- auto
Renew String Auto renew.
- cpu
Number String The cpu core number of instance.
- disk
Category String The disk type of instance.
cloud_ssd
refers to SSD disk,cloud_efficiency
refers to efficiency disk,cloud_essd refers to ESSD PL1 disk.- engine
Type String The engine type of instance. Enumerative:
tsdb_tsdb
refers to TSDB,tsdb_influxdb
refers to TSDB for InfluxDB️.- expired
Time Number Instance expiration time.
- id String
The ID of the Instance.
- instance
Alias String The alias of the instance.
- instance
Class String The specification of the instance.
- instance
Id String The ID of the instance.
- instance
Storage String The storage capacity of the instance. Unit: GB. For example, the value 50 indicates 50 GB.
- memory
Size String The memory size of instance.
- network
Type String Instance network type.
- payment
Type String The billing method. Valid values:
PayAsYouGo
andSubscription
. ThePayAsYouGo
value indicates the pay-as-you-go method, and theSubscription
value indicates the subscription method.- status String
Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.
- vpc
Connection StringAddress The vpc connection address of instance.
- vpc
Id String The ID of the virtual private cloud (VPC) that is connected to the instance.
- vswitch
Id String The vswitch id.
- zone
Id String The zone ID of the instance.
Package Details
- Repository
- https://github.com/pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloud
Terraform Provider.