1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getApmInstances
tencentcloud 1.82.68 published on Friday, Feb 6, 2026 by tencentcloudstack
Schema (JSON)
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getApmInstances

tencentcloud logo
tencentcloud 1.82.68 published on Friday, Feb 6, 2026 by tencentcloudstack
Schema (JSON)
tencentcloudstack/terraform-provider-tencentcloud

    Use this data source to query APM (Application Performance Management) instances.

    Example Usage

    Query all APM instances

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

const all = tencentcloud.getApmInstances({});
export const instances = all.then(all => all.instanceLists);

    import pulumi
import pulumi_tencentcloud as tencentcloud

all = tencentcloud.get_apm_instances()
pulumi.export("instances", all.instance_lists)

    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 {
		all, err := tencentcloud.GetApmInstances(ctx, &tencentcloud.GetApmInstancesArgs{}, nil)
		if err != nil {
			return err
		}
		ctx.Export("instances", all.InstanceLists)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var all = Tencentcloud.GetApmInstances.Invoke();

    return new Dictionary<string, object?>
    {
        ["instances"] = all.Apply(getApmInstancesResult => getApmInstancesResult.InstanceLists),
    };
});

    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.GetApmInstancesArgs;
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 all = TencentcloudFunctions.getApmInstances(GetApmInstancesArgs.builder()
            .build());

        ctx.export("instances", all.instanceLists());
    }
}

    variables:
  all:
    fn::invoke:
      function: tencentcloud:getApmInstances
      arguments: {}
outputs:
  instances: ${all.instanceLists}

    Query APM instances by IDs

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

const byIds = tencentcloud.getApmInstances({
    instanceIds: [
        "apm-xxxxxxxx",
        "apm-yyyyyyyy",
    ],
});
export const instances = byIds.then(byIds => byIds.instanceLists);

    import pulumi
import pulumi_tencentcloud as tencentcloud

by_ids = tencentcloud.get_apm_instances(instance_ids=[
    "apm-xxxxxxxx",
    "apm-yyyyyyyy",
])
pulumi.export("instances", by_ids.instance_lists)

    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 {
		byIds, err := tencentcloud.GetApmInstances(ctx, &tencentcloud.GetApmInstancesArgs{
			InstanceIds: []string{
				"apm-xxxxxxxx",
				"apm-yyyyyyyy",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("instances", byIds.InstanceLists)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var byIds = Tencentcloud.GetApmInstances.Invoke(new()
    {
        InstanceIds = new[]
        {
            "apm-xxxxxxxx",
            "apm-yyyyyyyy",
        },
    });

    return new Dictionary<string, object?>
    {
        ["instances"] = byIds.Apply(getApmInstancesResult => getApmInstancesResult.InstanceLists),
    };
});

    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.GetApmInstancesArgs;
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 byIds = TencentcloudFunctions.getApmInstances(GetApmInstancesArgs.builder()
            .instanceIds(            
                "apm-xxxxxxxx",
                "apm-yyyyyyyy")
            .build());

        ctx.export("instances", byIds.instanceLists());
    }
}

    variables:
  byIds:
    fn::invoke:
      function: tencentcloud:getApmInstances
      arguments:
        instanceIds:
          - apm-xxxxxxxx
          - apm-yyyyyyyy
outputs:
  instances: ${byIds.instanceLists}

    Query APM instances by name

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

const byName = tencentcloud.getApmInstances({
    instanceName: "test",
});
export const instances = byName.then(byName => byName.instanceLists);

    import pulumi
import pulumi_tencentcloud as tencentcloud

by_name = tencentcloud.get_apm_instances(instance_name="test")
pulumi.export("instances", by_name.instance_lists)

    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 {
		byName, err := tencentcloud.GetApmInstances(ctx, &tencentcloud.GetApmInstancesArgs{
			InstanceName: pulumi.StringRef("test"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("instances", byName.InstanceLists)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var byName = Tencentcloud.GetApmInstances.Invoke(new()
    {
        InstanceName = "test",
    });

    return new Dictionary<string, object?>
    {
        ["instances"] = byName.Apply(getApmInstancesResult => getApmInstancesResult.InstanceLists),
    };
});

    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.GetApmInstancesArgs;
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 byName = TencentcloudFunctions.getApmInstances(GetApmInstancesArgs.builder()
            .instanceName("test")
            .build());

        ctx.export("instances", byName.instanceLists());
    }
}

    variables:
  byName:
    fn::invoke:
      function: tencentcloud:getApmInstances
      arguments:
        instanceName: test
outputs:
  instances: ${byName.instanceLists}

    Query APM instances by tags

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

const byTags = tencentcloud.getApmInstances({
    tags: {
        Environment: "Production",
        Team: "DevOps",
    },
});
export const instances = byTags.then(byTags => byTags.instanceLists);

    import pulumi
import pulumi_tencentcloud as tencentcloud

by_tags = tencentcloud.get_apm_instances(tags={
    "Environment": "Production",
    "Team": "DevOps",
})
pulumi.export("instances", by_tags.instance_lists)

    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 {
		byTags, err := tencentcloud.GetApmInstances(ctx, &tencentcloud.GetApmInstancesArgs{
			Tags: map[string]interface{}{
				"Environment": "Production",
				"Team":        "DevOps",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("instances", byTags.InstanceLists)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var byTags = Tencentcloud.GetApmInstances.Invoke(new()
    {
        Tags = 
        {
            { "Environment", "Production" },
            { "Team", "DevOps" },
        },
    });

    return new Dictionary<string, object?>
    {
        ["instances"] = byTags.Apply(getApmInstancesResult => getApmInstancesResult.InstanceLists),
    };
});

    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.GetApmInstancesArgs;
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 byTags = TencentcloudFunctions.getApmInstances(GetApmInstancesArgs.builder()
            .tags(Map.ofEntries(
                Map.entry("Environment", "Production"),
                Map.entry("Team", "DevOps")
            ))
            .build());

        ctx.export("instances", byTags.instanceLists());
    }
}

    variables:
  byTags:
    fn::invoke:
      function: tencentcloud:getApmInstances
      arguments:
        tags:
          Environment: Production
          Team: DevOps
outputs:
  instances: ${byTags.instanceLists}

    Using getApmInstances

    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 getApmInstances(args: GetApmInstancesArgs, opts?: InvokeOptions): Promise<GetApmInstancesResult>
function getApmInstancesOutput(args: GetApmInstancesOutputArgs, opts?: InvokeOptions): Output<GetApmInstancesResult>
    def get_apm_instances(all_regions_flag: Optional[float] = None,
                      demo_instance_flag: Optional[float] = None,
                      id: Optional[str] = None,
                      instance_id: Optional[str] = None,
                      instance_ids: Optional[Sequence[str]] = None,
                      instance_name: Optional[str] = None,
                      result_output_file: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetApmInstancesResult
def get_apm_instances_output(all_regions_flag: Optional[pulumi.Input[float]] = None,
                      demo_instance_flag: Optional[pulumi.Input[float]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      instance_id: Optional[pulumi.Input[str]] = None,
                      instance_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      instance_name: Optional[pulumi.Input[str]] = None,
                      result_output_file: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetApmInstancesResult]
    func GetApmInstances(ctx *Context, args *GetApmInstancesArgs, opts ...InvokeOption) (*GetApmInstancesResult, error)
func GetApmInstancesOutput(ctx *Context, args *GetApmInstancesOutputArgs, opts ...InvokeOption) GetApmInstancesResultOutput

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

    public static class GetApmInstances 
{
    public static Task<GetApmInstancesResult> InvokeAsync(GetApmInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetApmInstancesResult> Invoke(GetApmInstancesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApmInstancesResult> getApmInstances(GetApmInstancesArgs args, InvokeOptions options)
public static Output<GetApmInstancesResult> getApmInstances(GetApmInstancesArgs args, InvokeOptions options)

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

    The following arguments are supported:

    AllRegionsFlag double
    Whether to query instances in all regions. 0: no, 1: yes. Default is 0.
    DemoInstanceFlag double
    Whether to query official demo instances. 0: non-demo, 1: demo. Default is 0.
    Id string
    InstanceId string
    Filter by instance ID (fuzzy match).
    InstanceIds List<string>
    Filter by instance ID list (exact match).
    InstanceName string
    Filter by instance name (fuzzy match).
    ResultOutputFile string
    Used to save results.
    Tags Dictionary<string, string>
    Filter by tags.
    AllRegionsFlag float64
    Whether to query instances in all regions. 0: no, 1: yes. Default is 0.
    DemoInstanceFlag float64
    Whether to query official demo instances. 0: non-demo, 1: demo. Default is 0.
    Id string
    InstanceId string
    Filter by instance ID (fuzzy match).
    InstanceIds []string
    Filter by instance ID list (exact match).
    InstanceName string
    Filter by instance name (fuzzy match).
    ResultOutputFile string
    Used to save results.
    Tags map[string]string
    Filter by tags.
    allRegionsFlag Double
    Whether to query instances in all regions. 0: no, 1: yes. Default is 0.
    demoInstanceFlag Double
    Whether to query official demo instances. 0: non-demo, 1: demo. Default is 0.
    id String
    instanceId String
    Filter by instance ID (fuzzy match).
    instanceIds List<String>
    Filter by instance ID list (exact match).
    instanceName String
    Filter by instance name (fuzzy match).
    resultOutputFile String
    Used to save results.
    tags Map<String,String>
    Filter by tags.
    allRegionsFlag number
    Whether to query instances in all regions. 0: no, 1: yes. Default is 0.
    demoInstanceFlag number
    Whether to query official demo instances. 0: non-demo, 1: demo. Default is 0.
    id string
    instanceId string
    Filter by instance ID (fuzzy match).
    instanceIds string[]
    Filter by instance ID list (exact match).
    instanceName string
    Filter by instance name (fuzzy match).
    resultOutputFile string
    Used to save results.
    tags {[key: string]: string}
    Filter by tags.
    all_regions_flag float
    Whether to query instances in all regions. 0: no, 1: yes. Default is 0.
    demo_instance_flag float
    Whether to query official demo instances. 0: non-demo, 1: demo. Default is 0.
    id str
    instance_id str
    Filter by instance ID (fuzzy match).
    instance_ids Sequence[str]
    Filter by instance ID list (exact match).
    instance_name str
    Filter by instance name (fuzzy match).
    result_output_file str
    Used to save results.
    tags Mapping[str, str]
    Filter by tags.
    allRegionsFlag Number
    Whether to query instances in all regions. 0: no, 1: yes. Default is 0.
    demoInstanceFlag Number
    Whether to query official demo instances. 0: non-demo, 1: demo. Default is 0.
    id String
    instanceId String
    Filter by instance ID (fuzzy match).
    instanceIds List<String>
    Filter by instance ID list (exact match).
    instanceName String
    Filter by instance name (fuzzy match).
    resultOutputFile String
    Used to save results.
    tags Map<String>
    Filter by tags.

    getApmInstances Result

    The following output properties are available:

    Id string
    InstanceLists List<GetApmInstancesInstanceList>
    APM instance list.
    AllRegionsFlag double
    DemoInstanceFlag double
    InstanceId string
    Instance ID.
    InstanceIds List<string>
    InstanceName string
    ResultOutputFile string
    Tags Dictionary<string, string>
    Tag list.
    Id string
    InstanceLists []GetApmInstancesInstanceList
    APM instance list.
    AllRegionsFlag float64
    DemoInstanceFlag float64
    InstanceId string
    Instance ID.
    InstanceIds []string
    InstanceName string
    ResultOutputFile string
    Tags map[string]string
    Tag list.
    id String
    instanceLists List<GetApmInstancesInstanceList>
    APM instance list.
    allRegionsFlag Double
    demoInstanceFlag Double
    instanceId String
    Instance ID.
    instanceIds List<String>
    instanceName String
    resultOutputFile String
    tags Map<String,String>
    Tag list.
    id string
    instanceLists GetApmInstancesInstanceList[]
    APM instance list.
    allRegionsFlag number
    demoInstanceFlag number
    instanceId string
    Instance ID.
    instanceIds string[]
    instanceName string
    resultOutputFile string
    tags {[key: string]: string}
    Tag list.
    id str
    instance_lists Sequence[GetApmInstancesInstanceList]
    APM instance list.
    all_regions_flag float
    demo_instance_flag float
    instance_id str
    Instance ID.
    instance_ids Sequence[str]
    instance_name str
    result_output_file str
    tags Mapping[str, str]
    Tag list.
    id String
    instanceLists List<Property Map>
    APM instance list.
    allRegionsFlag Number
    demoInstanceFlag Number
    instanceId String
    Instance ID.
    instanceIds List<String>
    instanceName String
    resultOutputFile String
    tags Map<String>
    Tag list.

    Supporting Types

    GetApmInstancesInstanceList

    AppId double
    App ID.
    CreateUin string
    Creator UIN.
    Description string
    Instance description.
    ErrRateThreshold double
    Error rate threshold.
    ErrorSample double
    Error sampling switch.
    Free double
    Whether it is free edition.
    InstanceId string
    Filter by instance ID (fuzzy match).
    Name string
    Instance name.
    PayMode double
    Billing mode.
    Region string
    Region.
    SampleRate double
    Sampling rate.
    ServiceCount double
    Service count.
    SpanDailyCounters double
    Daily span count quota.
    Status double
    Instance status.
    Tags List<GetApmInstancesInstanceListTag>
    Filter by tags.
    TraceDuration double
    Trace data retention duration.
    AppId float64
    App ID.
    CreateUin string
    Creator UIN.
    Description string
    Instance description.
    ErrRateThreshold float64
    Error rate threshold.
    ErrorSample float64
    Error sampling switch.
    Free float64
    Whether it is free edition.
    InstanceId string
    Filter by instance ID (fuzzy match).
    Name string
    Instance name.
    PayMode float64
    Billing mode.
    Region string
    Region.
    SampleRate float64
    Sampling rate.
    ServiceCount float64
    Service count.
    SpanDailyCounters float64
    Daily span count quota.
    Status float64
    Instance status.
    Tags []GetApmInstancesInstanceListTag
    Filter by tags.
    TraceDuration float64
    Trace data retention duration.
    appId Double
    App ID.
    createUin String
    Creator UIN.
    description String
    Instance description.
    errRateThreshold Double
    Error rate threshold.
    errorSample Double
    Error sampling switch.
    free Double
    Whether it is free edition.
    instanceId String
    Filter by instance ID (fuzzy match).
    name String
    Instance name.
    payMode Double
    Billing mode.
    region String
    Region.
    sampleRate Double
    Sampling rate.
    serviceCount Double
    Service count.
    spanDailyCounters Double
    Daily span count quota.
    status Double
    Instance status.
    tags List<GetApmInstancesInstanceListTag>
    Filter by tags.
    traceDuration Double
    Trace data retention duration.
    appId number
    App ID.
    createUin string
    Creator UIN.
    description string
    Instance description.
    errRateThreshold number
    Error rate threshold.
    errorSample number
    Error sampling switch.
    free number
    Whether it is free edition.
    instanceId string
    Filter by instance ID (fuzzy match).
    name string
    Instance name.
    payMode number
    Billing mode.
    region string
    Region.
    sampleRate number
    Sampling rate.
    serviceCount number
    Service count.
    spanDailyCounters number
    Daily span count quota.
    status number
    Instance status.
    tags GetApmInstancesInstanceListTag[]
    Filter by tags.
    traceDuration number
    Trace data retention duration.
    app_id float
    App ID.
    create_uin str
    Creator UIN.
    description str
    Instance description.
    err_rate_threshold float
    Error rate threshold.
    error_sample float
    Error sampling switch.
    free float
    Whether it is free edition.
    instance_id str
    Filter by instance ID (fuzzy match).
    name str
    Instance name.
    pay_mode float
    Billing mode.
    region str
    Region.
    sample_rate float
    Sampling rate.
    service_count float
    Service count.
    span_daily_counters float
    Daily span count quota.
    status float
    Instance status.
    tags Sequence[GetApmInstancesInstanceListTag]
    Filter by tags.
    trace_duration float
    Trace data retention duration.
    appId Number
    App ID.
    createUin String
    Creator UIN.
    description String
    Instance description.
    errRateThreshold Number
    Error rate threshold.
    errorSample Number
    Error sampling switch.
    free Number
    Whether it is free edition.
    instanceId String
    Filter by instance ID (fuzzy match).
    name String
    Instance name.
    payMode Number
    Billing mode.
    region String
    Region.
    sampleRate Number
    Sampling rate.
    serviceCount Number
    Service count.
    spanDailyCounters Number
    Daily span count quota.
    status Number
    Instance status.
    tags List<Property Map>
    Filter by tags.
    traceDuration Number
    Trace data retention duration.

    GetApmInstancesInstanceListTag

    Key string
    Tag key.
    Value string
    Tag value.
    Key string
    Tag key.
    Value string
    Tag value.
    key String
    Tag key.
    value String
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    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.68 published on Friday, Feb 6, 2026 by tencentcloudstack
    Schema (JSON)
    tencentcloudstack/terraform-provider-tencentcloud
      Meet Neo: Your AI Platform Teammate