volcengine.mongodb.getInstances

Volcengine v0.0.38, Oct 31 25

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Example Usage

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

const foo = volcengine.mongodb.getInstances({
    instanceId: "mongo-replica-xxx",
});

import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.mongodb.get_instances(instance_id="mongo-replica-xxx")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/mongodb"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodb.GetInstances(ctx, &mongodb.GetInstancesArgs{
			InstanceId: pulumi.StringRef("mongo-replica-xxx"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Mongodb.GetInstances.Invoke(new()
    {
        InstanceId = "mongo-replica-xxx",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.mongodb.MongodbFunctions;
import com.pulumi.volcengine.mongodb.inputs.GetInstancesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var foo = MongodbFunctions.getInstances(GetInstancesArgs.builder()
            .instanceId("mongo-replica-xxx")
            .build());

    }
}

variables:
  foo:
    fn::invoke:
      Function: volcengine:mongodb:getInstances
      Arguments:
        instanceId: mongo-replica-xxx

Using getInstances

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
function getInstancesOutput(args: GetInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancesResult>

def get_instances(create_end_time: Optional[str] = None,
                  create_start_time: Optional[str] = None,
                  db_engine: Optional[str] = None,
                  db_engine_version: Optional[str] = None,
                  instance_id: Optional[str] = None,
                  instance_name: Optional[str] = None,
                  instance_status: Optional[str] = None,
                  instance_type: Optional[str] = None,
                  name_regex: Optional[str] = None,
                  output_file: Optional[str] = None,
                  project_name: Optional[str] = None,
                  tags: Optional[Sequence[GetInstancesTag]] = None,
                  update_end_time: Optional[str] = None,
                  update_start_time: Optional[str] = None,
                  vpc_id: Optional[str] = None,
                  zone_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetInstancesResult
def get_instances_output(create_end_time: Optional[pulumi.Input[str]] = None,
                  create_start_time: Optional[pulumi.Input[str]] = None,
                  db_engine: Optional[pulumi.Input[str]] = None,
                  db_engine_version: Optional[pulumi.Input[str]] = None,
                  instance_id: Optional[pulumi.Input[str]] = None,
                  instance_name: Optional[pulumi.Input[str]] = None,
                  instance_status: Optional[pulumi.Input[str]] = None,
                  instance_type: Optional[pulumi.Input[str]] = None,
                  name_regex: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  project_name: Optional[pulumi.Input[str]] = None,
                  tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetInstancesTagArgs]]]] = None,
                  update_end_time: Optional[pulumi.Input[str]] = None,
                  update_start_time: Optional[pulumi.Input[str]] = None,
                  vpc_id: Optional[pulumi.Input[str]] = None,
                  zone_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]

func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput

> Note: This function is named GetInstances in the Go SDK.

public static class GetInstances 
{
    public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetInstancesResult> Invoke(GetInstancesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
public static Output<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)

fn::invoke:
  function: volcengine:mongodb/getInstances:getInstances
  arguments:
    # arguments dictionary

The following arguments are supported:

CreateEndTime string: The end time of creation to query.
CreateStartTime string: The start time of creation to query.
DbEngine string: The db engine to query, valid value contains MongoDB.
DbEngineVersion string: The version of db engine to query, valid value contains MongoDB_4_0.
InstanceId string: The instance ID to query.
InstanceName string: The instance name to query.
InstanceStatus string: The instance status to query.
InstanceType string: The type of instance to query, the valid value contains ReplicaSet or ShardedCluster.
NameRegex string: A Name Regex of DB instance.
OutputFile string: File name where to save data source results.
ProjectName string: The project name to query.
Tags List<GetInstancesTag>: Tags.
UpdateEndTime string: The end time of update to query.
UpdateStartTime string: The start time of update to query.
VpcId string: The vpc id of instance to query.
ZoneId string: The zone ID to query.

CreateEndTime string: The end time of creation to query.
CreateStartTime string: The start time of creation to query.
DbEngine string: The db engine to query, valid value contains MongoDB.
DbEngineVersion string: The version of db engine to query, valid value contains MongoDB_4_0.
InstanceId string: The instance ID to query.
InstanceName string: The instance name to query.
InstanceStatus string: The instance status to query.
InstanceType string: The type of instance to query, the valid value contains ReplicaSet or ShardedCluster.
NameRegex string: A Name Regex of DB instance.
OutputFile string: File name where to save data source results.
ProjectName string: The project name to query.
Tags []GetInstancesTag: Tags.
UpdateEndTime string: The end time of update to query.
UpdateStartTime string: The start time of update to query.
VpcId string: The vpc id of instance to query.
ZoneId string: The zone ID to query.

createEndTime String: The end time of creation to query.
createStartTime String: The start time of creation to query.
dbEngine String: The db engine to query, valid value contains MongoDB.
dbEngineVersion String: The version of db engine to query, valid value contains MongoDB_4_0.
instanceId String: The instance ID to query.
instanceName String: The instance name to query.
instanceStatus String: The instance status to query.
instanceType String: The type of instance to query, the valid value contains ReplicaSet or ShardedCluster.
nameRegex String: A Name Regex of DB instance.
outputFile String: File name where to save data source results.
projectName String: The project name to query.
tags List<GetInstancesTag>: Tags.
updateEndTime String: The end time of update to query.
updateStartTime String: The start time of update to query.
vpcId String: The vpc id of instance to query.
zoneId String: The zone ID to query.

createEndTime string: The end time of creation to query.
createStartTime string: The start time of creation to query.
dbEngine string: The db engine to query, valid value contains MongoDB.
dbEngineVersion string: The version of db engine to query, valid value contains MongoDB_4_0.
instanceId string: The instance ID to query.
instanceName string: The instance name to query.
instanceStatus string: The instance status to query.
instanceType string: The type of instance to query, the valid value contains ReplicaSet or ShardedCluster.
nameRegex string: A Name Regex of DB instance.
outputFile string: File name where to save data source results.
projectName string: The project name to query.
tags GetInstancesTag[]: Tags.
updateEndTime string: The end time of update to query.
updateStartTime string: The start time of update to query.
vpcId string: The vpc id of instance to query.
zoneId string: The zone ID to query.

create_end_time str: The end time of creation to query.
create_start_time str: The start time of creation to query.
db_engine str: The db engine to query, valid value contains MongoDB.
db_engine_version str: The version of db engine to query, valid value contains MongoDB_4_0.
instance_id str: The instance ID to query.
instance_name str: The instance name to query.
instance_status str: The instance status to query.
instance_type str: The type of instance to query, the valid value contains ReplicaSet or ShardedCluster.
name_regex str: A Name Regex of DB instance.
output_file str: File name where to save data source results.
project_name str: The project name to query.
tags Sequence[GetInstancesTag]: Tags.
update_end_time str: The end time of update to query.
update_start_time str: The start time of update to query.
vpc_id str: The vpc id of instance to query.
zone_id str: The zone ID to query.

createEndTime String: The end time of creation to query.
createStartTime String: The start time of creation to query.
dbEngine String: The db engine to query, valid value contains MongoDB.
dbEngineVersion String: The version of db engine to query, valid value contains MongoDB_4_0.
instanceId String: The instance ID to query.
instanceName String: The instance name to query.
instanceStatus String: The instance status to query.
instanceType String: The type of instance to query, the valid value contains ReplicaSet or ShardedCluster.
nameRegex String: A Name Regex of DB instance.
outputFile String: File name where to save data source results.
projectName String: The project name to query.
tags List<Property Map>: Tags.
updateEndTime String: The end time of update to query.
updateStartTime String: The start time of update to query.
vpcId String: The vpc id of instance to query.
zoneId String: The zone ID to query.

getInstances Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Instances List<GetInstancesInstance>: The collection of mongodb instances query.
TotalCount int: The total count of mongodb instances query.
CreateEndTime string
CreateStartTime string
DbEngine string: The db engine.
DbEngineVersion string: The version of database engine.
InstanceId string: The instance ID.
InstanceName string: The instance name.
InstanceStatus string: The instance status.
InstanceType string: The instance type.
NameRegex string
OutputFile string
ProjectName string: The project name to which the instance belongs.
Tags List<GetInstancesTag>: Tags.
UpdateEndTime string
UpdateStartTime string
VpcId string: The vpc ID.
ZoneId string: The zone ID of instance.

Id string: The provider-assigned unique ID for this managed resource.
Instances []GetInstancesInstance: The collection of mongodb instances query.
TotalCount int: The total count of mongodb instances query.
CreateEndTime string
CreateStartTime string
DbEngine string: The db engine.
DbEngineVersion string: The version of database engine.
InstanceId string: The instance ID.
InstanceName string: The instance name.
InstanceStatus string: The instance status.
InstanceType string: The instance type.
NameRegex string
OutputFile string
ProjectName string: The project name to which the instance belongs.
Tags []GetInstancesTag: Tags.
UpdateEndTime string
UpdateStartTime string
VpcId string: The vpc ID.
ZoneId string: The zone ID of instance.

id String: The provider-assigned unique ID for this managed resource.
instances List<GetInstancesInstance>: The collection of mongodb instances query.
totalCount Integer: The total count of mongodb instances query.
createEndTime String
createStartTime String
dbEngine String: The db engine.
dbEngineVersion String: The version of database engine.
instanceId String: The instance ID.
instanceName String: The instance name.
instanceStatus String: The instance status.
instanceType String: The instance type.
nameRegex String
outputFile String
projectName String: The project name to which the instance belongs.
tags List<GetInstancesTag>: Tags.
updateEndTime String
updateStartTime String
vpcId String: The vpc ID.
zoneId String: The zone ID of instance.

id string: The provider-assigned unique ID for this managed resource.
instances GetInstancesInstance[]: The collection of mongodb instances query.
totalCount number: The total count of mongodb instances query.
createEndTime string
createStartTime string
dbEngine string: The db engine.
dbEngineVersion string: The version of database engine.
instanceId string: The instance ID.
instanceName string: The instance name.
instanceStatus string: The instance status.
instanceType string: The instance type.
nameRegex string
outputFile string
projectName string: The project name to which the instance belongs.
tags GetInstancesTag[]: Tags.
updateEndTime string
updateStartTime string
vpcId string: The vpc ID.
zoneId string: The zone ID of instance.

id str: The provider-assigned unique ID for this managed resource.
instances Sequence[GetInstancesInstance]: The collection of mongodb instances query.
total_count int: The total count of mongodb instances query.
create_end_time str
create_start_time str
db_engine str: The db engine.
db_engine_version str: The version of database engine.
instance_id str: The instance ID.
instance_name str: The instance name.
instance_status str: The instance status.
instance_type str: The instance type.
name_regex str
output_file str
project_name str: The project name to which the instance belongs.
tags Sequence[GetInstancesTag]: Tags.
update_end_time str
update_start_time str
vpc_id str: The vpc ID.
zone_id str: The zone ID of instance.

id String: The provider-assigned unique ID for this managed resource.
instances List<Property Map>: The collection of mongodb instances query.
totalCount Number: The total count of mongodb instances query.
createEndTime String
createStartTime String
dbEngine String: The db engine.
dbEngineVersion String: The version of database engine.
instanceId String: The instance ID.
instanceName String: The instance name.
instanceStatus String: The instance status.
instanceType String: The instance type.
nameRegex String
outputFile String
projectName String: The project name to which the instance belongs.
tags List<Property Map>: Tags.
updateEndTime String
updateStartTime String
vpcId String: The vpc ID.
zoneId String: The zone ID of instance.

Supporting Types

GetInstancesInstance

AutoRenew bool: Whether to enable automatic renewal.
ChargeStatus string: The charge status.
ChargeType string: The charge type of instance.
ClosedTime string: The planned close time.
ConfigServers List<GetInstancesInstanceConfigServer>: The list of config servers.
ConfigServersId string: The ID of config servers.
CreateTime string: The creation time of instance.
DbEngine string: The db engine to query, valid value contains MongoDB.
DbEngineVersion string: The version of db engine to query, valid value contains MongoDB_4_0.
DbEngineVersionStr string: The version string of database engine.
ExpiredTime string: The expired time of instance.
InstanceId string: The instance ID to query.
InstanceName string: The instance name to query.
InstanceStatus string: The instance status to query.
InstanceType string: The type of instance to query, the valid value contains ReplicaSet or ShardedCluster.
Mongos List<GetInstancesInstanceMongo>: The list of mongos.
MongosId string: The ID of mongos.
Nodes List<GetInstancesInstanceNode>: The node information.
PrivateEndpoint string: The private endpoint address of instance.
ProjectName string: The project name to query.
ReadOnlyNodeNumber int: The number of readonly node in instance.
ReclaimTime string: The planned reclaim time of instance.
Shards List<GetInstancesInstanceShard>: The list of shards.
SslEnable bool: Whether ssl enabled.
SslExpireTime string: The ssl expire time.
SslIsValid bool: Whether ssl is valid.
StorageType string: The storage type of instance.
SubnetId string: The subnet id of instance.
Tags List<GetInstancesInstanceTag>: Tags.
UpdateTime string: The update time of instance.
VpcId string: The vpc id of instance to query.
ZoneId string: The zone ID to query.

AutoRenew bool: Whether to enable automatic renewal.
ChargeStatus string: The charge status.
ChargeType string: The charge type of instance.
ClosedTime string: The planned close time.
ConfigServers []GetInstancesInstanceConfigServer: The list of config servers.
ConfigServersId string: The ID of config servers.
CreateTime string: The creation time of instance.
DbEngine string: The db engine to query, valid value contains MongoDB.
DbEngineVersion string: The version of db engine to query, valid value contains MongoDB_4_0.
DbEngineVersionStr string: The version string of database engine.
ExpiredTime string: The expired time of instance.
InstanceId string: The instance ID to query.
InstanceName string: The instance name to query.
InstanceStatus string: The instance status to query.
InstanceType string: The type of instance to query, the valid value contains ReplicaSet or ShardedCluster.
Mongos []GetInstancesInstanceMongo: The list of mongos.
MongosId string: The ID of mongos.
Nodes []GetInstancesInstanceNode: The node information.
PrivateEndpoint string: The private endpoint address of instance.
ProjectName string: The project name to query.
ReadOnlyNodeNumber int: The number of readonly node in instance.
ReclaimTime string: The planned reclaim time of instance.
Shards []GetInstancesInstanceShard: The list of shards.
SslEnable bool: Whether ssl enabled.
SslExpireTime string: The ssl expire time.
SslIsValid bool: Whether ssl is valid.
StorageType string: The storage type of instance.
SubnetId string: The subnet id of instance.
Tags []GetInstancesInstanceTag: Tags.
UpdateTime string: The update time of instance.
VpcId string: The vpc id of instance to query.
ZoneId string: The zone ID to query.

autoRenew Boolean: Whether to enable automatic renewal.
chargeStatus String: The charge status.
chargeType String: The charge type of instance.
closedTime String: The planned close time.
configServers List<GetInstancesInstanceConfigServer>: The list of config servers.
configServersId String: The ID of config servers.
createTime String: The creation time of instance.
dbEngine String: The db engine to query, valid value contains MongoDB.
dbEngineVersion String: The version of db engine to query, valid value contains MongoDB_4_0.
dbEngineVersionStr String: The version string of database engine.
expiredTime String: The expired time of instance.
instanceId String: The instance ID to query.
instanceName String: The instance name to query.
instanceStatus String: The instance status to query.
instanceType String: The type of instance to query, the valid value contains ReplicaSet or ShardedCluster.
mongos List<GetInstancesInstanceMongo>: The list of mongos.
mongosId String: The ID of mongos.
nodes List<GetInstancesInstanceNode>: The node information.
privateEndpoint String: The private endpoint address of instance.
projectName String: The project name to query.
readOnlyNodeNumber Integer: The number of readonly node in instance.
reclaimTime String: The planned reclaim time of instance.
shards List<GetInstancesInstanceShard>: The list of shards.
sslEnable Boolean: Whether ssl enabled.
sslExpireTime String: The ssl expire time.
sslIsValid Boolean: Whether ssl is valid.
storageType String: The storage type of instance.
subnetId String: The subnet id of instance.
tags List<GetInstancesInstanceTag>: Tags.
updateTime String: The update time of instance.
vpcId String: The vpc id of instance to query.
zoneId String: The zone ID to query.

autoRenew boolean: Whether to enable automatic renewal.
chargeStatus string: The charge status.
chargeType string: The charge type of instance.
closedTime string: The planned close time.
configServers GetInstancesInstanceConfigServer[]: The list of config servers.
configServersId string: The ID of config servers.
createTime string: The creation time of instance.
dbEngine string: The db engine to query, valid value contains MongoDB.
dbEngineVersion string: The version of db engine to query, valid value contains MongoDB_4_0.
dbEngineVersionStr string: The version string of database engine.
expiredTime string: The expired time of instance.
instanceId string: The instance ID to query.
instanceName string: The instance name to query.
instanceStatus string: The instance status to query.
instanceType string: The type of instance to query, the valid value contains ReplicaSet or ShardedCluster.
mongos GetInstancesInstanceMongo[]: The list of mongos.
mongosId string: The ID of mongos.
nodes GetInstancesInstanceNode[]: The node information.
privateEndpoint string: The private endpoint address of instance.
projectName string: The project name to query.
readOnlyNodeNumber number: The number of readonly node in instance.
reclaimTime string: The planned reclaim time of instance.
shards GetInstancesInstanceShard[]: The list of shards.
sslEnable boolean: Whether ssl enabled.
sslExpireTime string: The ssl expire time.
sslIsValid boolean: Whether ssl is valid.
storageType string: The storage type of instance.
subnetId string: The subnet id of instance.
tags GetInstancesInstanceTag[]: Tags.
updateTime string: The update time of instance.
vpcId string: The vpc id of instance to query.
zoneId string: The zone ID to query.

auto_renew bool: Whether to enable automatic renewal.
charge_status str: The charge status.
charge_type str: The charge type of instance.
closed_time str: The planned close time.
config_servers Sequence[GetInstancesInstanceConfigServer]: The list of config servers.
config_servers_id str: The ID of config servers.
create_time str: The creation time of instance.
db_engine str: The db engine to query, valid value contains MongoDB.
db_engine_version str: The version of db engine to query, valid value contains MongoDB_4_0.
db_engine_version_str str: The version string of database engine.
expired_time str: The expired time of instance.
instance_id str: The instance ID to query.
instance_name str: The instance name to query.
instance_status str: The instance status to query.
instance_type str: The type of instance to query, the valid value contains ReplicaSet or ShardedCluster.
mongos Sequence[GetInstancesInstanceMongo]: The list of mongos.
mongos_id str: The ID of mongos.
nodes Sequence[GetInstancesInstanceNode]: The node information.
private_endpoint str: The private endpoint address of instance.
project_name str: The project name to query.
read_only_node_number int: The number of readonly node in instance.
reclaim_time str: The planned reclaim time of instance.
shards Sequence[GetInstancesInstanceShard]: The list of shards.
ssl_enable bool: Whether ssl enabled.
ssl_expire_time str: The ssl expire time.
ssl_is_valid bool: Whether ssl is valid.
storage_type str: The storage type of instance.
subnet_id str: The subnet id of instance.
tags Sequence[GetInstancesInstanceTag]: Tags.
update_time str: The update time of instance.
vpc_id str: The vpc id of instance to query.
zone_id str: The zone ID to query.

autoRenew Boolean: Whether to enable automatic renewal.
chargeStatus String: The charge status.
chargeType String: The charge type of instance.
closedTime String: The planned close time.
configServers List<Property Map>: The list of config servers.
configServersId String: The ID of config servers.
createTime String: The creation time of instance.
dbEngine String: The db engine to query, valid value contains MongoDB.
dbEngineVersion String: The version of db engine to query, valid value contains MongoDB_4_0.
dbEngineVersionStr String: The version string of database engine.
expiredTime String: The expired time of instance.
instanceId String: The instance ID to query.
instanceName String: The instance name to query.
instanceStatus String: The instance status to query.
instanceType String: The type of instance to query, the valid value contains ReplicaSet or ShardedCluster.
mongos List<Property Map>: The list of mongos.
mongosId String: The ID of mongos.
nodes List<Property Map>: The node information.
privateEndpoint String: The private endpoint address of instance.
projectName String: The project name to query.
readOnlyNodeNumber Number: The number of readonly node in instance.
reclaimTime String: The planned reclaim time of instance.
shards List<Property Map>: The list of shards.
sslEnable Boolean: Whether ssl enabled.
sslExpireTime String: The ssl expire time.
sslIsValid Boolean: Whether ssl is valid.
storageType String: The storage type of instance.
subnetId String: The subnet id of instance.
tags List<Property Map>: Tags.
updateTime String: The update time of instance.
vpcId String: The vpc id of instance to query.
zoneId String: The zone ID to query.

GetInstancesInstanceConfigServer

ConfigServerNodeId string: The config server node ID.
NodeRole string: The nod role.
NodeStatus string: The node status.
TotalMemoryGb double: The total memory in GB.
TotalVcpu double: The total vCPU.
UsedMemoryGb double: The used memory in GB.
UsedVcpu double: The used vCPU.
ZoneId string: The zone ID to query.

ConfigServerNodeId string: The config server node ID.
NodeRole string: The nod role.
NodeStatus string: The node status.
TotalMemoryGb float64: The total memory in GB.
TotalVcpu float64: The total vCPU.
UsedMemoryGb float64: The used memory in GB.
UsedVcpu float64: The used vCPU.
ZoneId string: The zone ID to query.

configServerNodeId String: The config server node ID.
nodeRole String: The nod role.
nodeStatus String: The node status.
totalMemoryGb Double: The total memory in GB.
totalVcpu Double: The total vCPU.
usedMemoryGb Double: The used memory in GB.
usedVcpu Double: The used vCPU.
zoneId String: The zone ID to query.

configServerNodeId string: The config server node ID.
nodeRole string: The nod role.
nodeStatus string: The node status.
totalMemoryGb number: The total memory in GB.
totalVcpu number: The total vCPU.
usedMemoryGb number: The used memory in GB.
usedVcpu number: The used vCPU.
zoneId string: The zone ID to query.

config_server_node_id str: The config server node ID.
node_role str: The nod role.
node_status str: The node status.
total_memory_gb float: The total memory in GB.
total_vcpu float: The total vCPU.
used_memory_gb float: The used memory in GB.
used_vcpu float: The used vCPU.
zone_id str: The zone ID to query.

configServerNodeId String: The config server node ID.
nodeRole String: The nod role.
nodeStatus String: The node status.
totalMemoryGb Number: The total memory in GB.
totalVcpu Number: The total vCPU.
usedMemoryGb Number: The used memory in GB.
usedVcpu Number: The used vCPU.
zoneId String: The zone ID to query.

GetInstancesInstanceMongo

MongosNodeId string: The mongos node ID.
NodeSpec string: The node spec.
NodeStatus string: The node status.
TotalMemoryGb double: The total memory in GB.
TotalVcpu double: The total vCPU.
UsedMemoryGb double: The used memory in GB.
UsedVcpu double: The used vCPU.
ZoneId string: The zone ID to query.

MongosNodeId string: The mongos node ID.
NodeSpec string: The node spec.
NodeStatus string: The node status.
TotalMemoryGb float64: The total memory in GB.
TotalVcpu float64: The total vCPU.
UsedMemoryGb float64: The used memory in GB.
UsedVcpu float64: The used vCPU.
ZoneId string: The zone ID to query.

mongosNodeId String: The mongos node ID.
nodeSpec String: The node spec.
nodeStatus String: The node status.
totalMemoryGb Double: The total memory in GB.
totalVcpu Double: The total vCPU.
usedMemoryGb Double: The used memory in GB.
usedVcpu Double: The used vCPU.
zoneId String: The zone ID to query.

mongosNodeId string: The mongos node ID.
nodeSpec string: The node spec.
nodeStatus string: The node status.
totalMemoryGb number: The total memory in GB.
totalVcpu number: The total vCPU.
usedMemoryGb number: The used memory in GB.
usedVcpu number: The used vCPU.
zoneId string: The zone ID to query.

mongos_node_id str: The mongos node ID.
node_spec str: The node spec.
node_status str: The node status.
total_memory_gb float: The total memory in GB.
total_vcpu float: The total vCPU.
used_memory_gb float: The used memory in GB.
used_vcpu float: The used vCPU.
zone_id str: The zone ID to query.

mongosNodeId String: The mongos node ID.
nodeSpec String: The node spec.
nodeStatus String: The node status.
totalMemoryGb Number: The total memory in GB.
totalVcpu Number: The total vCPU.
usedMemoryGb Number: The used memory in GB.
usedVcpu Number: The used vCPU.
zoneId String: The zone ID to query.

GetInstancesInstanceNode

NodeDelayTime int: The master-slave delay time.
NodeId string: The node ID.
NodeRole string: The nod role.
NodeSpec string: The node spec.
NodeStatus string: The node status.
TotalMemoryGb double: The total memory in GB.
TotalStorageGb double: The total storage in GB.
TotalVcpu double: The total vCPU.
UsedMemoryGb double: The used memory in GB.
UsedStorageGb double: The used storage in GB.
UsedVcpu double: The used vCPU.
ZoneId string: The zone ID to query.

NodeDelayTime int: The master-slave delay time.
NodeId string: The node ID.
NodeRole string: The nod role.
NodeSpec string: The node spec.
NodeStatus string: The node status.
TotalMemoryGb float64: The total memory in GB.
TotalStorageGb float64: The total storage in GB.
TotalVcpu float64: The total vCPU.
UsedMemoryGb float64: The used memory in GB.
UsedStorageGb float64: The used storage in GB.
UsedVcpu float64: The used vCPU.
ZoneId string: The zone ID to query.

nodeDelayTime Integer: The master-slave delay time.
nodeId String: The node ID.
nodeRole String: The nod role.
nodeSpec String: The node spec.
nodeStatus String: The node status.
totalMemoryGb Double: The total memory in GB.
totalStorageGb Double: The total storage in GB.
totalVcpu Double: The total vCPU.
usedMemoryGb Double: The used memory in GB.
usedStorageGb Double: The used storage in GB.
usedVcpu Double: The used vCPU.
zoneId String: The zone ID to query.

nodeDelayTime number: The master-slave delay time.
nodeId string: The node ID.
nodeRole string: The nod role.
nodeSpec string: The node spec.
nodeStatus string: The node status.
totalMemoryGb number: The total memory in GB.
totalStorageGb number: The total storage in GB.
totalVcpu number: The total vCPU.
usedMemoryGb number: The used memory in GB.
usedStorageGb number: The used storage in GB.
usedVcpu number: The used vCPU.
zoneId string: The zone ID to query.

node_delay_time int: The master-slave delay time.
node_id str: The node ID.
node_role str: The nod role.
node_spec str: The node spec.
node_status str: The node status.
total_memory_gb float: The total memory in GB.
total_storage_gb float: The total storage in GB.
total_vcpu float: The total vCPU.
used_memory_gb float: The used memory in GB.
used_storage_gb float: The used storage in GB.
used_vcpu float: The used vCPU.
zone_id str: The zone ID to query.

nodeDelayTime Number: The master-slave delay time.
nodeId String: The node ID.
nodeRole String: The nod role.
nodeSpec String: The node spec.
nodeStatus String: The node status.
totalMemoryGb Number: The total memory in GB.
totalStorageGb Number: The total storage in GB.
totalVcpu Number: The total vCPU.
usedMemoryGb Number: The used memory in GB.
usedStorageGb Number: The used storage in GB.
usedVcpu Number: The used vCPU.
zoneId String: The zone ID to query.

GetInstancesInstanceShard

Nodes List<GetInstancesInstanceShardNode>: The node information.
ShardId string: The shard ID.

Nodes []GetInstancesInstanceShardNode: The node information.
ShardId string: The shard ID.

nodes List<GetInstancesInstanceShardNode>: The node information.
shardId String: The shard ID.

nodes GetInstancesInstanceShardNode[]: The node information.
shardId string: The shard ID.

nodes Sequence[GetInstancesInstanceShardNode]: The node information.
shard_id str: The shard ID.

nodes List<Property Map>: The node information.
shardId String: The shard ID.

GetInstancesInstanceShardNode

NodeDelayTime int: The master-slave delay time.
NodeId string: The node ID.
NodeRole string: The nod role.
NodeSpec string: The node spec.
NodeStatus string: The node status.
TotalMemoryGb double: The total memory in GB.
TotalStorageGb double: The total storage in GB.
TotalVcpu double: The total vCPU.
UsedMemoryGb double: The used memory in GB.
UsedStorageGb double: The used storage in GB.
UsedVcpu double: The used vCPU.
ZoneId string: The zone ID to query.

NodeDelayTime int: The master-slave delay time.
NodeId string: The node ID.
NodeRole string: The nod role.
NodeSpec string: The node spec.
NodeStatus string: The node status.
TotalMemoryGb float64: The total memory in GB.
TotalStorageGb float64: The total storage in GB.
TotalVcpu float64: The total vCPU.
UsedMemoryGb float64: The used memory in GB.
UsedStorageGb float64: The used storage in GB.
UsedVcpu float64: The used vCPU.
ZoneId string: The zone ID to query.

nodeDelayTime Integer: The master-slave delay time.
nodeId String: The node ID.
nodeRole String: The nod role.
nodeSpec String: The node spec.
nodeStatus String: The node status.
totalMemoryGb Double: The total memory in GB.
totalStorageGb Double: The total storage in GB.
totalVcpu Double: The total vCPU.
usedMemoryGb Double: The used memory in GB.
usedStorageGb Double: The used storage in GB.
usedVcpu Double: The used vCPU.
zoneId String: The zone ID to query.

nodeDelayTime number: The master-slave delay time.
nodeId string: The node ID.
nodeRole string: The nod role.
nodeSpec string: The node spec.
nodeStatus string: The node status.
totalMemoryGb number: The total memory in GB.
totalStorageGb number: The total storage in GB.
totalVcpu number: The total vCPU.
usedMemoryGb number: The used memory in GB.
usedStorageGb number: The used storage in GB.
usedVcpu number: The used vCPU.
zoneId string: The zone ID to query.

node_delay_time int: The master-slave delay time.
node_id str: The node ID.
node_role str: The nod role.
node_spec str: The node spec.
node_status str: The node status.
total_memory_gb float: The total memory in GB.
total_storage_gb float: The total storage in GB.
total_vcpu float: The total vCPU.
used_memory_gb float: The used memory in GB.
used_storage_gb float: The used storage in GB.
used_vcpu float: The used vCPU.
zone_id str: The zone ID to query.

nodeDelayTime Number: The master-slave delay time.
nodeId String: The node ID.
nodeRole String: The nod role.
nodeSpec String: The node spec.
nodeStatus String: The node status.
totalMemoryGb Number: The total memory in GB.
totalStorageGb Number: The total storage in GB.
totalVcpu Number: The total vCPU.
usedMemoryGb Number: The used memory in GB.
usedStorageGb Number: The used storage in GB.
usedVcpu Number: The used vCPU.
zoneId String: The zone ID to query.

GetInstancesInstanceTag

Key string: The Key of Tags.
Value string: The Value of Tags.

Key string: The Key of Tags.
Value string: The Value of Tags.

key String: The Key of Tags.
value String: The Value of Tags.

key string: The Key of Tags.
value string: The Value of Tags.

key str: The Key of Tags.
value str: The Value of Tags.

key String: The Key of Tags.
value String: The Value of Tags.

GetInstancesTag

Key string: The Key of Tags.
Value string: The Value of Tags.

Key string: The Key of Tags.
Value string: The Value of Tags.

key String: The Key of Tags.
value String: The Value of Tags.

key string: The Key of Tags.
value string: The Value of Tags.

key str: The Key of Tags.
value str: The Value of Tags.

key String: The Key of Tags.
value String: The Value of Tags.

Package Details

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

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

volcengine.mongodb.getInstances

On this page

On this page

Example Usage

Using getInstances

getInstances Result

Supporting Types

GetInstancesInstance

GetInstancesInstanceConfigServer

GetInstancesInstanceMongo

GetInstancesInstanceNode

GetInstancesInstanceShard

GetInstancesInstanceShardNode

GetInstancesInstanceTag

GetInstancesTag

Package Details

On this page

On this page