getBaseInstances

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

NOTE: Available in v1.203.0+.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const ids = alicloud.ocean.getBaseInstances({});
export const oceanBaseInstanceId1 = ids.then(ids => ids.instances?.[0]?.id);
const nameRegex = alicloud.ocean.getBaseInstances({
nameRegex: "^my-Instance",
});
export const oceanBaseInstanceId2 = nameRegex.then(nameRegex => nameRegex.instances?.[0]?.id);
import pulumi
import pulumi_alicloud as alicloud
ids = alicloud.ocean.get_base_instances()
pulumi.export("oceanBaseInstanceId1", ids.instances[0].id)
name_regex = alicloud.ocean.get_base_instances(name_regex="^my-Instance")
pulumi.export("oceanBaseInstanceId2", name_regex.instances[0].id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var ids = AliCloud.Ocean.GetBaseInstances.Invoke();
var nameRegex = AliCloud.Ocean.GetBaseInstances.Invoke(new()
{
NameRegex = "^my-Instance",
});
return new Dictionary<string, object?>
{
["oceanBaseInstanceId1"] = ids&#46;Apply(getBaseInstancesResult => getBaseInstancesResult&#46;Instances[0]?.Id),
["oceanBaseInstanceId2"] = nameRegex&#46;Apply(getBaseInstancesResult => getBaseInstancesResult&#46;Instances[0]?.Id),
};
});
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ocean"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
ids, err := ocean.GetBaseInstances(ctx, &ocean.GetBaseInstancesArgs{}, nil)
if err != nil {
return err
}
ctx.Export("oceanBaseInstanceId1", ids.Instances[0].Id)
nameRegex, err := ocean.GetBaseInstances(ctx, &ocean.GetBaseInstancesArgs{
NameRegex: pulumi.StringRef("^my-Instance"),
}, nil)
if err != nil {
return err
}
ctx.Export("oceanBaseInstanceId2", nameRegex.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.ocean.OceanFunctions;
import com.pulumi.alicloud.ocean.inputs.GetBaseInstancesArgs;
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 ids = OceanFunctions.getBaseInstances(GetBaseInstancesArgs.builder()
.build());
ctx.export("oceanBaseInstanceId1", ids.instances()[0].id());
final var nameRegex = OceanFunctions.getBaseInstances(GetBaseInstancesArgs.builder()
.nameRegex("^my-Instance")
.build());
ctx.export("oceanBaseInstanceId2", nameRegex.instances()[0].id());
}
}
variables:
ids:
fn::invoke:
function: alicloud:ocean:getBaseInstances
arguments: {}
nameRegex:
fn::invoke:
function: alicloud:ocean:getBaseInstances
arguments:
nameRegex: ^my-Instance
outputs:
oceanBaseInstanceId1: ${ids.instances[0].id}
oceanBaseInstanceId2: ${nameRegex.instances[0].id}

Return

A collection of values returned by getBaseInstances.

Parameters

argument

A collection of arguments for invoking getBaseInstances.


suspend fun getBaseInstances(enableDetails: Boolean? = null, ids: List<String>? = null, instanceId: String? = null, instanceName: String? = null, nameRegex: String? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null, resourceGroupId: String? = null, searchKey: String? = null, status: String? = null): GetBaseInstancesResult

Return

A collection of values returned by getBaseInstances.

Parameters

enableDetails
ids

A list of Instance IDs.

instanceId

OceanBase cluster ID.

instanceName

OceanBase cluster name. The length is 1 to 20 English or Chinese characters. If this parameter is not specified, the default value is the InstanceId of the cluster.

nameRegex

A regex string to filter results by Instance name.

outputFile

File name where to save data source results (after running pulumi preview).

pageNumber
pageSize
resourceGroupId

The ID of the enterprise resource group to which the instance resides.

searchKey

The filter keyword for the query list.

status

The status of the Instance. Value range: PENDING_CREATE, ONLINE, TENANT_CREATING, TENANT_SPEC_MODIFYING, EXPANDING, REDUCING, SPEC_UPGRADING, DISK_UPGRADING, WHITE_LIST_MODIFYING, PARAMETER_MODIFYING, SSL_MODIFYING, PREPAID_EXPIRE_CLOSED, ARREARS_CLOSED, PENDING_DELETE.

See also


Return

A collection of values returned by getBaseInstances.

Parameters

argument

Builder for com.pulumi.alicloud.ocean.kotlin.inputs.GetBaseInstancesPlainArgs.

See also