1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getMqttInstances
tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getMqttInstances

Start a Neo task
Explain and create a tencentcloud.getMqttInstances resource
tencentcloud logo
tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Use this data source to query detailed information of MQTT instances

    Example Usage

    Query all mqtt instances

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

const example = tencentcloud.getMqttInstances({});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_mqtt_instances()

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetMqttInstances(ctx, &tencentcloud.GetMqttInstancesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetMqttInstances.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetMqttInstancesArgs;
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 = TencentcloudFunctions.getMqttInstances(GetMqttInstancesArgs.builder()
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: tencentcloud:getMqttInstances
      arguments: {}

    Query mqtt instances by filters

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

const example = tencentcloud.getMqttInstances({
    filters: [
        {
            name: "InstanceId",
            values: ["mqtt-kngmpg9p"],
        },
        {
            name: "InstanceName",
            values: ["tf-example"],
        },
        {
            name: "InstanceStatus",
            values: ["RUNNING"],
        },
    ],
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_mqtt_instances(filters=[
    {
        "name": "InstanceId",
        "values": ["mqtt-kngmpg9p"],
    },
    {
        "name": "InstanceName",
        "values": ["tf-example"],
    },
    {
        "name": "InstanceStatus",
        "values": ["RUNNING"],
    },
])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetMqttInstances(ctx, &tencentcloud.GetMqttInstancesArgs{
			Filters: []tencentcloud.GetMqttInstancesFilter{
				{
					Name: "InstanceId",
					Values: []string{
						"mqtt-kngmpg9p",
					},
				},
				{
					Name: "InstanceName",
					Values: []string{
						"tf-example",
					},
				},
				{
					Name: "InstanceStatus",
					Values: []string{
						"RUNNING",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetMqttInstances.Invoke(new()
    {
        Filters = new[]
        {
            new Tencentcloud.Inputs.GetMqttInstancesFilterInputArgs
            {
                Name = "InstanceId",
                Values = new[]
                {
                    "mqtt-kngmpg9p",
                },
            },
            new Tencentcloud.Inputs.GetMqttInstancesFilterInputArgs
            {
                Name = "InstanceName",
                Values = new[]
                {
                    "tf-example",
                },
            },
            new Tencentcloud.Inputs.GetMqttInstancesFilterInputArgs
            {
                Name = "InstanceStatus",
                Values = new[]
                {
                    "RUNNING",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetMqttInstancesArgs;
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 = TencentcloudFunctions.getMqttInstances(GetMqttInstancesArgs.builder()
            .filters(            
                GetMqttInstancesFilterArgs.builder()
                    .name("InstanceId")
                    .values("mqtt-kngmpg9p")
                    .build(),
                GetMqttInstancesFilterArgs.builder()
                    .name("InstanceName")
                    .values("tf-example")
                    .build(),
                GetMqttInstancesFilterArgs.builder()
                    .name("InstanceStatus")
                    .values("RUNNING")
                    .build())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: tencentcloud:getMqttInstances
      arguments:
        filters:
          - name: InstanceId
            values:
              - mqtt-kngmpg9p
          - name: InstanceName
            values:
              - tf-example
          - name: InstanceStatus
            values:
              - RUNNING

    Using getMqttInstances

    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 getMqttInstances(args: GetMqttInstancesArgs, opts?: InvokeOptions): Promise<GetMqttInstancesResult>
function getMqttInstancesOutput(args: GetMqttInstancesOutputArgs, opts?: InvokeOptions): Output<GetMqttInstancesResult>
    def get_mqtt_instances(filters: Optional[Sequence[GetMqttInstancesFilter]] = None,
                       id: Optional[str] = None,
                       result_output_file: Optional[str] = None,
                       tag_filters: Optional[Sequence[GetMqttInstancesTagFilter]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetMqttInstancesResult
def get_mqtt_instances_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetMqttInstancesFilterArgs]]]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       result_output_file: Optional[pulumi.Input[str]] = None,
                       tag_filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetMqttInstancesTagFilterArgs]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetMqttInstancesResult]
    func GetMqttInstances(ctx *Context, args *GetMqttInstancesArgs, opts ...InvokeOption) (*GetMqttInstancesResult, error)
func GetMqttInstancesOutput(ctx *Context, args *GetMqttInstancesOutputArgs, opts ...InvokeOption) GetMqttInstancesResultOutput

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

    public static class GetMqttInstances 
{
    public static Task<GetMqttInstancesResult> InvokeAsync(GetMqttInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetMqttInstancesResult> Invoke(GetMqttInstancesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMqttInstancesResult> getMqttInstances(GetMqttInstancesArgs args, InvokeOptions options)
public static Output<GetMqttInstancesResult> getMqttInstances(GetMqttInstancesArgs args, InvokeOptions options)

    fn::invoke:
  function: tencentcloud:index/getMqttInstances:getMqttInstances
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Filters List<GetMqttInstancesFilter>
    Query criteria list, supporting the following fields: InstanceName: cluster name, fuzzy search, InstanceId: cluster ID, precise search, InstanceStatus: cluster status search (RUNNING - Running, CREATING - Creating, MODIFYING - Changing, DELETING - Deleting).
    Id string
    ResultOutputFile string
    Used to save results.
    TagFilters List<GetMqttInstancesTagFilter>
    Tag filters.
    Filters []GetMqttInstancesFilter
    Query criteria list, supporting the following fields: InstanceName: cluster name, fuzzy search, InstanceId: cluster ID, precise search, InstanceStatus: cluster status search (RUNNING - Running, CREATING - Creating, MODIFYING - Changing, DELETING - Deleting).
    Id string
    ResultOutputFile string
    Used to save results.
    TagFilters []GetMqttInstancesTagFilter
    Tag filters.
    filters List<GetMqttInstancesFilter>
    Query criteria list, supporting the following fields: InstanceName: cluster name, fuzzy search, InstanceId: cluster ID, precise search, InstanceStatus: cluster status search (RUNNING - Running, CREATING - Creating, MODIFYING - Changing, DELETING - Deleting).
    id String
    resultOutputFile String
    Used to save results.
    tagFilters List<GetMqttInstancesTagFilter>
    Tag filters.
    filters GetMqttInstancesFilter[]
    Query criteria list, supporting the following fields: InstanceName: cluster name, fuzzy search, InstanceId: cluster ID, precise search, InstanceStatus: cluster status search (RUNNING - Running, CREATING - Creating, MODIFYING - Changing, DELETING - Deleting).
    id string
    resultOutputFile string
    Used to save results.
    tagFilters GetMqttInstancesTagFilter[]
    Tag filters.
    filters Sequence[GetMqttInstancesFilter]
    Query criteria list, supporting the following fields: InstanceName: cluster name, fuzzy search, InstanceId: cluster ID, precise search, InstanceStatus: cluster status search (RUNNING - Running, CREATING - Creating, MODIFYING - Changing, DELETING - Deleting).
    id str
    result_output_file str
    Used to save results.
    tag_filters Sequence[GetMqttInstancesTagFilter]
    Tag filters.
    filters List<Property Map>
    Query criteria list, supporting the following fields: InstanceName: cluster name, fuzzy search, InstanceId: cluster ID, precise search, InstanceStatus: cluster status search (RUNNING - Running, CREATING - Creating, MODIFYING - Changing, DELETING - Deleting).
    id String
    resultOutputFile String
    Used to save results.
    tagFilters List<Property Map>
    Tag filters.

    getMqttInstances Result

    The following output properties are available:

    Supporting Types

    GetMqttInstancesData

    AuthorizationPolicyLimit double
    Limit on the number of authorization rules.
    ClientNumLimit double
    Number of client connections online.
    CreateTime double
    Creation time, millisecond timestamp.
    DestroyTime double
    Pre destruction time, millisecond timestamp.
    ExpiryTime double
    Expiration time, millisecond level timestamp.
    InstanceId string
    Instacen ID.
    InstanceName string
    Instacen name.
    InstanceStatus string
    Instance status. RUNNING- In operation; MAINTAINING- Under Maintenance; ABNORMAL- abnormal; OVERDUE- Arrears of fees; DESTROYED- Deleted; CREATING- Creating in progress; MODIFYING- In the process of transformation; CREATE_FAILURE- Creation failed; MODIFY_FAILURE- Transformation failed; DELETING- deleting.
    InstanceType string
    Instance type. BASIC- Basic Edition; PRO- professional edition; PLATINUM- Platinum version.
    MaxCaNum double
    Maximum CA quota.
    MaxSubscription double
    Maximum number of subscriptions.
    MaxSubscriptionPerClient double
    Maximum number of subscriptions per client.
    PayMode string
    Billing mode, POSTPAID, pay as you go PREPAID, annual and monthly package.
    Remark string
    Remark.
    RenewFlag double
    Whether to renew automatically. Only the annual and monthly package cluster is effective. 1: Automatic renewal; 0: Non automatic renewal.
    SkuCode string
    Product specifications.
    TopicNum double
    Topic num.
    TopicNumLimit double
    Maximum number of instance topics.
    TpsLimit double
    Elastic TPS current limit value.
    Version string
    Instacen version.
    AuthorizationPolicyLimit float64
    Limit on the number of authorization rules.
    ClientNumLimit float64
    Number of client connections online.
    CreateTime float64
    Creation time, millisecond timestamp.
    DestroyTime float64
    Pre destruction time, millisecond timestamp.
    ExpiryTime float64
    Expiration time, millisecond level timestamp.
    InstanceId string
    Instacen ID.
    InstanceName string
    Instacen name.
    InstanceStatus string
    Instance status. RUNNING- In operation; MAINTAINING- Under Maintenance; ABNORMAL- abnormal; OVERDUE- Arrears of fees; DESTROYED- Deleted; CREATING- Creating in progress; MODIFYING- In the process of transformation; CREATE_FAILURE- Creation failed; MODIFY_FAILURE- Transformation failed; DELETING- deleting.
    InstanceType string
    Instance type. BASIC- Basic Edition; PRO- professional edition; PLATINUM- Platinum version.
    MaxCaNum float64
    Maximum CA quota.
    MaxSubscription float64
    Maximum number of subscriptions.
    MaxSubscriptionPerClient float64
    Maximum number of subscriptions per client.
    PayMode string
    Billing mode, POSTPAID, pay as you go PREPAID, annual and monthly package.
    Remark string
    Remark.
    RenewFlag float64
    Whether to renew automatically. Only the annual and monthly package cluster is effective. 1: Automatic renewal; 0: Non automatic renewal.
    SkuCode string
    Product specifications.
    TopicNum float64
    Topic num.
    TopicNumLimit float64
    Maximum number of instance topics.
    TpsLimit float64
    Elastic TPS current limit value.
    Version string
    Instacen version.
    authorizationPolicyLimit Double
    Limit on the number of authorization rules.
    clientNumLimit Double
    Number of client connections online.
    createTime Double
    Creation time, millisecond timestamp.
    destroyTime Double
    Pre destruction time, millisecond timestamp.
    expiryTime Double
    Expiration time, millisecond level timestamp.
    instanceId String
    Instacen ID.
    instanceName String
    Instacen name.
    instanceStatus String
    Instance status. RUNNING- In operation; MAINTAINING- Under Maintenance; ABNORMAL- abnormal; OVERDUE- Arrears of fees; DESTROYED- Deleted; CREATING- Creating in progress; MODIFYING- In the process of transformation; CREATE_FAILURE- Creation failed; MODIFY_FAILURE- Transformation failed; DELETING- deleting.
    instanceType String
    Instance type. BASIC- Basic Edition; PRO- professional edition; PLATINUM- Platinum version.
    maxCaNum Double
    Maximum CA quota.
    maxSubscription Double
    Maximum number of subscriptions.
    maxSubscriptionPerClient Double
    Maximum number of subscriptions per client.
    payMode String
    Billing mode, POSTPAID, pay as you go PREPAID, annual and monthly package.
    remark String
    Remark.
    renewFlag Double
    Whether to renew automatically. Only the annual and monthly package cluster is effective. 1: Automatic renewal; 0: Non automatic renewal.
    skuCode String
    Product specifications.
    topicNum Double
    Topic num.
    topicNumLimit Double
    Maximum number of instance topics.
    tpsLimit Double
    Elastic TPS current limit value.
    version String
    Instacen version.
    authorizationPolicyLimit number
    Limit on the number of authorization rules.
    clientNumLimit number
    Number of client connections online.
    createTime number
    Creation time, millisecond timestamp.
    destroyTime number
    Pre destruction time, millisecond timestamp.
    expiryTime number
    Expiration time, millisecond level timestamp.
    instanceId string
    Instacen ID.
    instanceName string
    Instacen name.
    instanceStatus string
    Instance status. RUNNING- In operation; MAINTAINING- Under Maintenance; ABNORMAL- abnormal; OVERDUE- Arrears of fees; DESTROYED- Deleted; CREATING- Creating in progress; MODIFYING- In the process of transformation; CREATE_FAILURE- Creation failed; MODIFY_FAILURE- Transformation failed; DELETING- deleting.
    instanceType string
    Instance type. BASIC- Basic Edition; PRO- professional edition; PLATINUM- Platinum version.
    maxCaNum number
    Maximum CA quota.
    maxSubscription number
    Maximum number of subscriptions.
    maxSubscriptionPerClient number
    Maximum number of subscriptions per client.
    payMode string
    Billing mode, POSTPAID, pay as you go PREPAID, annual and monthly package.
    remark string
    Remark.
    renewFlag number
    Whether to renew automatically. Only the annual and monthly package cluster is effective. 1: Automatic renewal; 0: Non automatic renewal.
    skuCode string
    Product specifications.
    topicNum number
    Topic num.
    topicNumLimit number
    Maximum number of instance topics.
    tpsLimit number
    Elastic TPS current limit value.
    version string
    Instacen version.
    authorization_policy_limit float
    Limit on the number of authorization rules.
    client_num_limit float
    Number of client connections online.
    create_time float
    Creation time, millisecond timestamp.
    destroy_time float
    Pre destruction time, millisecond timestamp.
    expiry_time float
    Expiration time, millisecond level timestamp.
    instance_id str
    Instacen ID.
    instance_name str
    Instacen name.
    instance_status str
    Instance status. RUNNING- In operation; MAINTAINING- Under Maintenance; ABNORMAL- abnormal; OVERDUE- Arrears of fees; DESTROYED- Deleted; CREATING- Creating in progress; MODIFYING- In the process of transformation; CREATE_FAILURE- Creation failed; MODIFY_FAILURE- Transformation failed; DELETING- deleting.
    instance_type str
    Instance type. BASIC- Basic Edition; PRO- professional edition; PLATINUM- Platinum version.
    max_ca_num float
    Maximum CA quota.
    max_subscription float
    Maximum number of subscriptions.
    max_subscription_per_client float
    Maximum number of subscriptions per client.
    pay_mode str
    Billing mode, POSTPAID, pay as you go PREPAID, annual and monthly package.
    remark str
    Remark.
    renew_flag float
    Whether to renew automatically. Only the annual and monthly package cluster is effective. 1: Automatic renewal; 0: Non automatic renewal.
    sku_code str
    Product specifications.
    topic_num float
    Topic num.
    topic_num_limit float
    Maximum number of instance topics.
    tps_limit float
    Elastic TPS current limit value.
    version str
    Instacen version.
    authorizationPolicyLimit Number
    Limit on the number of authorization rules.
    clientNumLimit Number
    Number of client connections online.
    createTime Number
    Creation time, millisecond timestamp.
    destroyTime Number
    Pre destruction time, millisecond timestamp.
    expiryTime Number
    Expiration time, millisecond level timestamp.
    instanceId String
    Instacen ID.
    instanceName String
    Instacen name.
    instanceStatus String
    Instance status. RUNNING- In operation; MAINTAINING- Under Maintenance; ABNORMAL- abnormal; OVERDUE- Arrears of fees; DESTROYED- Deleted; CREATING- Creating in progress; MODIFYING- In the process of transformation; CREATE_FAILURE- Creation failed; MODIFY_FAILURE- Transformation failed; DELETING- deleting.
    instanceType String
    Instance type. BASIC- Basic Edition; PRO- professional edition; PLATINUM- Platinum version.
    maxCaNum Number
    Maximum CA quota.
    maxSubscription Number
    Maximum number of subscriptions.
    maxSubscriptionPerClient Number
    Maximum number of subscriptions per client.
    payMode String
    Billing mode, POSTPAID, pay as you go PREPAID, annual and monthly package.
    remark String
    Remark.
    renewFlag Number
    Whether to renew automatically. Only the annual and monthly package cluster is effective. 1: Automatic renewal; 0: Non automatic renewal.
    skuCode String
    Product specifications.
    topicNum Number
    Topic num.
    topicNumLimit Number
    Maximum number of instance topics.
    tpsLimit Number
    Elastic TPS current limit value.
    version String
    Instacen version.

    GetMqttInstancesFilter

    Name string
    Filter name.
    Values List<string>
    Values.
    Name string
    Filter name.
    Values []string
    Values.
    name String
    Filter name.
    values List<String>
    Values.
    name string
    Filter name.
    values string[]
    Values.
    name str
    Filter name.
    values Sequence[str]
    Values.
    name String
    Filter name.
    values List<String>
    Values.

    GetMqttInstancesTagFilter

    TagKey string
    Tag key.
    TagValues List<string>
    Tag values.
    TagKey string
    Tag key.
    TagValues []string
    Tag values.
    tagKey String
    Tag key.
    tagValues List<String>
    Tag values.
    tagKey string
    Tag key.
    tagValues string[]
    Tag values.
    tag_key str
    Tag key.
    tag_values Sequence[str]
    Tag values.
    tagKey String
    Tag key.
    tagValues List<String>
    Tag values.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud
      Meet Neo: Your AI Platform Teammate