Alibaba Cloud v3.78.0, May 16 25

Alibaba Cloud v3.78.0 published on Friday, May 16, 2025 by Pulumi

alicloud.ocean.BaseInstance

Explore with Pulumi AI

Alibaba Cloud v3.78.0 published on Friday, May 16, 2025 by Pulumi

pulumi/pulumi-alicloud

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = alicloud.getZones({});
const defaultGetResourceGroups = alicloud.resourcemanager.getResourceGroups({});
const defaultBaseInstance = new alicloud.ocean.BaseInstance("default", {
    resourceGroupId: defaultGetResourceGroups.then(defaultGetResourceGroups => defaultGetResourceGroups.ids?.[0]),
    zones: [
        pulumi.all([_default, _default.then(_default => _default.ids).length]).apply(([_default, length]) => _default.ids[length - 2]),
        pulumi.all([_default, _default.then(_default => _default.ids).length]).apply(([_default, length]) => _default.ids[length - 3]),
        pulumi.all([_default, _default.then(_default => _default.ids).length]).apply(([_default, length]) => _default.ids[length - 4]),
    ],
    autoRenew: false,
    diskSize: 100,
    paymentType: "PayAsYouGo",
    instanceClass: "8C32G",
    backupRetainMode: "delete_all",
    series: "normal",
    instanceName: name,
});

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = alicloud.get_zones()
default_get_resource_groups = alicloud.resourcemanager.get_resource_groups()
default_base_instance = alicloud.ocean.BaseInstance("default",
    resource_group_id=default_get_resource_groups.ids[0],
    zones=[
        len(default.ids).apply(lambda length: default.ids[length - 2]),
        len(default.ids).apply(lambda length: default.ids[length - 3]),
        len(default.ids).apply(lambda length: default.ids[length - 4]),
    ],
    auto_renew=False,
    disk_size=100,
    payment_type="PayAsYouGo",
    instance_class="8C32G",
    backup_retain_mode="delete_all",
    series="normal",
    instance_name=name)

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ocean"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{}, nil)
		if err != nil {
			return err
		}
		defaultGetResourceGroups, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = ocean.NewBaseInstance(ctx, "default", &ocean.BaseInstanceArgs{
			ResourceGroupId: pulumi.String(defaultGetResourceGroups.Ids[0]),
			Zones: pulumi.StringArray{
				len(_default.Ids).ApplyT(func(length int) (string, error) {
					return _default.Ids[length-2], nil
				}).(pulumi.StringOutput),
				len(_default.Ids).ApplyT(func(length int) (string, error) {
					return _default.Ids[length-3], nil
				}).(pulumi.StringOutput),
				len(_default.Ids).ApplyT(func(length int) (string, error) {
					return _default.Ids[length-4], nil
				}).(pulumi.StringOutput),
			},
			AutoRenew:        pulumi.Bool(false),
			DiskSize:         pulumi.Int(100),
			PaymentType:      pulumi.String("PayAsYouGo"),
			InstanceClass:    pulumi.String("8C32G"),
			BackupRetainMode: pulumi.String("delete_all"),
			Series:           pulumi.String("normal"),
			InstanceName:     pulumi.String(name),
		})
		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 config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var @default = AliCloud.GetZones.Invoke();

    var defaultGetResourceGroups = AliCloud.ResourceManager.GetResourceGroups.Invoke();

    var defaultBaseInstance = new AliCloud.Ocean.BaseInstance("default", new()
    {
        ResourceGroupId = defaultGetResourceGroups.Apply(getResourceGroupsResult => getResourceGroupsResult.Ids[0]),
        Zones = new[]
        {
            Output.Tuple(@default, @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Ids)).Length).Apply(values =>
            {
                var @default = values.Item1;
                var length = values.Item2;
                return @default.Apply(getZonesResult => getZonesResult.Ids)[length - 2];
            }),
            Output.Tuple(@default, @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Ids)).Length).Apply(values =>
            {
                var @default = values.Item1;
                var length = values.Item2;
                return @default.Apply(getZonesResult => getZonesResult.Ids)[length - 3];
            }),
            Output.Tuple(@default, @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Ids)).Length).Apply(values =>
            {
                var @default = values.Item1;
                var length = values.Item2;
                return @default.Apply(getZonesResult => getZonesResult.Ids)[length - 4];
            }),
        },
        AutoRenew = false,
        DiskSize = 100,
        PaymentType = "PayAsYouGo",
        InstanceClass = "8C32G",
        BackupRetainMode = "delete_all",
        Series = "normal",
        InstanceName = name,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.alicloud.ocean.BaseInstance;
import com.pulumi.alicloud.ocean.BaseInstanceArgs;
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 config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        final var default = AlicloudFunctions.getZones(GetZonesArgs.builder()
            .build());

        final var defaultGetResourceGroups = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
            .build());

        var defaultBaseInstance = new BaseInstance("defaultBaseInstance", BaseInstanceArgs.builder()
            .resourceGroupId(defaultGetResourceGroups.ids()[0])
            .zones(            
                default_.ids().length().applyValue(_length -> default_.ids()[_length - 2]),
                default_.ids().length().applyValue(_length -> default_.ids()[_length - 3]),
                default_.ids().length().applyValue(_length -> default_.ids()[_length - 4]))
            .autoRenew(false)
            .diskSize(100)
            .paymentType("PayAsYouGo")
            .instanceClass("8C32G")
            .backupRetainMode("delete_all")
            .series("normal")
            .instanceName(name)
            .build());

    }
}

Coming soon!

Create BaseInstance Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BaseInstance(name: string, args: BaseInstanceArgs, opts?: CustomResourceOptions);

@overload
def BaseInstance(resource_name: str,
                 args: BaseInstanceArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def BaseInstance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 instance_class: Optional[str] = None,
                 zones: Optional[Sequence[str]] = None,
                 series: Optional[str] = None,
                 payment_type: Optional[str] = None,
                 disk_size: Optional[int] = None,
                 node_num: Optional[str] = None,
                 period_unit: Optional[str] = None,
                 instance_name: Optional[str] = None,
                 auto_renew: Optional[bool] = None,
                 ob_version: Optional[str] = None,
                 cpu_arch: Optional[str] = None,
                 period: Optional[int] = None,
                 disk_type: Optional[str] = None,
                 primary_instance: Optional[str] = None,
                 primary_region: Optional[str] = None,
                 resource_group_id: Optional[str] = None,
                 backup_retain_mode: Optional[str] = None,
                 upgrade_spec_native: Optional[bool] = None,
                 auto_renew_period: Optional[int] = None)

func NewBaseInstance(ctx *Context, name string, args BaseInstanceArgs, opts ...ResourceOption) (*BaseInstance, error)

public BaseInstance(string name, BaseInstanceArgs args, CustomResourceOptions? opts = null)

public BaseInstance(String name, BaseInstanceArgs args)
public BaseInstance(String name, BaseInstanceArgs args, CustomResourceOptions options)

type: alicloud:ocean:BaseInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args BaseInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args BaseInstanceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args BaseInstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BaseInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BaseInstanceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var baseInstanceResource = new AliCloud.Ocean.BaseInstance("baseInstanceResource", new()
{
    InstanceClass = "string",
    Zones = new[]
    {
        "string",
    },
    Series = "string",
    PaymentType = "string",
    DiskSize = 0,
    NodeNum = "string",
    PeriodUnit = "string",
    InstanceName = "string",
    AutoRenew = false,
    ObVersion = "string",
    CpuArch = "string",
    Period = 0,
    DiskType = "string",
    PrimaryInstance = "string",
    PrimaryRegion = "string",
    ResourceGroupId = "string",
    BackupRetainMode = "string",
    UpgradeSpecNative = false,
    AutoRenewPeriod = 0,
});

example, err := ocean.NewBaseInstance(ctx, "baseInstanceResource", &ocean.BaseInstanceArgs{
	InstanceClass: pulumi.String("string"),
	Zones: pulumi.StringArray{
		pulumi.String("string"),
	},
	Series:            pulumi.String("string"),
	PaymentType:       pulumi.String("string"),
	DiskSize:          pulumi.Int(0),
	NodeNum:           pulumi.String("string"),
	PeriodUnit:        pulumi.String("string"),
	InstanceName:      pulumi.String("string"),
	AutoRenew:         pulumi.Bool(false),
	ObVersion:         pulumi.String("string"),
	CpuArch:           pulumi.String("string"),
	Period:            pulumi.Int(0),
	DiskType:          pulumi.String("string"),
	PrimaryInstance:   pulumi.String("string"),
	PrimaryRegion:     pulumi.String("string"),
	ResourceGroupId:   pulumi.String("string"),
	BackupRetainMode:  pulumi.String("string"),
	UpgradeSpecNative: pulumi.Bool(false),
	AutoRenewPeriod:   pulumi.Int(0),
})

var baseInstanceResource = new BaseInstance("baseInstanceResource", BaseInstanceArgs.builder()
    .instanceClass("string")
    .zones("string")
    .series("string")
    .paymentType("string")
    .diskSize(0)
    .nodeNum("string")
    .periodUnit("string")
    .instanceName("string")
    .autoRenew(false)
    .obVersion("string")
    .cpuArch("string")
    .period(0)
    .diskType("string")
    .primaryInstance("string")
    .primaryRegion("string")
    .resourceGroupId("string")
    .backupRetainMode("string")
    .upgradeSpecNative(false)
    .autoRenewPeriod(0)
    .build());

base_instance_resource = alicloud.ocean.BaseInstance("baseInstanceResource",
    instance_class="string",
    zones=["string"],
    series="string",
    payment_type="string",
    disk_size=0,
    node_num="string",
    period_unit="string",
    instance_name="string",
    auto_renew=False,
    ob_version="string",
    cpu_arch="string",
    period=0,
    disk_type="string",
    primary_instance="string",
    primary_region="string",
    resource_group_id="string",
    backup_retain_mode="string",
    upgrade_spec_native=False,
    auto_renew_period=0)

const baseInstanceResource = new alicloud.ocean.BaseInstance("baseInstanceResource", {
    instanceClass: "string",
    zones: ["string"],
    series: "string",
    paymentType: "string",
    diskSize: 0,
    nodeNum: "string",
    periodUnit: "string",
    instanceName: "string",
    autoRenew: false,
    obVersion: "string",
    cpuArch: "string",
    period: 0,
    diskType: "string",
    primaryInstance: "string",
    primaryRegion: "string",
    resourceGroupId: "string",
    backupRetainMode: "string",
    upgradeSpecNative: false,
    autoRenewPeriod: 0,
});

type: alicloud:ocean:BaseInstance
properties:
    autoRenew: false
    autoRenewPeriod: 0
    backupRetainMode: string
    cpuArch: string
    diskSize: 0
    diskType: string
    instanceClass: string
    instanceName: string
    nodeNum: string
    obVersion: string
    paymentType: string
    period: 0
    periodUnit: string
    primaryInstance: string
    primaryRegion: string
    resourceGroupId: string
    series: string
    upgradeSpecNative: false
    zones:
        - string

BaseInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BaseInstance resource accepts the following input properties:

DiskSize int

The size of the storage space, in GB.

The limits of storage space vary according to the cluster specifications, as follows:

8C32GB:100GB ~ 10000GB
14C70GB:200GB ~ 10000GB
30C180GB:400GB ~ 10000GB
62C400G:800GB ~ 10000GB.

The default value of each package is its minimum value.

InstanceClass string

Cluster specification information. Note Please enter the shape as xCxxG, not xCxxGB

The x86 cluster architecture currently supports the following packages:

4C16G:4 core 16GB
8C32G:8 core 32GB
14C70G:14 core 70GB
24C120G:24 core 120GB
30C180G:30 core 180GB
62C400G:62 core 400GB
104C600G:104 core 600GB
16C70G:16 core 70GB
32C160G:32 core 160GB
64C380G:64 core 380GB
20C32G:20 core 32GB
40C64G:40 core 64GB
16C32G:16 core 32GB
32C70G:32 core 70GB
64C180G:64 core 180GB
32C180G:32 core 180GB
64C400G:64 core 400GB,

The cluster architecture of arm currently supports the following packages:

8C32G:8 core 32GB
16C70G:16 core 70GB
32C180G:32 core 180GB

PaymentType string

The payment method of the instance. Value range:

Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
PayAsYouGo (default): Pay-as-you-go (default hourly billing).

Series string

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

Zones List<string>

Information about the zone where the cluster is deployed.

AutoRenew bool

Whether to automatically renew.

It takes effect when the parameter ChargeType is PrePaid. Value range:

true: automatic renewal.
false (default): no automatic renewal.

AutoRenewPeriod int

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.

PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

BackupRetainMode string

The backup retention policy after the cluster is deleted. The values are as follows:

receive_all: Keep all backup sets;
delete_all: delete all backup sets;
receive_last: Keep the last backup set.

CpuArch string

Cpu architecture, x86, arm. If no, the default value is x86

DiskType string

The storage type of the cluster. Effective only in the standard cluster version (cloud disk).

Two types are currently supported:

cloud_essd_pl1: cloud disk ESSD pl1.
cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

InstanceName string

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.

NodeNum string

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3

ObVersion string

The OceanBase Server version number.

Period int

The duration of the resource purchase. The unit is specified by the PeriodUnit. The parameter InstanceChargeType takes effect only when the value is PrePaid and is required. Once the DedicatedHostId is specified, the value cannot exceed the subscription duration of the dedicated host. When PeriodUnit = Week, Period values: {"1", "2", "3", "4"}. When PeriodUnit = Month, Period values: {"1", "2", "3", "4", "5", "6", "7", "8", "9", "12", "24", "36", "48", "60"}.

PeriodUnit string

The duration of the purchase of resources.

Package year and Month value range: Month.

Default value: Month of the package, which is billed by volume. The default period is Hour.

PrimaryInstance string

The ID of the primary instance.

PrimaryRegion string

The primary instance Region.

ResourceGroupId string

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

UpgradeSpecNative bool

Valid values:

false: migration and configuration change.
true: in-situ matching

DiskSize int

The size of the storage space, in GB.

The limits of storage space vary according to the cluster specifications, as follows:

8C32GB:100GB ~ 10000GB
14C70GB:200GB ~ 10000GB
30C180GB:400GB ~ 10000GB
62C400G:800GB ~ 10000GB.

The default value of each package is its minimum value.

InstanceClass string

Cluster specification information. Note Please enter the shape as xCxxG, not xCxxGB

The x86 cluster architecture currently supports the following packages:

4C16G:4 core 16GB
8C32G:8 core 32GB
14C70G:14 core 70GB
24C120G:24 core 120GB
30C180G:30 core 180GB
62C400G:62 core 400GB
104C600G:104 core 600GB
16C70G:16 core 70GB
32C160G:32 core 160GB
64C380G:64 core 380GB
20C32G:20 core 32GB
40C64G:40 core 64GB
16C32G:16 core 32GB
32C70G:32 core 70GB
64C180G:64 core 180GB
32C180G:32 core 180GB
64C400G:64 core 400GB,

The cluster architecture of arm currently supports the following packages:

8C32G:8 core 32GB
16C70G:16 core 70GB
32C180G:32 core 180GB

PaymentType string

The payment method of the instance. Value range:

Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
PayAsYouGo (default): Pay-as-you-go (default hourly billing).

Series string

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

Zones []string

Information about the zone where the cluster is deployed.

AutoRenew bool

Whether to automatically renew.

It takes effect when the parameter ChargeType is PrePaid. Value range:

true: automatic renewal.
false (default): no automatic renewal.

AutoRenewPeriod int

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.

PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

BackupRetainMode string

The backup retention policy after the cluster is deleted. The values are as follows:

receive_all: Keep all backup sets;
delete_all: delete all backup sets;
receive_last: Keep the last backup set.

CpuArch string

Cpu architecture, x86, arm. If no, the default value is x86

DiskType string

The storage type of the cluster. Effective only in the standard cluster version (cloud disk).

Two types are currently supported:

cloud_essd_pl1: cloud disk ESSD pl1.
cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

InstanceName string

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.

NodeNum string

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3

ObVersion string

The OceanBase Server version number.

Period int

PeriodUnit string

The duration of the purchase of resources.

Package year and Month value range: Month.

Default value: Month of the package, which is billed by volume. The default period is Hour.

PrimaryInstance string

The ID of the primary instance.

PrimaryRegion string

The primary instance Region.

ResourceGroupId string

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

UpgradeSpecNative bool

Valid values:

false: migration and configuration change.
true: in-situ matching

diskSize Integer

The size of the storage space, in GB.

The limits of storage space vary according to the cluster specifications, as follows:

8C32GB:100GB ~ 10000GB
14C70GB:200GB ~ 10000GB
30C180GB:400GB ~ 10000GB
62C400G:800GB ~ 10000GB.

The default value of each package is its minimum value.

instanceClass String

Cluster specification information. Note Please enter the shape as xCxxG, not xCxxGB

The x86 cluster architecture currently supports the following packages:

4C16G:4 core 16GB
8C32G:8 core 32GB
14C70G:14 core 70GB
24C120G:24 core 120GB
30C180G:30 core 180GB
62C400G:62 core 400GB
104C600G:104 core 600GB
16C70G:16 core 70GB
32C160G:32 core 160GB
64C380G:64 core 380GB
20C32G:20 core 32GB
40C64G:40 core 64GB
16C32G:16 core 32GB
32C70G:32 core 70GB
64C180G:64 core 180GB
32C180G:32 core 180GB
64C400G:64 core 400GB,

The cluster architecture of arm currently supports the following packages:

8C32G:8 core 32GB
16C70G:16 core 70GB
32C180G:32 core 180GB

paymentType String

The payment method of the instance. Value range:

Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
PayAsYouGo (default): Pay-as-you-go (default hourly billing).

series String

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

zones List<String>

Information about the zone where the cluster is deployed.

autoRenew Boolean

Whether to automatically renew.

It takes effect when the parameter ChargeType is PrePaid. Value range:

true: automatic renewal.
false (default): no automatic renewal.

autoRenewPeriod Integer

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.

PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

backupRetainMode String

The backup retention policy after the cluster is deleted. The values are as follows:

receive_all: Keep all backup sets;
delete_all: delete all backup sets;
receive_last: Keep the last backup set.

cpuArch String

Cpu architecture, x86, arm. If no, the default value is x86

diskType String

The storage type of the cluster. Effective only in the standard cluster version (cloud disk).

Two types are currently supported:

cloud_essd_pl1: cloud disk ESSD pl1.
cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

instanceName String

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.

nodeNum String

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3

obVersion String

The OceanBase Server version number.

period Integer

periodUnit String

The duration of the purchase of resources.

Package year and Month value range: Month.

Default value: Month of the package, which is billed by volume. The default period is Hour.

primaryInstance String

The ID of the primary instance.

primaryRegion String

The primary instance Region.

resourceGroupId String

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

upgradeSpecNative Boolean

Valid values:

false: migration and configuration change.
true: in-situ matching

diskSize number

The size of the storage space, in GB.

The limits of storage space vary according to the cluster specifications, as follows:

8C32GB:100GB ~ 10000GB
14C70GB:200GB ~ 10000GB
30C180GB:400GB ~ 10000GB
62C400G:800GB ~ 10000GB.

The default value of each package is its minimum value.

instanceClass string

Cluster specification information. Note Please enter the shape as xCxxG, not xCxxGB

The x86 cluster architecture currently supports the following packages:

4C16G:4 core 16GB
8C32G:8 core 32GB
14C70G:14 core 70GB
24C120G:24 core 120GB
30C180G:30 core 180GB
62C400G:62 core 400GB
104C600G:104 core 600GB
16C70G:16 core 70GB
32C160G:32 core 160GB
64C380G:64 core 380GB
20C32G:20 core 32GB
40C64G:40 core 64GB
16C32G:16 core 32GB
32C70G:32 core 70GB
64C180G:64 core 180GB
32C180G:32 core 180GB
64C400G:64 core 400GB,

The cluster architecture of arm currently supports the following packages:

8C32G:8 core 32GB
16C70G:16 core 70GB
32C180G:32 core 180GB

paymentType string

The payment method of the instance. Value range:

Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
PayAsYouGo (default): Pay-as-you-go (default hourly billing).

series string

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

zones string[]

Information about the zone where the cluster is deployed.

autoRenew boolean

Whether to automatically renew.

It takes effect when the parameter ChargeType is PrePaid. Value range:

true: automatic renewal.
false (default): no automatic renewal.

autoRenewPeriod number

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.

PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

backupRetainMode string

The backup retention policy after the cluster is deleted. The values are as follows:

receive_all: Keep all backup sets;
delete_all: delete all backup sets;
receive_last: Keep the last backup set.

cpuArch string

Cpu architecture, x86, arm. If no, the default value is x86

diskType string

The storage type of the cluster. Effective only in the standard cluster version (cloud disk).

Two types are currently supported:

cloud_essd_pl1: cloud disk ESSD pl1.
cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

instanceName string

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.

nodeNum string

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3

obVersion string

The OceanBase Server version number.

period number

periodUnit string

The duration of the purchase of resources.

Package year and Month value range: Month.

Default value: Month of the package, which is billed by volume. The default period is Hour.

primaryInstance string

The ID of the primary instance.

primaryRegion string

The primary instance Region.

resourceGroupId string

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

upgradeSpecNative boolean

Valid values:

false: migration and configuration change.
true: in-situ matching

disk_size int

The size of the storage space, in GB.

The limits of storage space vary according to the cluster specifications, as follows:

8C32GB:100GB ~ 10000GB
14C70GB:200GB ~ 10000GB
30C180GB:400GB ~ 10000GB
62C400G:800GB ~ 10000GB.

The default value of each package is its minimum value.

instance_class str

Cluster specification information. Note Please enter the shape as xCxxG, not xCxxGB

The x86 cluster architecture currently supports the following packages:

4C16G:4 core 16GB
8C32G:8 core 32GB
14C70G:14 core 70GB
24C120G:24 core 120GB
30C180G:30 core 180GB
62C400G:62 core 400GB
104C600G:104 core 600GB
16C70G:16 core 70GB
32C160G:32 core 160GB
64C380G:64 core 380GB
20C32G:20 core 32GB
40C64G:40 core 64GB
16C32G:16 core 32GB
32C70G:32 core 70GB
64C180G:64 core 180GB
32C180G:32 core 180GB
64C400G:64 core 400GB,

The cluster architecture of arm currently supports the following packages:

8C32G:8 core 32GB
16C70G:16 core 70GB
32C180G:32 core 180GB

payment_type str

The payment method of the instance. Value range:

Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
PayAsYouGo (default): Pay-as-you-go (default hourly billing).

series str

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

zones Sequence[str]

Information about the zone where the cluster is deployed.

auto_renew bool

Whether to automatically renew.

It takes effect when the parameter ChargeType is PrePaid. Value range:

true: automatic renewal.
false (default): no automatic renewal.

auto_renew_period int

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.

PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

backup_retain_mode str

The backup retention policy after the cluster is deleted. The values are as follows:

receive_all: Keep all backup sets;
delete_all: delete all backup sets;
receive_last: Keep the last backup set.

cpu_arch str

Cpu architecture, x86, arm. If no, the default value is x86

disk_type str

The storage type of the cluster. Effective only in the standard cluster version (cloud disk).

Two types are currently supported:

cloud_essd_pl1: cloud disk ESSD pl1.
cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

instance_name str

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.

node_num str

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3

ob_version str

The OceanBase Server version number.

period int

period_unit str

The duration of the purchase of resources.

Package year and Month value range: Month.

Default value: Month of the package, which is billed by volume. The default period is Hour.

primary_instance str

The ID of the primary instance.

primary_region str

The primary instance Region.

resource_group_id str

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

upgrade_spec_native bool

Valid values:

false: migration and configuration change.
true: in-situ matching

diskSize Number

The size of the storage space, in GB.

The limits of storage space vary according to the cluster specifications, as follows:

8C32GB:100GB ~ 10000GB
14C70GB:200GB ~ 10000GB
30C180GB:400GB ~ 10000GB
62C400G:800GB ~ 10000GB.

The default value of each package is its minimum value.

instanceClass String

Cluster specification information. Note Please enter the shape as xCxxG, not xCxxGB

The x86 cluster architecture currently supports the following packages:

4C16G:4 core 16GB
8C32G:8 core 32GB
14C70G:14 core 70GB
24C120G:24 core 120GB
30C180G:30 core 180GB
62C400G:62 core 400GB
104C600G:104 core 600GB
16C70G:16 core 70GB
32C160G:32 core 160GB
64C380G:64 core 380GB
20C32G:20 core 32GB
40C64G:40 core 64GB
16C32G:16 core 32GB
32C70G:32 core 70GB
64C180G:64 core 180GB
32C180G:32 core 180GB
64C400G:64 core 400GB,

The cluster architecture of arm currently supports the following packages:

8C32G:8 core 32GB
16C70G:16 core 70GB
32C180G:32 core 180GB

paymentType String

The payment method of the instance. Value range:

Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
PayAsYouGo (default): Pay-as-you-go (default hourly billing).

series String

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

zones List<String>

Information about the zone where the cluster is deployed.

autoRenew Boolean

Whether to automatically renew.

It takes effect when the parameter ChargeType is PrePaid. Value range:

true: automatic renewal.
false (default): no automatic renewal.

autoRenewPeriod Number

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.

PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

backupRetainMode String

The backup retention policy after the cluster is deleted. The values are as follows:

receive_all: Keep all backup sets;
delete_all: delete all backup sets;
receive_last: Keep the last backup set.

cpuArch String

Cpu architecture, x86, arm. If no, the default value is x86

diskType String

The storage type of the cluster. Effective only in the standard cluster version (cloud disk).

Two types are currently supported:

cloud_essd_pl1: cloud disk ESSD pl1.
cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

instanceName String

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.

nodeNum String

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3

obVersion String

The OceanBase Server version number.

period Number

periodUnit String

The duration of the purchase of resources.

Package year and Month value range: Month.

Default value: Month of the package, which is billed by volume. The default period is Hour.

primaryInstance String

The ID of the primary instance.

primaryRegion String

The primary instance Region.

resourceGroupId String

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

upgradeSpecNative Boolean

Valid values:

false: migration and configuration change.
true: in-situ matching

Outputs

All input properties are implicitly available as output properties. Additionally, the BaseInstance resource produces the following output properties:

CommodityCode string: The product code of the OceanBase cluster._oceanbasepre_public_cn: Domestic station cloud database package Year-to-month package._oceanbasepost_public_cn: The domestic station cloud database is paid by the hour._obpre_public_intl: International Station Cloud Database Package Monthly Package.
Cpu int: The number of CPU cores of the cluster.
CreateTime string: The creation time of the resource
Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of the resource

CommodityCode string: The product code of the OceanBase cluster._oceanbasepre_public_cn: Domestic station cloud database package Year-to-month package._oceanbasepost_public_cn: The domestic station cloud database is paid by the hour._obpre_public_intl: International Station Cloud Database Package Monthly Package.
Cpu int: The number of CPU cores of the cluster.
CreateTime string: The creation time of the resource
Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of the resource

commodityCode String: The product code of the OceanBase cluster._oceanbasepre_public_cn: Domestic station cloud database package Year-to-month package._oceanbasepost_public_cn: The domestic station cloud database is paid by the hour._obpre_public_intl: International Station Cloud Database Package Monthly Package.
cpu Integer: The number of CPU cores of the cluster.
createTime String: The creation time of the resource
id String: The provider-assigned unique ID for this managed resource.
status String: The status of the resource

commodityCode string: The product code of the OceanBase cluster._oceanbasepre_public_cn: Domestic station cloud database package Year-to-month package._oceanbasepost_public_cn: The domestic station cloud database is paid by the hour._obpre_public_intl: International Station Cloud Database Package Monthly Package.
cpu number: The number of CPU cores of the cluster.
createTime string: The creation time of the resource
id string: The provider-assigned unique ID for this managed resource.
status string: The status of the resource

commodity_code str: The product code of the OceanBase cluster._oceanbasepre_public_cn: Domestic station cloud database package Year-to-month package._oceanbasepost_public_cn: The domestic station cloud database is paid by the hour._obpre_public_intl: International Station Cloud Database Package Monthly Package.
cpu int: The number of CPU cores of the cluster.
create_time str: The creation time of the resource
id str: The provider-assigned unique ID for this managed resource.
status str: The status of the resource

commodityCode String: The product code of the OceanBase cluster._oceanbasepre_public_cn: Domestic station cloud database package Year-to-month package._oceanbasepost_public_cn: The domestic station cloud database is paid by the hour._obpre_public_intl: International Station Cloud Database Package Monthly Package.
cpu Number: The number of CPU cores of the cluster.
createTime String: The creation time of the resource
id String: The provider-assigned unique ID for this managed resource.
status String: The status of the resource

Look up Existing BaseInstance Resource

Get an existing BaseInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BaseInstanceState, opts?: CustomResourceOptions): BaseInstance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_renew: Optional[bool] = None,
        auto_renew_period: Optional[int] = None,
        backup_retain_mode: Optional[str] = None,
        commodity_code: Optional[str] = None,
        cpu: Optional[int] = None,
        cpu_arch: Optional[str] = None,
        create_time: Optional[str] = None,
        disk_size: Optional[int] = None,
        disk_type: Optional[str] = None,
        instance_class: Optional[str] = None,
        instance_name: Optional[str] = None,
        node_num: Optional[str] = None,
        ob_version: Optional[str] = None,
        payment_type: Optional[str] = None,
        period: Optional[int] = None,
        period_unit: Optional[str] = None,
        primary_instance: Optional[str] = None,
        primary_region: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        series: Optional[str] = None,
        status: Optional[str] = None,
        upgrade_spec_native: Optional[bool] = None,
        zones: Optional[Sequence[str]] = None) -> BaseInstance

func GetBaseInstance(ctx *Context, name string, id IDInput, state *BaseInstanceState, opts ...ResourceOption) (*BaseInstance, error)

public static BaseInstance Get(string name, Input<string> id, BaseInstanceState? state, CustomResourceOptions? opts = null)

public static BaseInstance get(String name, Output<String> id, BaseInstanceState state, CustomResourceOptions options)

resources:  _:    type: alicloud:ocean:BaseInstance    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoRenew bool

Whether to automatically renew.

It takes effect when the parameter ChargeType is PrePaid. Value range:

true: automatic renewal.
false (default): no automatic renewal.

AutoRenewPeriod int

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.

PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

BackupRetainMode string

The backup retention policy after the cluster is deleted. The values are as follows:

receive_all: Keep all backup sets;
delete_all: delete all backup sets;
receive_last: Keep the last backup set.

CommodityCode string

The product code of the OceanBase cluster._oceanbasepre_public_cn: Domestic station cloud database package Year-to-month package._oceanbasepost_public_cn: The domestic station cloud database is paid by the hour._obpre_public_intl: International Station Cloud Database Package Monthly Package.

Cpu int

The number of CPU cores of the cluster.

CpuArch string

Cpu architecture, x86, arm. If no, the default value is x86

CreateTime string

The creation time of the resource

DiskSize int

The size of the storage space, in GB.

The limits of storage space vary according to the cluster specifications, as follows:

8C32GB:100GB ~ 10000GB
14C70GB:200GB ~ 10000GB
30C180GB:400GB ~ 10000GB
62C400G:800GB ~ 10000GB.

The default value of each package is its minimum value.

DiskType string

The storage type of the cluster. Effective only in the standard cluster version (cloud disk).

Two types are currently supported:

cloud_essd_pl1: cloud disk ESSD pl1.
cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

InstanceClass string

Cluster specification information. Note Please enter the shape as xCxxG, not xCxxGB

The x86 cluster architecture currently supports the following packages:

4C16G:4 core 16GB
8C32G:8 core 32GB
14C70G:14 core 70GB
24C120G:24 core 120GB
30C180G:30 core 180GB
62C400G:62 core 400GB
104C600G:104 core 600GB
16C70G:16 core 70GB
32C160G:32 core 160GB
64C380G:64 core 380GB
20C32G:20 core 32GB
40C64G:40 core 64GB
16C32G:16 core 32GB
32C70G:32 core 70GB
64C180G:64 core 180GB
32C180G:32 core 180GB
64C400G:64 core 400GB,

The cluster architecture of arm currently supports the following packages:

8C32G:8 core 32GB
16C70G:16 core 70GB
32C180G:32 core 180GB

InstanceName string

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.

NodeNum string

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3

ObVersion string

The OceanBase Server version number.

PaymentType string

The payment method of the instance. Value range:

Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
PayAsYouGo (default): Pay-as-you-go (default hourly billing).

Period int

PeriodUnit string

The duration of the purchase of resources.

Package year and Month value range: Month.

Default value: Month of the package, which is billed by volume. The default period is Hour.

PrimaryInstance string

The ID of the primary instance.

PrimaryRegion string

The primary instance Region.

ResourceGroupId string

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

Series string

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

Status string

The status of the resource

UpgradeSpecNative bool

Valid values:

false: migration and configuration change.
true: in-situ matching

Zones List<string>

Information about the zone where the cluster is deployed.

AutoRenew bool

Whether to automatically renew.

It takes effect when the parameter ChargeType is PrePaid. Value range:

true: automatic renewal.
false (default): no automatic renewal.

AutoRenewPeriod int

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.

PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

BackupRetainMode string

The backup retention policy after the cluster is deleted. The values are as follows:

receive_all: Keep all backup sets;
delete_all: delete all backup sets;
receive_last: Keep the last backup set.

CommodityCode string

Cpu int

The number of CPU cores of the cluster.

CpuArch string

Cpu architecture, x86, arm. If no, the default value is x86

CreateTime string

The creation time of the resource

DiskSize int

The size of the storage space, in GB.

The limits of storage space vary according to the cluster specifications, as follows:

8C32GB:100GB ~ 10000GB
14C70GB:200GB ~ 10000GB
30C180GB:400GB ~ 10000GB
62C400G:800GB ~ 10000GB.

The default value of each package is its minimum value.

DiskType string

The storage type of the cluster. Effective only in the standard cluster version (cloud disk).

Two types are currently supported:

cloud_essd_pl1: cloud disk ESSD pl1.
cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

InstanceClass string

Cluster specification information. Note Please enter the shape as xCxxG, not xCxxGB

The x86 cluster architecture currently supports the following packages:

4C16G:4 core 16GB
8C32G:8 core 32GB
14C70G:14 core 70GB
24C120G:24 core 120GB
30C180G:30 core 180GB
62C400G:62 core 400GB
104C600G:104 core 600GB
16C70G:16 core 70GB
32C160G:32 core 160GB
64C380G:64 core 380GB
20C32G:20 core 32GB
40C64G:40 core 64GB
16C32G:16 core 32GB
32C70G:32 core 70GB
64C180G:64 core 180GB
32C180G:32 core 180GB
64C400G:64 core 400GB,

The cluster architecture of arm currently supports the following packages:

8C32G:8 core 32GB
16C70G:16 core 70GB
32C180G:32 core 180GB

InstanceName string

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.

NodeNum string

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3

ObVersion string

The OceanBase Server version number.

PaymentType string

The payment method of the instance. Value range:

Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
PayAsYouGo (default): Pay-as-you-go (default hourly billing).

Period int

PeriodUnit string

The duration of the purchase of resources.

Package year and Month value range: Month.

Default value: Month of the package, which is billed by volume. The default period is Hour.

PrimaryInstance string

The ID of the primary instance.

PrimaryRegion string

The primary instance Region.

ResourceGroupId string

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

Series string

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

Status string

The status of the resource

UpgradeSpecNative bool

Valid values:

false: migration and configuration change.
true: in-situ matching

Zones []string

Information about the zone where the cluster is deployed.

autoRenew Boolean

Whether to automatically renew.

It takes effect when the parameter ChargeType is PrePaid. Value range:

true: automatic renewal.
false (default): no automatic renewal.

autoRenewPeriod Integer

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.

PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

backupRetainMode String

The backup retention policy after the cluster is deleted. The values are as follows:

receive_all: Keep all backup sets;
delete_all: delete all backup sets;
receive_last: Keep the last backup set.

commodityCode String

cpu Integer

The number of CPU cores of the cluster.

cpuArch String

Cpu architecture, x86, arm. If no, the default value is x86

createTime String

The creation time of the resource

diskSize Integer

The size of the storage space, in GB.

The limits of storage space vary according to the cluster specifications, as follows:

8C32GB:100GB ~ 10000GB
14C70GB:200GB ~ 10000GB
30C180GB:400GB ~ 10000GB
62C400G:800GB ~ 10000GB.

The default value of each package is its minimum value.

diskType String

The storage type of the cluster. Effective only in the standard cluster version (cloud disk).

Two types are currently supported:

cloud_essd_pl1: cloud disk ESSD pl1.
cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

instanceClass String

Cluster specification information. Note Please enter the shape as xCxxG, not xCxxGB

The x86 cluster architecture currently supports the following packages:

4C16G:4 core 16GB
8C32G:8 core 32GB
14C70G:14 core 70GB
24C120G:24 core 120GB
30C180G:30 core 180GB
62C400G:62 core 400GB
104C600G:104 core 600GB
16C70G:16 core 70GB
32C160G:32 core 160GB
64C380G:64 core 380GB
20C32G:20 core 32GB
40C64G:40 core 64GB
16C32G:16 core 32GB
32C70G:32 core 70GB
64C180G:64 core 180GB
32C180G:32 core 180GB
64C400G:64 core 400GB,

The cluster architecture of arm currently supports the following packages:

8C32G:8 core 32GB
16C70G:16 core 70GB
32C180G:32 core 180GB

instanceName String

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.

nodeNum String

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3

obVersion String

The OceanBase Server version number.

paymentType String

The payment method of the instance. Value range:

Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
PayAsYouGo (default): Pay-as-you-go (default hourly billing).

period Integer

periodUnit String

The duration of the purchase of resources.

Package year and Month value range: Month.

Default value: Month of the package, which is billed by volume. The default period is Hour.

primaryInstance String

The ID of the primary instance.

primaryRegion String

The primary instance Region.

resourceGroupId String

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

series String

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

status String

The status of the resource

upgradeSpecNative Boolean

Valid values:

false: migration and configuration change.
true: in-situ matching

zones List<String>

Information about the zone where the cluster is deployed.

autoRenew boolean

Whether to automatically renew.

It takes effect when the parameter ChargeType is PrePaid. Value range:

true: automatic renewal.
false (default): no automatic renewal.

autoRenewPeriod number

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.

PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

backupRetainMode string

The backup retention policy after the cluster is deleted. The values are as follows:

receive_all: Keep all backup sets;
delete_all: delete all backup sets;
receive_last: Keep the last backup set.

commodityCode string

cpu number

The number of CPU cores of the cluster.

cpuArch string

Cpu architecture, x86, arm. If no, the default value is x86

createTime string

The creation time of the resource

diskSize number

The size of the storage space, in GB.

The limits of storage space vary according to the cluster specifications, as follows:

8C32GB:100GB ~ 10000GB
14C70GB:200GB ~ 10000GB
30C180GB:400GB ~ 10000GB
62C400G:800GB ~ 10000GB.

The default value of each package is its minimum value.

diskType string

The storage type of the cluster. Effective only in the standard cluster version (cloud disk).

Two types are currently supported:

cloud_essd_pl1: cloud disk ESSD pl1.
cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

instanceClass string

Cluster specification information. Note Please enter the shape as xCxxG, not xCxxGB

The x86 cluster architecture currently supports the following packages:

4C16G:4 core 16GB
8C32G:8 core 32GB
14C70G:14 core 70GB
24C120G:24 core 120GB
30C180G:30 core 180GB
62C400G:62 core 400GB
104C600G:104 core 600GB
16C70G:16 core 70GB
32C160G:32 core 160GB
64C380G:64 core 380GB
20C32G:20 core 32GB
40C64G:40 core 64GB
16C32G:16 core 32GB
32C70G:32 core 70GB
64C180G:64 core 180GB
32C180G:32 core 180GB
64C400G:64 core 400GB,

The cluster architecture of arm currently supports the following packages:

8C32G:8 core 32GB
16C70G:16 core 70GB
32C180G:32 core 180GB

instanceName string

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.

nodeNum string

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3

obVersion string

The OceanBase Server version number.

paymentType string

The payment method of the instance. Value range:

Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
PayAsYouGo (default): Pay-as-you-go (default hourly billing).

period number

periodUnit string

The duration of the purchase of resources.

Package year and Month value range: Month.

Default value: Month of the package, which is billed by volume. The default period is Hour.

primaryInstance string

The ID of the primary instance.

primaryRegion string

The primary instance Region.

resourceGroupId string

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

series string

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

status string

The status of the resource

upgradeSpecNative boolean

Valid values:

false: migration and configuration change.
true: in-situ matching

zones string[]

Information about the zone where the cluster is deployed.

auto_renew bool

Whether to automatically renew.

It takes effect when the parameter ChargeType is PrePaid. Value range:

true: automatic renewal.
false (default): no automatic renewal.

auto_renew_period int

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.

PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

backup_retain_mode str

The backup retention policy after the cluster is deleted. The values are as follows:

receive_all: Keep all backup sets;
delete_all: delete all backup sets;
receive_last: Keep the last backup set.

commodity_code str

cpu int

The number of CPU cores of the cluster.

cpu_arch str

Cpu architecture, x86, arm. If no, the default value is x86

create_time str

The creation time of the resource

disk_size int

The size of the storage space, in GB.

The limits of storage space vary according to the cluster specifications, as follows:

8C32GB:100GB ~ 10000GB
14C70GB:200GB ~ 10000GB
30C180GB:400GB ~ 10000GB
62C400G:800GB ~ 10000GB.

The default value of each package is its minimum value.

disk_type str

The storage type of the cluster. Effective only in the standard cluster version (cloud disk).

Two types are currently supported:

cloud_essd_pl1: cloud disk ESSD pl1.
cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

instance_class str

Cluster specification information. Note Please enter the shape as xCxxG, not xCxxGB

The x86 cluster architecture currently supports the following packages:

4C16G:4 core 16GB
8C32G:8 core 32GB
14C70G:14 core 70GB
24C120G:24 core 120GB
30C180G:30 core 180GB
62C400G:62 core 400GB
104C600G:104 core 600GB
16C70G:16 core 70GB
32C160G:32 core 160GB
64C380G:64 core 380GB
20C32G:20 core 32GB
40C64G:40 core 64GB
16C32G:16 core 32GB
32C70G:32 core 70GB
64C180G:64 core 180GB
32C180G:32 core 180GB
64C400G:64 core 400GB,

The cluster architecture of arm currently supports the following packages:

8C32G:8 core 32GB
16C70G:16 core 70GB
32C180G:32 core 180GB

instance_name str

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.

node_num str

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3

ob_version str

The OceanBase Server version number.

payment_type str

The payment method of the instance. Value range:

Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
PayAsYouGo (default): Pay-as-you-go (default hourly billing).

period int

period_unit str

The duration of the purchase of resources.

Package year and Month value range: Month.

Default value: Month of the package, which is billed by volume. The default period is Hour.

primary_instance str

The ID of the primary instance.

primary_region str

The primary instance Region.

resource_group_id str

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

series str

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

status str

The status of the resource

upgrade_spec_native bool

Valid values:

false: migration and configuration change.
true: in-situ matching

zones Sequence[str]

Information about the zone where the cluster is deployed.

autoRenew Boolean

Whether to automatically renew.

It takes effect when the parameter ChargeType is PrePaid. Value range:

true: automatic renewal.
false (default): no automatic renewal.

autoRenewPeriod Number

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.

PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

backupRetainMode String

The backup retention policy after the cluster is deleted. The values are as follows:

receive_all: Keep all backup sets;
delete_all: delete all backup sets;
receive_last: Keep the last backup set.

commodityCode String

cpu Number

The number of CPU cores of the cluster.

cpuArch String

Cpu architecture, x86, arm. If no, the default value is x86

createTime String

The creation time of the resource

diskSize Number

The size of the storage space, in GB.

The limits of storage space vary according to the cluster specifications, as follows:

8C32GB:100GB ~ 10000GB
14C70GB:200GB ~ 10000GB
30C180GB:400GB ~ 10000GB
62C400G:800GB ~ 10000GB.

The default value of each package is its minimum value.

diskType String

The storage type of the cluster. Effective only in the standard cluster version (cloud disk).

Two types are currently supported:

cloud_essd_pl1: cloud disk ESSD pl1.
cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

instanceClass String

Cluster specification information. Note Please enter the shape as xCxxG, not xCxxGB

The x86 cluster architecture currently supports the following packages:

4C16G:4 core 16GB
8C32G:8 core 32GB
14C70G:14 core 70GB
24C120G:24 core 120GB
30C180G:30 core 180GB
62C400G:62 core 400GB
104C600G:104 core 600GB
16C70G:16 core 70GB
32C160G:32 core 160GB
64C380G:64 core 380GB
20C32G:20 core 32GB
40C64G:40 core 64GB
16C32G:16 core 32GB
32C70G:32 core 70GB
64C180G:64 core 180GB
32C180G:32 core 180GB
64C400G:64 core 400GB,

The cluster architecture of arm currently supports the following packages:

8C32G:8 core 32GB
16C70G:16 core 70GB
32C180G:32 core 180GB

instanceName String

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.

nodeNum String

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3

obVersion String

The OceanBase Server version number.

paymentType String

The payment method of the instance. Value range:

Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
PayAsYouGo (default): Pay-as-you-go (default hourly billing).

period Number

periodUnit String

The duration of the purchase of resources.

Package year and Month value range: Month.

Default value: Month of the package, which is billed by volume. The default period is Hour.

primaryInstance String

The ID of the primary instance.

primaryRegion String

The primary instance Region.

resourceGroupId String

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

series String

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

status String

The status of the resource

upgradeSpecNative Boolean

Valid values:

false: migration and configuration change.
true: in-situ matching

zones List<String>

Information about the zone where the cluster is deployed.

Import

Ocean Base Instance can be imported using the id, e.g.

$ pulumi import alicloud:ocean/baseInstance:BaseInstance example <id>

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

Alibaba Cloud v3.78.0 published on Friday, May 16, 2025 by Pulumi

pulumi/pulumi-alicloud

alicloud.ocean.BaseInstance

On this page

On this page

Example Usage

Create BaseInstance Resource

Constructor syntax

Parameters

Constructor example

BaseInstance Resource Properties

Inputs

Outputs

Look up Existing BaseInstance Resource

Import

Package Details

On this page

On this page