1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. mongodb
  5. Instance
volcenginecc v0.0.20 published on Thursday, Jan 22, 2026 by Volcengine
volcenginecc logo
volcenginecc v0.0.20 published on Thursday, Jan 22, 2026 by Volcengine

    文档数据库 MongoDB 版支持多种架构,能够满足业务灵活部署的需求。除副本集实例架构外,文档数据库 MongoDB 版还提供了分片集群架构,以满足海量数据业务场景,同时提供了灾备、备份及恢复、监控等全套解决方案;在互联网(游戏、电商、直播、资讯、社交)、新零售、在线教育、金融、物联网、政企等行业都有广泛的应用。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const mongoDBInstanceDemo = new volcenginecc.mongodb.Instance("MongoDBInstanceDemo", {
        zoneId: "cn-beijing-a,cn-beijing-c,cn-beijing-d",
        vpcId: "vpc-1a1vgeo9xxxcg8nvepjyxxxxx",
        subnetId: "subnet-ij9s4hxxxs3k74o8cuxxxxx",
        dbEngine: "MongoDB",
        dbEngineVersion: "MongoDB_7_0",
        instanceType: "ShardedCluster",
        nodeSpec: "mongo.shard.2c4g",
        nodeNumber: 3,
        mongosNodeSpec: "mongo.mongos.2c4g",
        mongosNodeNumber: 3,
        shardNumber: 2,
        storageSpaceGb: 100,
        configServerNodeSpec: "mongo.config.2c4g",
        configServerStorageSpaceGb: 20,
        superAccountName: "****",
        superAccountPassword: "*******",
        instanceName: "MongoDBInstanceDemo",
        instanceCount: 1,
        chargeType: "PostPaid",
        projectName: "default",
        tags: [{
            key: "env",
            value: "test",
        }],
        allowListIds: [
            "acl-c972e7b4ce4941a1a8d5xxxe57xxxxx",
            "acl-70dbb8ee8893467dbafxxxc964xxxxx",
        ],
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    mongo_db_instance_demo = volcenginecc.mongodb.Instance("MongoDBInstanceDemo",
        zone_id="cn-beijing-a,cn-beijing-c,cn-beijing-d",
        vpc_id="vpc-1a1vgeo9xxxcg8nvepjyxxxxx",
        subnet_id="subnet-ij9s4hxxxs3k74o8cuxxxxx",
        db_engine="MongoDB",
        db_engine_version="MongoDB_7_0",
        instance_type="ShardedCluster",
        node_spec="mongo.shard.2c4g",
        node_number=3,
        mongos_node_spec="mongo.mongos.2c4g",
        mongos_node_number=3,
        shard_number=2,
        storage_space_gb=100,
        config_server_node_spec="mongo.config.2c4g",
        config_server_storage_space_gb=20,
        super_account_name="****",
        super_account_password="*******",
        instance_name="MongoDBInstanceDemo",
        instance_count=1,
        charge_type="PostPaid",
        project_name="default",
        tags=[{
            "key": "env",
            "value": "test",
        }],
        allow_list_ids=[
            "acl-c972e7b4ce4941a1a8d5xxxe57xxxxx",
            "acl-70dbb8ee8893467dbafxxxc964xxxxx",
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/mongodb"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mongodb.NewInstance(ctx, "MongoDBInstanceDemo", &mongodb.InstanceArgs{
    			ZoneId:                     pulumi.String("cn-beijing-a,cn-beijing-c,cn-beijing-d"),
    			VpcId:                      pulumi.String("vpc-1a1vgeo9xxxcg8nvepjyxxxxx"),
    			SubnetId:                   pulumi.String("subnet-ij9s4hxxxs3k74o8cuxxxxx"),
    			DbEngine:                   pulumi.String("MongoDB"),
    			DbEngineVersion:            pulumi.String("MongoDB_7_0"),
    			InstanceType:               pulumi.String("ShardedCluster"),
    			NodeSpec:                   pulumi.String("mongo.shard.2c4g"),
    			NodeNumber:                 pulumi.Int(3),
    			MongosNodeSpec:             pulumi.String("mongo.mongos.2c4g"),
    			MongosNodeNumber:           pulumi.Int(3),
    			ShardNumber:                pulumi.Int(2),
    			StorageSpaceGb:             pulumi.Int(100),
    			ConfigServerNodeSpec:       pulumi.String("mongo.config.2c4g"),
    			ConfigServerStorageSpaceGb: pulumi.Int(20),
    			SuperAccountName:           pulumi.String("****"),
    			SuperAccountPassword:       pulumi.String("*******"),
    			InstanceName:               pulumi.String("MongoDBInstanceDemo"),
    			InstanceCount:              pulumi.Int(1),
    			ChargeType:                 pulumi.String("PostPaid"),
    			ProjectName:                pulumi.String("default"),
    			Tags: mongodb.InstanceTagArray{
    				&mongodb.InstanceTagArgs{
    					Key:   pulumi.String("env"),
    					Value: pulumi.String("test"),
    				},
    			},
    			AllowListIds: pulumi.StringArray{
    				pulumi.String("acl-c972e7b4ce4941a1a8d5xxxe57xxxxx"),
    				pulumi.String("acl-70dbb8ee8893467dbafxxxc964xxxxx"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var mongoDBInstanceDemo = new Volcenginecc.Mongodb.Instance("MongoDBInstanceDemo", new()
        {
            ZoneId = "cn-beijing-a,cn-beijing-c,cn-beijing-d",
            VpcId = "vpc-1a1vgeo9xxxcg8nvepjyxxxxx",
            SubnetId = "subnet-ij9s4hxxxs3k74o8cuxxxxx",
            DbEngine = "MongoDB",
            DbEngineVersion = "MongoDB_7_0",
            InstanceType = "ShardedCluster",
            NodeSpec = "mongo.shard.2c4g",
            NodeNumber = 3,
            MongosNodeSpec = "mongo.mongos.2c4g",
            MongosNodeNumber = 3,
            ShardNumber = 2,
            StorageSpaceGb = 100,
            ConfigServerNodeSpec = "mongo.config.2c4g",
            ConfigServerStorageSpaceGb = 20,
            SuperAccountName = "****",
            SuperAccountPassword = "*******",
            InstanceName = "MongoDBInstanceDemo",
            InstanceCount = 1,
            ChargeType = "PostPaid",
            ProjectName = "default",
            Tags = new[]
            {
                new Volcenginecc.Mongodb.Inputs.InstanceTagArgs
                {
                    Key = "env",
                    Value = "test",
                },
            },
            AllowListIds = new[]
            {
                "acl-c972e7b4ce4941a1a8d5xxxe57xxxxx",
                "acl-70dbb8ee8893467dbafxxxc964xxxxx",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.mongodb.Instance;
    import com.volcengine.volcenginecc.mongodb.InstanceArgs;
    import com.pulumi.volcenginecc.mongodb.inputs.InstanceTagArgs;
    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) {
            var mongoDBInstanceDemo = new Instance("mongoDBInstanceDemo", InstanceArgs.builder()
                .zoneId("cn-beijing-a,cn-beijing-c,cn-beijing-d")
                .vpcId("vpc-1a1vgeo9xxxcg8nvepjyxxxxx")
                .subnetId("subnet-ij9s4hxxxs3k74o8cuxxxxx")
                .dbEngine("MongoDB")
                .dbEngineVersion("MongoDB_7_0")
                .instanceType("ShardedCluster")
                .nodeSpec("mongo.shard.2c4g")
                .nodeNumber(3)
                .mongosNodeSpec("mongo.mongos.2c4g")
                .mongosNodeNumber(3)
                .shardNumber(2)
                .storageSpaceGb(100)
                .configServerNodeSpec("mongo.config.2c4g")
                .configServerStorageSpaceGb(20)
                .superAccountName("****")
                .superAccountPassword("*******")
                .instanceName("MongoDBInstanceDemo")
                .instanceCount(1)
                .chargeType("PostPaid")
                .projectName("default")
                .tags(InstanceTagArgs.builder()
                    .key("env")
                    .value("test")
                    .build())
                .allowListIds(            
                    "acl-c972e7b4ce4941a1a8d5xxxe57xxxxx",
                    "acl-70dbb8ee8893467dbafxxxc964xxxxx")
                .build());
    
        }
    }
    
    resources:
      mongoDBInstanceDemo:
        type: volcenginecc:mongodb:Instance
        name: MongoDBInstanceDemo
        properties:
          zoneId: cn-beijing-a,cn-beijing-c,cn-beijing-d
          vpcId: vpc-1a1vgeo9xxxcg8nvepjyxxxxx
          subnetId: subnet-ij9s4hxxxs3k74o8cuxxxxx
          dbEngine: MongoDB
          dbEngineVersion: MongoDB_7_0
          instanceType: ShardedCluster
          nodeSpec: mongo.shard.2c4g
          nodeNumber: 3
          mongosNodeSpec: mongo.mongos.2c4g
          mongosNodeNumber: 3
          shardNumber: 2
          storageSpaceGb: 100
          configServerNodeSpec: mongo.config.2c4g
          configServerStorageSpaceGb: 20
          superAccountName: '****'
          superAccountPassword: '*******'
          instanceName: MongoDBInstanceDemo
          instanceCount: 1
          chargeType: PostPaid
          projectName: default
          tags:
            - key: env
              value: test
          allowListIds:
            - acl-c972e7b4ce4941a1a8d5xxxe57xxxxx
            - acl-70dbb8ee8893467dbafxxxc964xxxxx
    

    Create Instance Resource

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

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
    def Instance(resource_name: str,
                 args: InstanceArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Instance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 node_spec: Optional[str] = None,
                 zone_id: Optional[str] = None,
                 vpc_id: Optional[str] = None,
                 subnet_id: Optional[str] = None,
                 storage_space_gb: Optional[int] = None,
                 node_availability_zones: Optional[Sequence[InstanceNodeAvailabilityZoneArgs]] = None,
                 period_unit: Optional[str] = None,
                 instance_count: Optional[int] = None,
                 instance_name: Optional[str] = None,
                 instance_type: Optional[str] = None,
                 mongos_node_number: Optional[int] = None,
                 mongos_node_spec: Optional[str] = None,
                 allow_list_ids: Optional[Sequence[str]] = None,
                 node_number: Optional[int] = None,
                 db_engine: Optional[str] = None,
                 period: Optional[int] = None,
                 db_engine_version: Optional[str] = None,
                 project_name: Optional[str] = None,
                 shard_number: Optional[int] = None,
                 config_server_storage_space_gb: Optional[int] = None,
                 config_server_node_spec: Optional[str] = None,
                 super_account_name: Optional[str] = None,
                 super_account_password: Optional[str] = None,
                 tags: Optional[Sequence[InstanceTagArgs]] = None,
                 charge_type: Optional[str] = None,
                 auto_renew: Optional[bool] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
    public Instance(String name, InstanceArgs args, CustomResourceOptions options)
    
    type: volcenginecc:mongodb:Instance
    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 InstanceArgs
    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 InstanceArgs
    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 InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    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 exampleinstanceResourceResourceFromMongodbinstance = new Volcenginecc.Mongodb.Instance("exampleinstanceResourceResourceFromMongodbinstance", new()
    {
        NodeSpec = "string",
        ZoneId = "string",
        VpcId = "string",
        SubnetId = "string",
        StorageSpaceGb = 0,
        NodeAvailabilityZones = new[]
        {
            new Volcenginecc.Mongodb.Inputs.InstanceNodeAvailabilityZoneArgs
            {
                NodeNumber = 0,
                ZoneId = "string",
            },
        },
        PeriodUnit = "string",
        InstanceCount = 0,
        InstanceName = "string",
        InstanceType = "string",
        MongosNodeNumber = 0,
        MongosNodeSpec = "string",
        AllowListIds = new[]
        {
            "string",
        },
        NodeNumber = 0,
        DbEngine = "string",
        Period = 0,
        DbEngineVersion = "string",
        ProjectName = "string",
        ShardNumber = 0,
        ConfigServerStorageSpaceGb = 0,
        ConfigServerNodeSpec = "string",
        SuperAccountName = "string",
        SuperAccountPassword = "string",
        Tags = new[]
        {
            new Volcenginecc.Mongodb.Inputs.InstanceTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        ChargeType = "string",
        AutoRenew = false,
    });
    
    example, err := mongodb.NewInstance(ctx, "exampleinstanceResourceResourceFromMongodbinstance", &mongodb.InstanceArgs{
    	NodeSpec:       pulumi.String("string"),
    	ZoneId:         pulumi.String("string"),
    	VpcId:          pulumi.String("string"),
    	SubnetId:       pulumi.String("string"),
    	StorageSpaceGb: pulumi.Int(0),
    	NodeAvailabilityZones: mongodb.InstanceNodeAvailabilityZoneArray{
    		&mongodb.InstanceNodeAvailabilityZoneArgs{
    			NodeNumber: pulumi.Int(0),
    			ZoneId:     pulumi.String("string"),
    		},
    	},
    	PeriodUnit:       pulumi.String("string"),
    	InstanceCount:    pulumi.Int(0),
    	InstanceName:     pulumi.String("string"),
    	InstanceType:     pulumi.String("string"),
    	MongosNodeNumber: pulumi.Int(0),
    	MongosNodeSpec:   pulumi.String("string"),
    	AllowListIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	NodeNumber:                 pulumi.Int(0),
    	DbEngine:                   pulumi.String("string"),
    	Period:                     pulumi.Int(0),
    	DbEngineVersion:            pulumi.String("string"),
    	ProjectName:                pulumi.String("string"),
    	ShardNumber:                pulumi.Int(0),
    	ConfigServerStorageSpaceGb: pulumi.Int(0),
    	ConfigServerNodeSpec:       pulumi.String("string"),
    	SuperAccountName:           pulumi.String("string"),
    	SuperAccountPassword:       pulumi.String("string"),
    	Tags: mongodb.InstanceTagArray{
    		&mongodb.InstanceTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	ChargeType: pulumi.String("string"),
    	AutoRenew:  pulumi.Bool(false),
    })
    
    var exampleinstanceResourceResourceFromMongodbinstance = new com.volcengine.volcenginecc.mongodb.Instance("exampleinstanceResourceResourceFromMongodbinstance", com.volcengine.volcenginecc.mongodb.InstanceArgs.builder()
        .nodeSpec("string")
        .zoneId("string")
        .vpcId("string")
        .subnetId("string")
        .storageSpaceGb(0)
        .nodeAvailabilityZones(InstanceNodeAvailabilityZoneArgs.builder()
            .nodeNumber(0)
            .zoneId("string")
            .build())
        .periodUnit("string")
        .instanceCount(0)
        .instanceName("string")
        .instanceType("string")
        .mongosNodeNumber(0)
        .mongosNodeSpec("string")
        .allowListIds("string")
        .nodeNumber(0)
        .dbEngine("string")
        .period(0)
        .dbEngineVersion("string")
        .projectName("string")
        .shardNumber(0)
        .configServerStorageSpaceGb(0)
        .configServerNodeSpec("string")
        .superAccountName("string")
        .superAccountPassword("string")
        .tags(InstanceTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .chargeType("string")
        .autoRenew(false)
        .build());
    
    exampleinstance_resource_resource_from_mongodbinstance = volcenginecc.mongodb.Instance("exampleinstanceResourceResourceFromMongodbinstance",
        node_spec="string",
        zone_id="string",
        vpc_id="string",
        subnet_id="string",
        storage_space_gb=0,
        node_availability_zones=[{
            "node_number": 0,
            "zone_id": "string",
        }],
        period_unit="string",
        instance_count=0,
        instance_name="string",
        instance_type="string",
        mongos_node_number=0,
        mongos_node_spec="string",
        allow_list_ids=["string"],
        node_number=0,
        db_engine="string",
        period=0,
        db_engine_version="string",
        project_name="string",
        shard_number=0,
        config_server_storage_space_gb=0,
        config_server_node_spec="string",
        super_account_name="string",
        super_account_password="string",
        tags=[{
            "key": "string",
            "value": "string",
        }],
        charge_type="string",
        auto_renew=False)
    
    const exampleinstanceResourceResourceFromMongodbinstance = new volcenginecc.mongodb.Instance("exampleinstanceResourceResourceFromMongodbinstance", {
        nodeSpec: "string",
        zoneId: "string",
        vpcId: "string",
        subnetId: "string",
        storageSpaceGb: 0,
        nodeAvailabilityZones: [{
            nodeNumber: 0,
            zoneId: "string",
        }],
        periodUnit: "string",
        instanceCount: 0,
        instanceName: "string",
        instanceType: "string",
        mongosNodeNumber: 0,
        mongosNodeSpec: "string",
        allowListIds: ["string"],
        nodeNumber: 0,
        dbEngine: "string",
        period: 0,
        dbEngineVersion: "string",
        projectName: "string",
        shardNumber: 0,
        configServerStorageSpaceGb: 0,
        configServerNodeSpec: "string",
        superAccountName: "string",
        superAccountPassword: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        chargeType: "string",
        autoRenew: false,
    });
    
    type: volcenginecc:mongodb:Instance
    properties:
        allowListIds:
            - string
        autoRenew: false
        chargeType: string
        configServerNodeSpec: string
        configServerStorageSpaceGb: 0
        dbEngine: string
        dbEngineVersion: string
        instanceCount: 0
        instanceName: string
        instanceType: string
        mongosNodeNumber: 0
        mongosNodeSpec: string
        nodeAvailabilityZones:
            - nodeNumber: 0
              zoneId: string
        nodeNumber: 0
        nodeSpec: string
        period: 0
        periodUnit: string
        projectName: string
        shardNumber: 0
        storageSpaceGb: 0
        subnetId: string
        superAccountName: string
        superAccountPassword: string
        tags:
            - key: string
              value: string
        vpcId: string
        zoneId: string
    

    Instance 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 Instance resource accepts the following input properties:

    NodeSpec string
    实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
    StorageSpaceGb int
    副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
    SubnetId string
    子网 ID。
    VpcId string
    私有网络 ID。
    ZoneId string
    实例所在可用区的 ID。
    AllowListIds List<string>
    白名单 ID 列表。新建实例会被绑定到指定白名单。
    AutoRenew bool
    是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
    ChargeType string
    实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
    ConfigServerNodeSpec string
    分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
    ConfigServerStorageSpaceGb int
    分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
    DbEngine string
    数据库引擎。取值固定为 MongoDB
    DbEngineVersion string
    数据库引擎版本,取值范围如下:MongoDB40(默认):MongoDB 4.0 版本。MongoDB42:MongoDB 4.2 版本。MongoDB44:MongoDB 4.4 版本。MongoDB50:MongoDB 5.0 版本。MongoDB60:MongoDB 6.0 版本。MongoDB70:MongoDB 7.0 版本。
    InstanceCount int
    需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
    InstanceName string
    实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
    InstanceType string
    MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
    MongosNodeNumber int
    分片集群中 Mongos 节点的数量。取值范围:2~32。
    MongosNodeSpec string
    分片集群中 Mongos 节点的规格码。
    NodeAvailabilityZones List<Volcengine.InstanceNodeAvailabilityZone>
    NodeNumber int
    节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
    Period int
    包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
    PeriodUnit string
    指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
    ProjectName string
    选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
    ShardNumber int
    分片集群中 Shard 分片的数量。取值范围:2~32。
    SuperAccountName string
    数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
    SuperAccountPassword string
    root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
    Tags List<Volcengine.InstanceTag>
    NodeSpec string
    实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
    StorageSpaceGb int
    副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
    SubnetId string
    子网 ID。
    VpcId string
    私有网络 ID。
    ZoneId string
    实例所在可用区的 ID。
    AllowListIds []string
    白名单 ID 列表。新建实例会被绑定到指定白名单。
    AutoRenew bool
    是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
    ChargeType string
    实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
    ConfigServerNodeSpec string
    分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
    ConfigServerStorageSpaceGb int
    分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
    DbEngine string
    数据库引擎。取值固定为 MongoDB
    DbEngineVersion string
    数据库引擎版本,取值范围如下:MongoDB40(默认):MongoDB 4.0 版本。MongoDB42:MongoDB 4.2 版本。MongoDB44:MongoDB 4.4 版本。MongoDB50:MongoDB 5.0 版本。MongoDB60:MongoDB 6.0 版本。MongoDB70:MongoDB 7.0 版本。
    InstanceCount int
    需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
    InstanceName string
    实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
    InstanceType string
    MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
    MongosNodeNumber int
    分片集群中 Mongos 节点的数量。取值范围:2~32。
    MongosNodeSpec string
    分片集群中 Mongos 节点的规格码。
    NodeAvailabilityZones []InstanceNodeAvailabilityZoneArgs
    NodeNumber int
    节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
    Period int
    包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
    PeriodUnit string
    指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
    ProjectName string
    选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
    ShardNumber int
    分片集群中 Shard 分片的数量。取值范围:2~32。
    SuperAccountName string
    数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
    SuperAccountPassword string
    root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
    Tags []InstanceTagArgs
    nodeSpec String
    实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
    storageSpaceGb Integer
    副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
    subnetId String
    子网 ID。
    vpcId String
    私有网络 ID。
    zoneId String
    实例所在可用区的 ID。
    allowListIds List<String>
    白名单 ID 列表。新建实例会被绑定到指定白名单。
    autoRenew Boolean
    是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
    chargeType String
    实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
    configServerNodeSpec String
    分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
    configServerStorageSpaceGb Integer
    分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
    dbEngine String
    数据库引擎。取值固定为 MongoDB
    dbEngineVersion String
    数据库引擎版本,取值范围如下:MongoDB40(默认):MongoDB 4.0 版本。MongoDB42:MongoDB 4.2 版本。MongoDB44:MongoDB 4.4 版本。MongoDB50:MongoDB 5.0 版本。MongoDB60:MongoDB 6.0 版本。MongoDB70:MongoDB 7.0 版本。
    instanceCount Integer
    需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
    instanceName String
    实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
    instanceType String
    MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
    mongosNodeNumber Integer
    分片集群中 Mongos 节点的数量。取值范围:2~32。
    mongosNodeSpec String
    分片集群中 Mongos 节点的规格码。
    nodeAvailabilityZones List<InstanceNodeAvailabilityZone>
    nodeNumber Integer
    节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
    period Integer
    包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
    periodUnit String
    指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
    projectName String
    选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
    shardNumber Integer
    分片集群中 Shard 分片的数量。取值范围:2~32。
    superAccountName String
    数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
    superAccountPassword String
    root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
    tags List<InstanceTag>
    nodeSpec string
    实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
    storageSpaceGb number
    副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
    subnetId string
    子网 ID。
    vpcId string
    私有网络 ID。
    zoneId string
    实例所在可用区的 ID。
    allowListIds string[]
    白名单 ID 列表。新建实例会被绑定到指定白名单。
    autoRenew boolean
    是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
    chargeType string
    实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
    configServerNodeSpec string
    分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
    configServerStorageSpaceGb number
    分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
    dbEngine string
    数据库引擎。取值固定为 MongoDB
    dbEngineVersion string
    数据库引擎版本,取值范围如下:MongoDB40(默认):MongoDB 4.0 版本。MongoDB42:MongoDB 4.2 版本。MongoDB44:MongoDB 4.4 版本。MongoDB50:MongoDB 5.0 版本。MongoDB60:MongoDB 6.0 版本。MongoDB70:MongoDB 7.0 版本。
    instanceCount number
    需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
    instanceName string
    实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
    instanceType string
    MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
    mongosNodeNumber number
    分片集群中 Mongos 节点的数量。取值范围:2~32。
    mongosNodeSpec string
    分片集群中 Mongos 节点的规格码。
    nodeAvailabilityZones InstanceNodeAvailabilityZone[]
    nodeNumber number
    节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
    period number
    包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
    periodUnit string
    指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
    projectName string
    选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
    shardNumber number
    分片集群中 Shard 分片的数量。取值范围:2~32。
    superAccountName string
    数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
    superAccountPassword string
    root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
    tags InstanceTag[]
    node_spec str
    实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
    storage_space_gb int
    副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
    subnet_id str
    子网 ID。
    vpc_id str
    私有网络 ID。
    zone_id str
    实例所在可用区的 ID。
    allow_list_ids Sequence[str]
    白名单 ID 列表。新建实例会被绑定到指定白名单。
    auto_renew bool
    是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
    charge_type str
    实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
    config_server_node_spec str
    分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
    config_server_storage_space_gb int
    分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
    db_engine str
    数据库引擎。取值固定为 MongoDB
    db_engine_version str
    数据库引擎版本,取值范围如下:MongoDB40(默认):MongoDB 4.0 版本。MongoDB42:MongoDB 4.2 版本。MongoDB44:MongoDB 4.4 版本。MongoDB50:MongoDB 5.0 版本。MongoDB60:MongoDB 6.0 版本。MongoDB70:MongoDB 7.0 版本。
    instance_count int
    需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
    instance_name str
    实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
    instance_type str
    MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
    mongos_node_number int
    分片集群中 Mongos 节点的数量。取值范围:2~32。
    mongos_node_spec str
    分片集群中 Mongos 节点的规格码。
    node_availability_zones Sequence[InstanceNodeAvailabilityZoneArgs]
    node_number int
    节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
    period int
    包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
    period_unit str
    指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
    project_name str
    选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
    shard_number int
    分片集群中 Shard 分片的数量。取值范围:2~32。
    super_account_name str
    数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
    super_account_password str
    root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
    tags Sequence[InstanceTagArgs]
    nodeSpec String
    实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
    storageSpaceGb Number
    副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
    subnetId String
    子网 ID。
    vpcId String
    私有网络 ID。
    zoneId String
    实例所在可用区的 ID。
    allowListIds List<String>
    白名单 ID 列表。新建实例会被绑定到指定白名单。
    autoRenew Boolean
    是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
    chargeType String
    实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
    configServerNodeSpec String
    分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
    configServerStorageSpaceGb Number
    分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
    dbEngine String
    数据库引擎。取值固定为 MongoDB
    dbEngineVersion String
    数据库引擎版本,取值范围如下:MongoDB40(默认):MongoDB 4.0 版本。MongoDB42:MongoDB 4.2 版本。MongoDB44:MongoDB 4.4 版本。MongoDB50:MongoDB 5.0 版本。MongoDB60:MongoDB 6.0 版本。MongoDB70:MongoDB 7.0 版本。
    instanceCount Number
    需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
    instanceName String
    实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
    instanceType String
    MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
    mongosNodeNumber Number
    分片集群中 Mongos 节点的数量。取值范围:2~32。
    mongosNodeSpec String
    分片集群中 Mongos 节点的规格码。
    nodeAvailabilityZones List<Property Map>
    nodeNumber Number
    节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
    period Number
    包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
    periodUnit String
    指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
    projectName String
    选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
    shardNumber Number
    分片集群中 Shard 分片的数量。取值范围:2~32。
    superAccountName String
    数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
    superAccountPassword String
    root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
    tags List<Property Map>

    Outputs

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

    ChargeStatus string
    实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
    ClosedTime string
    计划关停时间(UTC)。
    ConfigServers List<Volcengine.InstanceConfigServer>
    ConfigServersId string
    ConfigServer 的 ID。
    CreatedTime string
    实例创建时间(UTC)。
    DbEngineVersionStr string
    数据库引擎版本的字符串。
    ExpiredTime string
    实例到期时间(UTC)。
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    实例 ID。
    InstanceStatus string
    实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
    Mongos List<Volcengine.InstanceMongo>
    MongosId string
    Mongos 的 ID。
    Nodes List<Volcengine.InstanceNode>
    PrivateEndpoint string
    实例私网连接地址的字符串信息。
    ReadOnlyNodeNumber int
    实例的只读节点数量。
    ReclaimTime string
    实例的计划回收时间(UTC)。
    Shards List<Volcengine.InstanceShard>
    StorageType string
    实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
    UpdatedTime string
    实例的更新时间(UTC)。
    ChargeStatus string
    实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
    ClosedTime string
    计划关停时间(UTC)。
    ConfigServers []InstanceConfigServer
    ConfigServersId string
    ConfigServer 的 ID。
    CreatedTime string
    实例创建时间(UTC)。
    DbEngineVersionStr string
    数据库引擎版本的字符串。
    ExpiredTime string
    实例到期时间(UTC)。
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    实例 ID。
    InstanceStatus string
    实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
    Mongos []InstanceMongo
    MongosId string
    Mongos 的 ID。
    Nodes []InstanceNode
    PrivateEndpoint string
    实例私网连接地址的字符串信息。
    ReadOnlyNodeNumber int
    实例的只读节点数量。
    ReclaimTime string
    实例的计划回收时间(UTC)。
    Shards []InstanceShard
    StorageType string
    实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
    UpdatedTime string
    实例的更新时间(UTC)。
    chargeStatus String
    实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
    closedTime String
    计划关停时间(UTC)。
    configServers List<InstanceConfigServer>
    configServersId String
    ConfigServer 的 ID。
    createdTime String
    实例创建时间(UTC)。
    dbEngineVersionStr String
    数据库引擎版本的字符串。
    expiredTime String
    实例到期时间(UTC)。
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    实例 ID。
    instanceStatus String
    实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
    mongos List<InstanceMongo>
    mongosId String
    Mongos 的 ID。
    nodes List<InstanceNode>
    privateEndpoint String
    实例私网连接地址的字符串信息。
    readOnlyNodeNumber Integer
    实例的只读节点数量。
    reclaimTime String
    实例的计划回收时间(UTC)。
    shards List<InstanceShard>
    storageType String
    实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
    updatedTime String
    实例的更新时间(UTC)。
    chargeStatus string
    实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
    closedTime string
    计划关停时间(UTC)。
    configServers InstanceConfigServer[]
    configServersId string
    ConfigServer 的 ID。
    createdTime string
    实例创建时间(UTC)。
    dbEngineVersionStr string
    数据库引擎版本的字符串。
    expiredTime string
    实例到期时间(UTC)。
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    实例 ID。
    instanceStatus string
    实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
    mongos InstanceMongo[]
    mongosId string
    Mongos 的 ID。
    nodes InstanceNode[]
    privateEndpoint string
    实例私网连接地址的字符串信息。
    readOnlyNodeNumber number
    实例的只读节点数量。
    reclaimTime string
    实例的计划回收时间(UTC)。
    shards InstanceShard[]
    storageType string
    实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
    updatedTime string
    实例的更新时间(UTC)。
    charge_status str
    实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
    closed_time str
    计划关停时间(UTC)。
    config_servers Sequence[InstanceConfigServer]
    config_servers_id str
    ConfigServer 的 ID。
    created_time str
    实例创建时间(UTC)。
    db_engine_version_str str
    数据库引擎版本的字符串。
    expired_time str
    实例到期时间(UTC)。
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    实例 ID。
    instance_status str
    实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
    mongos Sequence[InstanceMongo]
    mongos_id str
    Mongos 的 ID。
    nodes Sequence[InstanceNode]
    private_endpoint str
    实例私网连接地址的字符串信息。
    read_only_node_number int
    实例的只读节点数量。
    reclaim_time str
    实例的计划回收时间(UTC)。
    shards Sequence[InstanceShard]
    storage_type str
    实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
    updated_time str
    实例的更新时间(UTC)。
    chargeStatus String
    实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
    closedTime String
    计划关停时间(UTC)。
    configServers List<Property Map>
    configServersId String
    ConfigServer 的 ID。
    createdTime String
    实例创建时间(UTC)。
    dbEngineVersionStr String
    数据库引擎版本的字符串。
    expiredTime String
    实例到期时间(UTC)。
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    实例 ID。
    instanceStatus String
    实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
    mongos List<Property Map>
    mongosId String
    Mongos 的 ID。
    nodes List<Property Map>
    privateEndpoint String
    实例私网连接地址的字符串信息。
    readOnlyNodeNumber Number
    实例的只读节点数量。
    reclaimTime String
    实例的计划回收时间(UTC)。
    shards List<Property Map>
    storageType String
    实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
    updatedTime String
    实例的更新时间(UTC)。

    Look up Existing Instance Resource

    Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_list_ids: Optional[Sequence[str]] = None,
            auto_renew: Optional[bool] = None,
            charge_status: Optional[str] = None,
            charge_type: Optional[str] = None,
            closed_time: Optional[str] = None,
            config_server_node_spec: Optional[str] = None,
            config_server_storage_space_gb: Optional[int] = None,
            config_servers: Optional[Sequence[InstanceConfigServerArgs]] = None,
            config_servers_id: Optional[str] = None,
            created_time: Optional[str] = None,
            db_engine: Optional[str] = None,
            db_engine_version: Optional[str] = None,
            db_engine_version_str: Optional[str] = None,
            expired_time: Optional[str] = None,
            instance_count: Optional[int] = None,
            instance_id: Optional[str] = None,
            instance_name: Optional[str] = None,
            instance_status: Optional[str] = None,
            instance_type: Optional[str] = None,
            mongos: Optional[Sequence[InstanceMongoArgs]] = None,
            mongos_id: Optional[str] = None,
            mongos_node_number: Optional[int] = None,
            mongos_node_spec: Optional[str] = None,
            node_availability_zones: Optional[Sequence[InstanceNodeAvailabilityZoneArgs]] = None,
            node_number: Optional[int] = None,
            node_spec: Optional[str] = None,
            nodes: Optional[Sequence[InstanceNodeArgs]] = None,
            period: Optional[int] = None,
            period_unit: Optional[str] = None,
            private_endpoint: Optional[str] = None,
            project_name: Optional[str] = None,
            read_only_node_number: Optional[int] = None,
            reclaim_time: Optional[str] = None,
            shard_number: Optional[int] = None,
            shards: Optional[Sequence[InstanceShardArgs]] = None,
            storage_space_gb: Optional[int] = None,
            storage_type: Optional[str] = None,
            subnet_id: Optional[str] = None,
            super_account_name: Optional[str] = None,
            super_account_password: Optional[str] = None,
            tags: Optional[Sequence[InstanceTagArgs]] = None,
            updated_time: Optional[str] = None,
            vpc_id: Optional[str] = None,
            zone_id: Optional[str] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:mongodb:Instance    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:
    AllowListIds List<string>
    白名单 ID 列表。新建实例会被绑定到指定白名单。
    AutoRenew bool
    是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
    ChargeStatus string
    实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
    ChargeType string
    实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
    ClosedTime string
    计划关停时间(UTC)。
    ConfigServerNodeSpec string
    分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
    ConfigServerStorageSpaceGb int
    分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
    ConfigServers List<Volcengine.InstanceConfigServer>
    ConfigServersId string
    ConfigServer 的 ID。
    CreatedTime string
    实例创建时间(UTC)。
    DbEngine string
    数据库引擎。取值固定为 MongoDB
    DbEngineVersion string
    数据库引擎版本,取值范围如下:MongoDB40(默认):MongoDB 4.0 版本。MongoDB42:MongoDB 4.2 版本。MongoDB44:MongoDB 4.4 版本。MongoDB50:MongoDB 5.0 版本。MongoDB60:MongoDB 6.0 版本。MongoDB70:MongoDB 7.0 版本。
    DbEngineVersionStr string
    数据库引擎版本的字符串。
    ExpiredTime string
    实例到期时间(UTC)。
    InstanceCount int
    需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
    InstanceId string
    实例 ID。
    InstanceName string
    实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
    InstanceStatus string
    实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
    InstanceType string
    MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
    Mongos List<Volcengine.InstanceMongo>
    MongosId string
    Mongos 的 ID。
    MongosNodeNumber int
    分片集群中 Mongos 节点的数量。取值范围:2~32。
    MongosNodeSpec string
    分片集群中 Mongos 节点的规格码。
    NodeAvailabilityZones List<Volcengine.InstanceNodeAvailabilityZone>
    NodeNumber int
    节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
    NodeSpec string
    实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
    Nodes List<Volcengine.InstanceNode>
    Period int
    包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
    PeriodUnit string
    指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
    PrivateEndpoint string
    实例私网连接地址的字符串信息。
    ProjectName string
    选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
    ReadOnlyNodeNumber int
    实例的只读节点数量。
    ReclaimTime string
    实例的计划回收时间(UTC)。
    ShardNumber int
    分片集群中 Shard 分片的数量。取值范围:2~32。
    Shards List<Volcengine.InstanceShard>
    StorageSpaceGb int
    副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
    StorageType string
    实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
    SubnetId string
    子网 ID。
    SuperAccountName string
    数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
    SuperAccountPassword string
    root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
    Tags List<Volcengine.InstanceTag>
    UpdatedTime string
    实例的更新时间(UTC)。
    VpcId string
    私有网络 ID。
    ZoneId string
    实例所在可用区的 ID。
    AllowListIds []string
    白名单 ID 列表。新建实例会被绑定到指定白名单。
    AutoRenew bool
    是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
    ChargeStatus string
    实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
    ChargeType string
    实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
    ClosedTime string
    计划关停时间(UTC)。
    ConfigServerNodeSpec string
    分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
    ConfigServerStorageSpaceGb int
    分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
    ConfigServers []InstanceConfigServerArgs
    ConfigServersId string
    ConfigServer 的 ID。
    CreatedTime string
    实例创建时间(UTC)。
    DbEngine string
    数据库引擎。取值固定为 MongoDB
    DbEngineVersion string
    数据库引擎版本,取值范围如下:MongoDB40(默认):MongoDB 4.0 版本。MongoDB42:MongoDB 4.2 版本。MongoDB44:MongoDB 4.4 版本。MongoDB50:MongoDB 5.0 版本。MongoDB60:MongoDB 6.0 版本。MongoDB70:MongoDB 7.0 版本。
    DbEngineVersionStr string
    数据库引擎版本的字符串。
    ExpiredTime string
    实例到期时间(UTC)。
    InstanceCount int
    需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
    InstanceId string
    实例 ID。
    InstanceName string
    实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
    InstanceStatus string
    实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
    InstanceType string
    MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
    Mongos []InstanceMongoArgs
    MongosId string
    Mongos 的 ID。
    MongosNodeNumber int
    分片集群中 Mongos 节点的数量。取值范围:2~32。
    MongosNodeSpec string
    分片集群中 Mongos 节点的规格码。
    NodeAvailabilityZones []InstanceNodeAvailabilityZoneArgs
    NodeNumber int
    节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
    NodeSpec string
    实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
    Nodes []InstanceNodeArgs
    Period int
    包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
    PeriodUnit string
    指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
    PrivateEndpoint string
    实例私网连接地址的字符串信息。
    ProjectName string
    选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
    ReadOnlyNodeNumber int
    实例的只读节点数量。
    ReclaimTime string
    实例的计划回收时间(UTC)。
    ShardNumber int
    分片集群中 Shard 分片的数量。取值范围:2~32。
    Shards []InstanceShardArgs
    StorageSpaceGb int
    副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
    StorageType string
    实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
    SubnetId string
    子网 ID。
    SuperAccountName string
    数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
    SuperAccountPassword string
    root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
    Tags []InstanceTagArgs
    UpdatedTime string
    实例的更新时间(UTC)。
    VpcId string
    私有网络 ID。
    ZoneId string
    实例所在可用区的 ID。
    allowListIds List<String>
    白名单 ID 列表。新建实例会被绑定到指定白名单。
    autoRenew Boolean
    是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
    chargeStatus String
    实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
    chargeType String
    实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
    closedTime String
    计划关停时间(UTC)。
    configServerNodeSpec String
    分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
    configServerStorageSpaceGb Integer
    分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
    configServers List<InstanceConfigServer>
    configServersId String
    ConfigServer 的 ID。
    createdTime String
    实例创建时间(UTC)。
    dbEngine String
    数据库引擎。取值固定为 MongoDB
    dbEngineVersion String
    数据库引擎版本,取值范围如下:MongoDB40(默认):MongoDB 4.0 版本。MongoDB42:MongoDB 4.2 版本。MongoDB44:MongoDB 4.4 版本。MongoDB50:MongoDB 5.0 版本。MongoDB60:MongoDB 6.0 版本。MongoDB70:MongoDB 7.0 版本。
    dbEngineVersionStr String
    数据库引擎版本的字符串。
    expiredTime String
    实例到期时间(UTC)。
    instanceCount Integer
    需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
    instanceId String
    实例 ID。
    instanceName String
    实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
    instanceStatus String
    实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
    instanceType String
    MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
    mongos List<InstanceMongo>
    mongosId String
    Mongos 的 ID。
    mongosNodeNumber Integer
    分片集群中 Mongos 节点的数量。取值范围:2~32。
    mongosNodeSpec String
    分片集群中 Mongos 节点的规格码。
    nodeAvailabilityZones List<InstanceNodeAvailabilityZone>
    nodeNumber Integer
    节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
    nodeSpec String
    实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
    nodes List<InstanceNode>
    period Integer
    包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
    periodUnit String
    指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
    privateEndpoint String
    实例私网连接地址的字符串信息。
    projectName String
    选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
    readOnlyNodeNumber Integer
    实例的只读节点数量。
    reclaimTime String
    实例的计划回收时间(UTC)。
    shardNumber Integer
    分片集群中 Shard 分片的数量。取值范围:2~32。
    shards List<InstanceShard>
    storageSpaceGb Integer
    副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
    storageType String
    实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
    subnetId String
    子网 ID。
    superAccountName String
    数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
    superAccountPassword String
    root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
    tags List<InstanceTag>
    updatedTime String
    实例的更新时间(UTC)。
    vpcId String
    私有网络 ID。
    zoneId String
    实例所在可用区的 ID。
    allowListIds string[]
    白名单 ID 列表。新建实例会被绑定到指定白名单。
    autoRenew boolean
    是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
    chargeStatus string
    实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
    chargeType string
    实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
    closedTime string
    计划关停时间(UTC)。
    configServerNodeSpec string
    分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
    configServerStorageSpaceGb number
    分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
    configServers InstanceConfigServer[]
    configServersId string
    ConfigServer 的 ID。
    createdTime string
    实例创建时间(UTC)。
    dbEngine string
    数据库引擎。取值固定为 MongoDB
    dbEngineVersion string
    数据库引擎版本,取值范围如下:MongoDB40(默认):MongoDB 4.0 版本。MongoDB42:MongoDB 4.2 版本。MongoDB44:MongoDB 4.4 版本。MongoDB50:MongoDB 5.0 版本。MongoDB60:MongoDB 6.0 版本。MongoDB70:MongoDB 7.0 版本。
    dbEngineVersionStr string
    数据库引擎版本的字符串。
    expiredTime string
    实例到期时间(UTC)。
    instanceCount number
    需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
    instanceId string
    实例 ID。
    instanceName string
    实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
    instanceStatus string
    实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
    instanceType string
    MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
    mongos InstanceMongo[]
    mongosId string
    Mongos 的 ID。
    mongosNodeNumber number
    分片集群中 Mongos 节点的数量。取值范围:2~32。
    mongosNodeSpec string
    分片集群中 Mongos 节点的规格码。
    nodeAvailabilityZones InstanceNodeAvailabilityZone[]
    nodeNumber number
    节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
    nodeSpec string
    实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
    nodes InstanceNode[]
    period number
    包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
    periodUnit string
    指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
    privateEndpoint string
    实例私网连接地址的字符串信息。
    projectName string
    选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
    readOnlyNodeNumber number
    实例的只读节点数量。
    reclaimTime string
    实例的计划回收时间(UTC)。
    shardNumber number
    分片集群中 Shard 分片的数量。取值范围:2~32。
    shards InstanceShard[]
    storageSpaceGb number
    副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
    storageType string
    实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
    subnetId string
    子网 ID。
    superAccountName string
    数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
    superAccountPassword string
    root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
    tags InstanceTag[]
    updatedTime string
    实例的更新时间(UTC)。
    vpcId string
    私有网络 ID。
    zoneId string
    实例所在可用区的 ID。
    allow_list_ids Sequence[str]
    白名单 ID 列表。新建实例会被绑定到指定白名单。
    auto_renew bool
    是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
    charge_status str
    实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
    charge_type str
    实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
    closed_time str
    计划关停时间(UTC)。
    config_server_node_spec str
    分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
    config_server_storage_space_gb int
    分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
    config_servers Sequence[InstanceConfigServerArgs]
    config_servers_id str
    ConfigServer 的 ID。
    created_time str
    实例创建时间(UTC)。
    db_engine str
    数据库引擎。取值固定为 MongoDB
    db_engine_version str
    数据库引擎版本,取值范围如下:MongoDB40(默认):MongoDB 4.0 版本。MongoDB42:MongoDB 4.2 版本。MongoDB44:MongoDB 4.4 版本。MongoDB50:MongoDB 5.0 版本。MongoDB60:MongoDB 6.0 版本。MongoDB70:MongoDB 7.0 版本。
    db_engine_version_str str
    数据库引擎版本的字符串。
    expired_time str
    实例到期时间(UTC)。
    instance_count int
    需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
    instance_id str
    实例 ID。
    instance_name str
    实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
    instance_status str
    实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
    instance_type str
    MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
    mongos Sequence[InstanceMongoArgs]
    mongos_id str
    Mongos 的 ID。
    mongos_node_number int
    分片集群中 Mongos 节点的数量。取值范围:2~32。
    mongos_node_spec str
    分片集群中 Mongos 节点的规格码。
    node_availability_zones Sequence[InstanceNodeAvailabilityZoneArgs]
    node_number int
    节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
    node_spec str
    实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
    nodes Sequence[InstanceNodeArgs]
    period int
    包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
    period_unit str
    指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
    private_endpoint str
    实例私网连接地址的字符串信息。
    project_name str
    选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
    read_only_node_number int
    实例的只读节点数量。
    reclaim_time str
    实例的计划回收时间(UTC)。
    shard_number int
    分片集群中 Shard 分片的数量。取值范围:2~32。
    shards Sequence[InstanceShardArgs]
    storage_space_gb int
    副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
    storage_type str
    实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
    subnet_id str
    子网 ID。
    super_account_name str
    数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
    super_account_password str
    root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
    tags Sequence[InstanceTagArgs]
    updated_time str
    实例的更新时间(UTC)。
    vpc_id str
    私有网络 ID。
    zone_id str
    实例所在可用区的 ID。
    allowListIds List<String>
    白名单 ID 列表。新建实例会被绑定到指定白名单。
    autoRenew Boolean
    是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
    chargeStatus String
    实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
    chargeType String
    实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
    closedTime String
    计划关停时间(UTC)。
    configServerNodeSpec String
    分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
    configServerStorageSpaceGb Number
    分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
    configServers List<Property Map>
    configServersId String
    ConfigServer 的 ID。
    createdTime String
    实例创建时间(UTC)。
    dbEngine String
    数据库引擎。取值固定为 MongoDB
    dbEngineVersion String
    数据库引擎版本,取值范围如下:MongoDB40(默认):MongoDB 4.0 版本。MongoDB42:MongoDB 4.2 版本。MongoDB44:MongoDB 4.4 版本。MongoDB50:MongoDB 5.0 版本。MongoDB60:MongoDB 6.0 版本。MongoDB70:MongoDB 7.0 版本。
    dbEngineVersionStr String
    数据库引擎版本的字符串。
    expiredTime String
    实例到期时间(UTC)。
    instanceCount Number
    需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
    instanceId String
    实例 ID。
    instanceName String
    实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
    instanceStatus String
    实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
    instanceType String
    MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
    mongos List<Property Map>
    mongosId String
    Mongos 的 ID。
    mongosNodeNumber Number
    分片集群中 Mongos 节点的数量。取值范围:2~32。
    mongosNodeSpec String
    分片集群中 Mongos 节点的规格码。
    nodeAvailabilityZones List<Property Map>
    nodeNumber Number
    节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
    nodeSpec String
    实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
    nodes List<Property Map>
    period Number
    包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
    periodUnit String
    指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
    privateEndpoint String
    实例私网连接地址的字符串信息。
    projectName String
    选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
    readOnlyNodeNumber Number
    实例的只读节点数量。
    reclaimTime String
    实例的计划回收时间(UTC)。
    shardNumber Number
    分片集群中 Shard 分片的数量。取值范围:2~32。
    shards List<Property Map>
    storageSpaceGb Number
    副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
    storageType String
    实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
    subnetId String
    子网 ID。
    superAccountName String
    数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
    superAccountPassword String
    root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
    tags List<Property Map>
    updatedTime String
    实例的更新时间(UTC)。
    vpcId String
    私有网络 ID。
    zoneId String
    实例所在可用区的 ID。

    Supporting Types

    InstanceConfigServer, InstanceConfigServerArgs

    ConfigServerNodeId string
    ConfigServer 的节点 ID。
    NodeRole string
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。
    NodeStatus string
    节点状态。
    TotalMemoryGb double
    总内存。单位:GiB。
    TotalvCpu double
    总核数。
    UsedMemoryGb double
    已用内存。单位:GiB。
    UsedvCpu double
    已用核数。
    ZoneId string
    当前节点所属的可用区 ID。
    ConfigServerNodeId string
    ConfigServer 的节点 ID。
    NodeRole string
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。
    NodeStatus string
    节点状态。
    TotalMemoryGb float64
    总内存。单位:GiB。
    TotalvCpu float64
    总核数。
    UsedMemoryGb float64
    已用内存。单位:GiB。
    UsedvCpu float64
    已用核数。
    ZoneId string
    当前节点所属的可用区 ID。
    configServerNodeId String
    ConfigServer 的节点 ID。
    nodeRole String
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。
    nodeStatus String
    节点状态。
    totalMemoryGb Double
    总内存。单位:GiB。
    totalvCpu Double
    总核数。
    usedMemoryGb Double
    已用内存。单位:GiB。
    usedvCpu Double
    已用核数。
    zoneId String
    当前节点所属的可用区 ID。
    configServerNodeId string
    ConfigServer 的节点 ID。
    nodeRole string
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。
    nodeStatus string
    节点状态。
    totalMemoryGb number
    总内存。单位:GiB。
    totalvCpu number
    总核数。
    usedMemoryGb number
    已用内存。单位:GiB。
    usedvCpu number
    已用核数。
    zoneId string
    当前节点所属的可用区 ID。
    config_server_node_id str
    ConfigServer 的节点 ID。
    node_role str
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。
    node_status str
    节点状态。
    total_memory_gb float
    总内存。单位:GiB。
    totalv_cpu float
    总核数。
    used_memory_gb float
    已用内存。单位:GiB。
    usedv_cpu float
    已用核数。
    zone_id str
    当前节点所属的可用区 ID。
    configServerNodeId String
    ConfigServer 的节点 ID。
    nodeRole String
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。
    nodeStatus String
    节点状态。
    totalMemoryGb Number
    总内存。单位:GiB。
    totalvCpu Number
    总核数。
    usedMemoryGb Number
    已用内存。单位:GiB。
    usedvCpu Number
    已用核数。
    zoneId String
    当前节点所属的可用区 ID。

    InstanceMongo, InstanceMongoArgs

    MongosNodeId string
    Mongos 的节点 ID。
    NodeSpec string
    节点规格。
    NodeStatus string
    节点状态。
    TotalMemoryGb double
    总内存。单位:GiB。
    TotalvCpu double
    总核数。
    UsedMemoryGb double
    已用内存。单位:GiB。
    UsedvCpu double
    已用核数。
    ZoneId string
    当前节点所属的可用区 ID。
    MongosNodeId string
    Mongos 的节点 ID。
    NodeSpec string
    节点规格。
    NodeStatus string
    节点状态。
    TotalMemoryGb float64
    总内存。单位:GiB。
    TotalvCpu float64
    总核数。
    UsedMemoryGb float64
    已用内存。单位:GiB。
    UsedvCpu float64
    已用核数。
    ZoneId string
    当前节点所属的可用区 ID。
    mongosNodeId String
    Mongos 的节点 ID。
    nodeSpec String
    节点规格。
    nodeStatus String
    节点状态。
    totalMemoryGb Double
    总内存。单位:GiB。
    totalvCpu Double
    总核数。
    usedMemoryGb Double
    已用内存。单位:GiB。
    usedvCpu Double
    已用核数。
    zoneId String
    当前节点所属的可用区 ID。
    mongosNodeId string
    Mongos 的节点 ID。
    nodeSpec string
    节点规格。
    nodeStatus string
    节点状态。
    totalMemoryGb number
    总内存。单位:GiB。
    totalvCpu number
    总核数。
    usedMemoryGb number
    已用内存。单位:GiB。
    usedvCpu number
    已用核数。
    zoneId string
    当前节点所属的可用区 ID。
    mongos_node_id str
    Mongos 的节点 ID。
    node_spec str
    节点规格。
    node_status str
    节点状态。
    total_memory_gb float
    总内存。单位:GiB。
    totalv_cpu float
    总核数。
    used_memory_gb float
    已用内存。单位:GiB。
    usedv_cpu float
    已用核数。
    zone_id str
    当前节点所属的可用区 ID。
    mongosNodeId String
    Mongos 的节点 ID。
    nodeSpec String
    节点规格。
    nodeStatus String
    节点状态。
    totalMemoryGb Number
    总内存。单位:GiB。
    totalvCpu Number
    总核数。
    usedMemoryGb Number
    已用内存。单位:GiB。
    usedvCpu Number
    已用核数。
    zoneId String
    当前节点所属的可用区 ID。

    InstanceNode, InstanceNodeArgs

    NodeDelayTime int
    节点延迟时间。单位:秒。
    NodeId string
    节点 ID。
    NodeRole string
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
    NodeSpec string
    节点规格。
    NodeStatus string
    节点状态。
    TotalMemoryGb double
    总内存。单位:GiB。
    TotalStorageGb double
    该节点的总存储空间。单位:GiB。
    TotalvCpu double
    总核数。
    UsedMemoryGb double
    已用内存。单位:GiB。
    UsedStorageGb double
    该节点已用的存储空间。单位:GiB。
    UsedvCpu double
    已用核数。
    ZoneId string
    当前节点所属的可用区 ID。
    NodeDelayTime int
    节点延迟时间。单位:秒。
    NodeId string
    节点 ID。
    NodeRole string
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
    NodeSpec string
    节点规格。
    NodeStatus string
    节点状态。
    TotalMemoryGb float64
    总内存。单位:GiB。
    TotalStorageGb float64
    该节点的总存储空间。单位:GiB。
    TotalvCpu float64
    总核数。
    UsedMemoryGb float64
    已用内存。单位:GiB。
    UsedStorageGb float64
    该节点已用的存储空间。单位:GiB。
    UsedvCpu float64
    已用核数。
    ZoneId string
    当前节点所属的可用区 ID。
    nodeDelayTime Integer
    节点延迟时间。单位:秒。
    nodeId String
    节点 ID。
    nodeRole String
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
    nodeSpec String
    节点规格。
    nodeStatus String
    节点状态。
    totalMemoryGb Double
    总内存。单位:GiB。
    totalStorageGb Double
    该节点的总存储空间。单位:GiB。
    totalvCpu Double
    总核数。
    usedMemoryGb Double
    已用内存。单位:GiB。
    usedStorageGb Double
    该节点已用的存储空间。单位:GiB。
    usedvCpu Double
    已用核数。
    zoneId String
    当前节点所属的可用区 ID。
    nodeDelayTime number
    节点延迟时间。单位:秒。
    nodeId string
    节点 ID。
    nodeRole string
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
    nodeSpec string
    节点规格。
    nodeStatus string
    节点状态。
    totalMemoryGb number
    总内存。单位:GiB。
    totalStorageGb number
    该节点的总存储空间。单位:GiB。
    totalvCpu number
    总核数。
    usedMemoryGb number
    已用内存。单位:GiB。
    usedStorageGb number
    该节点已用的存储空间。单位:GiB。
    usedvCpu number
    已用核数。
    zoneId string
    当前节点所属的可用区 ID。
    node_delay_time int
    节点延迟时间。单位:秒。
    node_id str
    节点 ID。
    node_role str
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
    node_spec str
    节点规格。
    node_status str
    节点状态。
    total_memory_gb float
    总内存。单位:GiB。
    total_storage_gb float
    该节点的总存储空间。单位:GiB。
    totalv_cpu float
    总核数。
    used_memory_gb float
    已用内存。单位:GiB。
    used_storage_gb float
    该节点已用的存储空间。单位:GiB。
    usedv_cpu float
    已用核数。
    zone_id str
    当前节点所属的可用区 ID。
    nodeDelayTime Number
    节点延迟时间。单位:秒。
    nodeId String
    节点 ID。
    nodeRole String
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
    nodeSpec String
    节点规格。
    nodeStatus String
    节点状态。
    totalMemoryGb Number
    总内存。单位:GiB。
    totalStorageGb Number
    该节点的总存储空间。单位:GiB。
    totalvCpu Number
    总核数。
    usedMemoryGb Number
    已用内存。单位:GiB。
    usedStorageGb Number
    该节点已用的存储空间。单位:GiB。
    usedvCpu Number
    已用核数。
    zoneId String
    当前节点所属的可用区 ID。

    InstanceNodeAvailabilityZone, InstanceNodeAvailabilityZoneArgs

    NodeNumber int
    当前可用区中需要添加的只读节点数量。当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
    ZoneId string
    只读节点所在的可用区。
    NodeNumber int
    当前可用区中需要添加的只读节点数量。当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
    ZoneId string
    只读节点所在的可用区。
    nodeNumber Integer
    当前可用区中需要添加的只读节点数量。当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
    zoneId String
    只读节点所在的可用区。
    nodeNumber number
    当前可用区中需要添加的只读节点数量。当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
    zoneId string
    只读节点所在的可用区。
    node_number int
    当前可用区中需要添加的只读节点数量。当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
    zone_id str
    只读节点所在的可用区。
    nodeNumber Number
    当前可用区中需要添加的只读节点数量。当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
    zoneId String
    只读节点所在的可用区。

    InstanceShard, InstanceShardArgs

    Nodes []InstanceShardNode
    ShardId string
    Shard 节点的 ID。
    nodes List<InstanceShardNode>
    shardId String
    Shard 节点的 ID。
    nodes InstanceShardNode[]
    shardId string
    Shard 节点的 ID。
    nodes List<Property Map>
    shardId String
    Shard 节点的 ID。

    InstanceShardNode, InstanceShardNodeArgs

    NodeDelayTime int
    节点延迟时间。单位:秒。
    NodeId string
    节点 ID。
    NodeRole string
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
    NodeSpec string
    节点规格。
    NodeStatus string
    节点状态。
    TotalMemoryGb double
    总内存。单位:GiB。
    TotalStorageGb double
    该节点的总存储空间。单位:GiB。
    TotalvCpu double
    总核数。
    UsedMemoryGb double
    已用内存。单位:GiB。
    UsedStorageGb double
    该节点已用的存储空间。单位:GiB。
    UsedvCpu double
    已用核数。
    ZoneId string
    当前节点所属的可用区 ID。
    NodeDelayTime int
    节点延迟时间。单位:秒。
    NodeId string
    节点 ID。
    NodeRole string
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
    NodeSpec string
    节点规格。
    NodeStatus string
    节点状态。
    TotalMemoryGb float64
    总内存。单位:GiB。
    TotalStorageGb float64
    该节点的总存储空间。单位:GiB。
    TotalvCpu float64
    总核数。
    UsedMemoryGb float64
    已用内存。单位:GiB。
    UsedStorageGb float64
    该节点已用的存储空间。单位:GiB。
    UsedvCpu float64
    已用核数。
    ZoneId string
    当前节点所属的可用区 ID。
    nodeDelayTime Integer
    节点延迟时间。单位:秒。
    nodeId String
    节点 ID。
    nodeRole String
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
    nodeSpec String
    节点规格。
    nodeStatus String
    节点状态。
    totalMemoryGb Double
    总内存。单位:GiB。
    totalStorageGb Double
    该节点的总存储空间。单位:GiB。
    totalvCpu Double
    总核数。
    usedMemoryGb Double
    已用内存。单位:GiB。
    usedStorageGb Double
    该节点已用的存储空间。单位:GiB。
    usedvCpu Double
    已用核数。
    zoneId String
    当前节点所属的可用区 ID。
    nodeDelayTime number
    节点延迟时间。单位:秒。
    nodeId string
    节点 ID。
    nodeRole string
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
    nodeSpec string
    节点规格。
    nodeStatus string
    节点状态。
    totalMemoryGb number
    总内存。单位:GiB。
    totalStorageGb number
    该节点的总存储空间。单位:GiB。
    totalvCpu number
    总核数。
    usedMemoryGb number
    已用内存。单位:GiB。
    usedStorageGb number
    该节点已用的存储空间。单位:GiB。
    usedvCpu number
    已用核数。
    zoneId string
    当前节点所属的可用区 ID。
    node_delay_time int
    节点延迟时间。单位:秒。
    node_id str
    节点 ID。
    node_role str
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
    node_spec str
    节点规格。
    node_status str
    节点状态。
    total_memory_gb float
    总内存。单位:GiB。
    total_storage_gb float
    该节点的总存储空间。单位:GiB。
    totalv_cpu float
    总核数。
    used_memory_gb float
    已用内存。单位:GiB。
    used_storage_gb float
    该节点已用的存储空间。单位:GiB。
    usedv_cpu float
    已用核数。
    zone_id str
    当前节点所属的可用区 ID。
    nodeDelayTime Number
    节点延迟时间。单位:秒。
    nodeId String
    节点 ID。
    nodeRole String
    节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
    nodeSpec String
    节点规格。
    nodeStatus String
    节点状态。
    totalMemoryGb Number
    总内存。单位:GiB。
    totalStorageGb Number
    该节点的总存储空间。单位:GiB。
    totalvCpu Number
    总核数。
    usedMemoryGb Number
    已用内存。单位:GiB。
    usedStorageGb Number
    该节点已用的存储空间。单位:GiB。
    usedvCpu Number
    已用核数。
    zoneId String
    当前节点所属的可用区 ID。

    InstanceTag, InstanceTagArgs

    Key string
    标签键。
    Value string
    标签值。
    Key string
    标签键。
    Value string
    标签值。
    key String
    标签键。
    value String
    标签值。
    key string
    标签键。
    value string
    标签值。
    key str
    标签键。
    value str
    标签值。
    key String
    标签键。
    value String
    标签值。

    Import

    $ pulumi import volcenginecc:mongodb/instance:Instance example "instance_id"
    

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    volcenginecc v0.0.20 published on Thursday, Jan 22, 2026 by Volcengine
      Meet Neo: Your AI Platform Teammate