1. Registry
  2. Packages
  3. Ucloud Provider
  4. API Docs
  5. getUmongodbInstances
Viewing docs for ucloud 1.49.0
published on Tuesday, Oct 27, 2026 by ucloud
ucloud
Viewing docs for ucloud 1.49.0
published on Tuesday, Oct 27, 2026 by ucloud

    Lists UMongoDB replica sets and sharded clusters in the provider project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ucloud from "@pulumi/ucloud";
    
    const example = ucloud.getUmongodbInstances({
        availabilityZone: "cn-bj2-05",
    });
    
    import pulumi
    import pulumi_ucloud as ucloud
    
    example = ucloud.get_umongodb_instances(availability_zone="cn-bj2-05")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ucloud/ucloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ucloud.GetUmongodbInstances(ctx, &ucloud.GetUmongodbInstancesArgs{
    			AvailabilityZone: pulumi.StringRef("cn-bj2-05"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ucloud = Pulumi.Ucloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Ucloud.GetUmongodbInstances.Invoke(new()
        {
            AvailabilityZone = "cn-bj2-05",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ucloud.UcloudFunctions;
    import com.pulumi.ucloud.inputs.GetUmongodbInstancesArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = UcloudFunctions.getUmongodbInstances(GetUmongodbInstancesArgs.builder()
                .availabilityZone("cn-bj2-05")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ucloud:getUmongodbInstances
          arguments:
            availabilityZone: cn-bj2-05
    
    Example coming soon!
    

    Using getUmongodbInstances

    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 getUmongodbInstances(args: GetUmongodbInstancesArgs, opts?: InvokeOptions): Promise<GetUmongodbInstancesResult>
    function getUmongodbInstancesOutput(args: GetUmongodbInstancesOutputArgs, opts?: InvokeOutputOptions): Output<GetUmongodbInstancesResult>
    def get_umongodb_instances(availability_zone: Optional[str] = None,
                               cluster_id: Optional[str] = None,
                               id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetUmongodbInstancesResult
    def get_umongodb_instances_output(availability_zone: pulumi.Input[Optional[str]] = None,
                               cluster_id: pulumi.Input[Optional[str]] = None,
                               id: pulumi.Input[Optional[str]] = None,
                               opts: Optional[InvokeOutputOptions] = None) -> Output[GetUmongodbInstancesResult]
    func GetUmongodbInstances(ctx *Context, args *GetUmongodbInstancesArgs, opts ...InvokeOption) (*GetUmongodbInstancesResult, error)
    func GetUmongodbInstancesOutput(ctx *Context, args *GetUmongodbInstancesOutputArgs, opts ...InvokeOption) GetUmongodbInstancesResultOutput

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

    public static class GetUmongodbInstances 
    {
        public static Task<GetUmongodbInstancesResult> InvokeAsync(GetUmongodbInstancesArgs args, InvokeOptions? opts = null)
        public static Output<GetUmongodbInstancesResult> Invoke(GetUmongodbInstancesInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetUmongodbInstancesResult> Invoke(GetUmongodbInstancesInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetUmongodbInstancesResult> getUmongodbInstances(GetUmongodbInstancesArgs args, InvokeOptions options)
    public static Output<GetUmongodbInstancesResult> getUmongodbInstances(GetUmongodbInstancesArgs args, InvokeOptions options)
    public static Output<GetUmongodbInstancesResult> getUmongodbInstances(GetUmongodbInstancesArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: ucloud:index/getUmongodbInstances:getUmongodbInstances
      arguments:
        # arguments dictionary
    data "ucloud_get_umongodb_instances" "name" {
        # arguments
    }

    The following arguments are supported:

    AvailabilityZone string
    Filter by zone. Applied to the returned list.
    ClusterId string
    Filter by cluster ID. Applied to the returned list. The current list API request does not keep ClusterId, so the provider filters locally.
    Id string
    AvailabilityZone string
    Filter by zone. Applied to the returned list.
    ClusterId string
    Filter by cluster ID. Applied to the returned list. The current list API request does not keep ClusterId, so the provider filters locally.
    Id string
    availability_zone string
    Filter by zone. Applied to the returned list.
    cluster_id string
    Filter by cluster ID. Applied to the returned list. The current list API request does not keep ClusterId, so the provider filters locally.
    id string
    availabilityZone String
    Filter by zone. Applied to the returned list.
    clusterId String
    Filter by cluster ID. Applied to the returned list. The current list API request does not keep ClusterId, so the provider filters locally.
    id String
    availabilityZone string
    Filter by zone. Applied to the returned list.
    clusterId string
    Filter by cluster ID. Applied to the returned list. The current list API request does not keep ClusterId, so the provider filters locally.
    id string
    availability_zone str
    Filter by zone. Applied to the returned list.
    cluster_id str
    Filter by cluster ID. Applied to the returned list. The current list API request does not keep ClusterId, so the provider filters locally.
    id str
    availabilityZone String
    Filter by zone. Applied to the returned list.
    clusterId String
    Filter by cluster ID. Applied to the returned list. The current list API request does not keep ClusterId, so the provider filters locally.
    id String

    getUmongodbInstances Result

    The following output properties are available:

    Clusters List<GetUmongodbInstancesCluster>
    List of clusters. Each item has id, name, cluster_type, db_version, disk_space, state, connect_url, zone, subnet_id, vpc_id, tag, and create_time.
    Id string
    AvailabilityZone string
    ClusterId string
    Clusters []GetUmongodbInstancesCluster
    List of clusters. Each item has id, name, cluster_type, db_version, disk_space, state, connect_url, zone, subnet_id, vpc_id, tag, and create_time.
    Id string
    AvailabilityZone string
    ClusterId string
    clusters list(object)
    List of clusters. Each item has id, name, cluster_type, db_version, disk_space, state, connect_url, zone, subnet_id, vpc_id, tag, and create_time.
    id string
    availability_zone string
    cluster_id string
    clusters List<GetUmongodbInstancesCluster>
    List of clusters. Each item has id, name, cluster_type, db_version, disk_space, state, connect_url, zone, subnet_id, vpc_id, tag, and create_time.
    id String
    availabilityZone String
    clusterId String
    clusters GetUmongodbInstancesCluster[]
    List of clusters. Each item has id, name, cluster_type, db_version, disk_space, state, connect_url, zone, subnet_id, vpc_id, tag, and create_time.
    id string
    availabilityZone string
    clusterId string
    clusters Sequence[GetUmongodbInstancesCluster]
    List of clusters. Each item has id, name, cluster_type, db_version, disk_space, state, connect_url, zone, subnet_id, vpc_id, tag, and create_time.
    id str
    availability_zone str
    cluster_id str
    clusters List<Property Map>
    List of clusters. Each item has id, name, cluster_type, db_version, disk_space, state, connect_url, zone, subnet_id, vpc_id, tag, and create_time.
    id String
    availabilityZone String
    clusterId String

    Supporting Types

    GetUmongodbInstancesCluster

    ClusterType string
    ConnectUrl string
    CreateTime double
    DbVersion string
    DiskSpace double
    Id string
    Name string
    State string
    SubnetId string
    Tag string
    VpcId string
    Zone string
    ClusterType string
    ConnectUrl string
    CreateTime float64
    DbVersion string
    DiskSpace float64
    Id string
    Name string
    State string
    SubnetId string
    Tag string
    VpcId string
    Zone string
    cluster_type string
    connect_url string
    create_time number
    db_version string
    disk_space number
    id string
    name string
    state string
    subnet_id string
    tag string
    vpc_id string
    zone string
    clusterType String
    connectUrl String
    createTime Double
    dbVersion String
    diskSpace Double
    id String
    name String
    state String
    subnetId String
    tag String
    vpcId String
    zone String
    clusterType string
    connectUrl string
    createTime number
    dbVersion string
    diskSpace number
    id string
    name string
    state string
    subnetId string
    tag string
    vpcId string
    zone string
    clusterType String
    connectUrl String
    createTime Number
    dbVersion String
    diskSpace Number
    id String
    name String
    state String
    subnetId String
    tag String
    vpcId String
    zone String

    Package Details

    Repository
    ucloud ucloud/terraform-provider-ucloud
    License
    Notes
    This Pulumi package is based on the ucloud Terraform Provider.
    ucloud
    Viewing docs for ucloud 1.49.0
    published on Tuesday, Oct 27, 2026 by ucloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial