1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getNats
Viewing docs for tencentcloud 1.82.73
published on Friday, Mar 6, 2026 by tencentcloudstack
Schema (JSON)
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getNats

tencentcloud logo
Viewing docs for tencentcloud 1.82.73
published on Friday, Mar 6, 2026 by tencentcloudstack
Schema (JSON)
tencentcloudstack/terraform-provider-tencentcloud

    The NATs data source lists a number of NATs resource information owned by an TencentCloud account.

    NOTE: It has been deprecated and replaced by tencentcloud_nat_gateways.

    Example Usage

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

// Query the NAT gateway by ID
const anat = tencentcloud.getNats({
    id: "nat-k6ualnp2",
});
// Query the list of normal NAT gateways
const natState = tencentcloud.getNats({
    state: 0,
});
// Multi conditional query NAT gateway list
const multiNat = tencentcloud.getNats({
    name: "terraform test",
    vpcId: "vpc-ezij4ltv",
    maxConcurrent: 3000000,
    bandwidth: 500,
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

# Query the NAT gateway by ID
anat = tencentcloud.get_nats(id="nat-k6ualnp2")
# Query the list of normal NAT gateways
nat_state = tencentcloud.get_nats(state=0)
# Multi conditional query NAT gateway list
multi_nat = tencentcloud.get_nats(name="terraform test",
    vpc_id="vpc-ezij4ltv",
    max_concurrent=3000000,
    bandwidth=500)

    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 {
		// Query the NAT gateway by ID
		_, err := tencentcloud.GetNats(ctx, &tencentcloud.GetNatsArgs{
			Id: pulumi.StringRef("nat-k6ualnp2"),
		}, nil)
		if err != nil {
			return err
		}
		// Query the list of normal NAT gateways
		_, err = tencentcloud.GetNats(ctx, &tencentcloud.GetNatsArgs{
			State: pulumi.Float64Ref(0),
		}, nil)
		if err != nil {
			return err
		}
		// Multi conditional query NAT gateway list
		_, err = tencentcloud.GetNats(ctx, &tencentcloud.GetNatsArgs{
			Name:          pulumi.StringRef("terraform test"),
			VpcId:         pulumi.StringRef("vpc-ezij4ltv"),
			MaxConcurrent: pulumi.Float64Ref(3000000),
			Bandwidth:     pulumi.Float64Ref(500),
		}, 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(() => 
{
    // Query the NAT gateway by ID
    var anat = Tencentcloud.GetNats.Invoke(new()
    {
        Id = "nat-k6ualnp2",
    });

    // Query the list of normal NAT gateways
    var natState = Tencentcloud.GetNats.Invoke(new()
    {
        State = 0,
    });

    // Multi conditional query NAT gateway list
    var multiNat = Tencentcloud.GetNats.Invoke(new()
    {
        Name = "terraform test",
        VpcId = "vpc-ezij4ltv",
        MaxConcurrent = 3000000,
        Bandwidth = 500,
    });

});

    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.GetNatsArgs;
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) {
        // Query the NAT gateway by ID
        final var anat = TencentcloudFunctions.getNats(GetNatsArgs.builder()
            .id("nat-k6ualnp2")
            .build());

        // Query the list of normal NAT gateways
        final var natState = TencentcloudFunctions.getNats(GetNatsArgs.builder()
            .state(0)
            .build());

        // Multi conditional query NAT gateway list
        final var multiNat = TencentcloudFunctions.getNats(GetNatsArgs.builder()
            .name("terraform test")
            .vpcId("vpc-ezij4ltv")
            .maxConcurrent(3000000)
            .bandwidth(500)
            .build());

    }
}

    variables:
  # Query the NAT gateway by ID
  anat:
    fn::invoke:
      function: tencentcloud:getNats
      arguments:
        id: nat-k6ualnp2
  # Query the list of normal NAT gateways
  natState:
    fn::invoke:
      function: tencentcloud:getNats
      arguments:
        state: 0
  # Multi conditional query NAT gateway list
  multiNat:
    fn::invoke:
      function: tencentcloud:getNats
      arguments:
        name: terraform test
        vpcId: vpc-ezij4ltv
        maxConcurrent: 3e+06
        bandwidth: 500

    Using getNats

    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 getNats(args: GetNatsArgs, opts?: InvokeOptions): Promise<GetNatsResult>
function getNatsOutput(args: GetNatsOutputArgs, opts?: InvokeOptions): Output<GetNatsResult>
    def get_nats(bandwidth: Optional[float] = None,
             id: Optional[str] = None,
             max_concurrent: Optional[float] = None,
             name: Optional[str] = None,
             state: Optional[float] = None,
             vpc_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetNatsResult
def get_nats_output(bandwidth: Optional[pulumi.Input[float]] = None,
             id: Optional[pulumi.Input[str]] = None,
             max_concurrent: Optional[pulumi.Input[float]] = None,
             name: Optional[pulumi.Input[str]] = None,
             state: Optional[pulumi.Input[float]] = None,
             vpc_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetNatsResult]
    func GetNats(ctx *Context, args *GetNatsArgs, opts ...InvokeOption) (*GetNatsResult, error)
func GetNatsOutput(ctx *Context, args *GetNatsOutputArgs, opts ...InvokeOption) GetNatsResultOutput

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

    public static class GetNats 
{
    public static Task<GetNatsResult> InvokeAsync(GetNatsArgs args, InvokeOptions? opts = null)
    public static Output<GetNatsResult> Invoke(GetNatsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNatsResult> getNats(GetNatsArgs args, InvokeOptions options)
public static Output<GetNatsResult> getNats(GetNatsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Bandwidth double
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    Id string
    The ID for NAT Gateway.
    MaxConcurrent double
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    Name string
    The name for NAT Gateway.
    State double
    NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    VpcId string
    The VPC ID for NAT Gateway.
    Bandwidth float64
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    Id string
    The ID for NAT Gateway.
    MaxConcurrent float64
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    Name string
    The name for NAT Gateway.
    State float64
    NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    VpcId string
    The VPC ID for NAT Gateway.
    bandwidth Double
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    id String
    The ID for NAT Gateway.
    maxConcurrent Double
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    name String
    The name for NAT Gateway.
    state Double
    NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    vpcId String
    The VPC ID for NAT Gateway.
    bandwidth number
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    id string
    The ID for NAT Gateway.
    maxConcurrent number
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    name string
    The name for NAT Gateway.
    state number
    NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    vpcId string
    The VPC ID for NAT Gateway.
    bandwidth float
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    id str
    The ID for NAT Gateway.
    max_concurrent float
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    name str
    The name for NAT Gateway.
    state float
    NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    vpc_id str
    The VPC ID for NAT Gateway.
    bandwidth Number
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    id String
    The ID for NAT Gateway.
    maxConcurrent Number
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    name String
    The name for NAT Gateway.
    state Number
    NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    vpcId String
    The VPC ID for NAT Gateway.

    getNats Result

    The following output properties are available:

    Nats List<GetNatsNat>
    Information list of the dedicated tunnels.
    Bandwidth double
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    Id string
    The ID for NAT Gateway.
    MaxConcurrent double
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    Name string
    The name for NAT Gateway.
    State double
    NAT gateway status, 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    VpcId string
    The VPC ID for NAT Gateway.
    Nats []GetNatsNat
    Information list of the dedicated tunnels.
    Bandwidth float64
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    Id string
    The ID for NAT Gateway.
    MaxConcurrent float64
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    Name string
    The name for NAT Gateway.
    State float64
    NAT gateway status, 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    VpcId string
    The VPC ID for NAT Gateway.
    nats List<GetNatsNat>
    Information list of the dedicated tunnels.
    bandwidth Double
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    id String
    The ID for NAT Gateway.
    maxConcurrent Double
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    name String
    The name for NAT Gateway.
    state Double
    NAT gateway status, 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    vpcId String
    The VPC ID for NAT Gateway.
    nats GetNatsNat[]
    Information list of the dedicated tunnels.
    bandwidth number
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    id string
    The ID for NAT Gateway.
    maxConcurrent number
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    name string
    The name for NAT Gateway.
    state number
    NAT gateway status, 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    vpcId string
    The VPC ID for NAT Gateway.
    nats Sequence[GetNatsNat]
    Information list of the dedicated tunnels.
    bandwidth float
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    id str
    The ID for NAT Gateway.
    max_concurrent float
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    name str
    The name for NAT Gateway.
    state float
    NAT gateway status, 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    vpc_id str
    The VPC ID for NAT Gateway.
    nats List<Property Map>
    Information list of the dedicated tunnels.
    bandwidth Number
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    id String
    The ID for NAT Gateway.
    maxConcurrent Number
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    name String
    The name for NAT Gateway.
    state Number
    NAT gateway status, 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    vpcId String
    The VPC ID for NAT Gateway.

    Supporting Types

    GetNatsNat

    AssignedEipSets List<string>
    Elastic IP arrays bound to the gateway.
    Bandwidth double
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    CreateTime string
    The create time of the NAT gateway.
    Id string
    The ID for NAT Gateway.
    MaxConcurrent double
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    Name string
    The name for NAT Gateway.
    State double
    NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    VpcId string
    The VPC ID for NAT Gateway.
    AssignedEipSets []string
    Elastic IP arrays bound to the gateway.
    Bandwidth float64
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    CreateTime string
    The create time of the NAT gateway.
    Id string
    The ID for NAT Gateway.
    MaxConcurrent float64
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    Name string
    The name for NAT Gateway.
    State float64
    NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    VpcId string
    The VPC ID for NAT Gateway.
    assignedEipSets List<String>
    Elastic IP arrays bound to the gateway.
    bandwidth Double
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    createTime String
    The create time of the NAT gateway.
    id String
    The ID for NAT Gateway.
    maxConcurrent Double
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    name String
    The name for NAT Gateway.
    state Double
    NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    vpcId String
    The VPC ID for NAT Gateway.
    assignedEipSets string[]
    Elastic IP arrays bound to the gateway.
    bandwidth number
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    createTime string
    The create time of the NAT gateway.
    id string
    The ID for NAT Gateway.
    maxConcurrent number
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    name string
    The name for NAT Gateway.
    state number
    NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    vpcId string
    The VPC ID for NAT Gateway.
    assigned_eip_sets Sequence[str]
    Elastic IP arrays bound to the gateway.
    bandwidth float
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    create_time str
    The create time of the NAT gateway.
    id str
    The ID for NAT Gateway.
    max_concurrent float
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    name str
    The name for NAT Gateway.
    state float
    NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    vpc_id str
    The VPC ID for NAT Gateway.
    assignedEipSets List<String>
    Elastic IP arrays bound to the gateway.
    bandwidth Number
    The maximum public network output bandwidth of the gateway (unit: Mbps), for example: 10, 20, 50, 100, 200, 500, 1000, 2000, 5000.
    createTime String
    The create time of the NAT gateway.
    id String
    The ID for NAT Gateway.
    maxConcurrent Number
    The upper limit of concurrent connection of NAT gateway, for example: 1000000, 3000000, 10000000.
    name String
    The name for NAT Gateway.
    state Number
    NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.
    vpcId String
    The VPC ID for NAT Gateway.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    Viewing docs for tencentcloud 1.82.73
    published on Friday, Mar 6, 2026 by tencentcloudstack
    Schema (JSON)
    tencentcloudstack/terraform-provider-tencentcloud
      Try Pulumi Cloud free. Your team will thank you.