Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Alibaba Cloud Provider
  4. API Docs
  5. apig
  6. getGateways
Viewing docs for Alibaba Cloud v3.108.0
published on Thursday, Sep 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

alicloud.apig.getGateways

alicloud logo alicloud logo
Viewing docs for Alibaba Cloud v3.108.0
published on Thursday, Sep 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

    This data source provides Apig Gateway available to the user.What is Gateway

    NOTE: Available since v1.284.0.

    Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = alicloud.resourcemanager.getResourceGroups({});
const defaultGetNetworks = alicloud.vpc.getNetworks({
    nameRegex: "^default-NODELETING$",
});
const defaultGetSwitches = defaultGetNetworks.then(defaultGetNetworks => alicloud.vpc.getSwitches({
    vpcId: defaultGetNetworks.ids?.[0],
}));
const defaultGateway = new alicloud.apig.Gateway("default", {
    networkAccessConfig: {
        type: "Intranet",
    },
    logConfig: {
        sls: {
            enable: false,
        },
    },
    resourceGroupId: _default.then(_default => _default.ids?.[1]),
    spec: "apigw.small.x1",
    vpc: {
        vpcId: defaultGetNetworks.then(defaultGetNetworks => defaultGetNetworks.ids?.[0]),
    },
    zoneConfig: {
        selectOption: "Auto",
    },
    vswitch: {
        vswitchId: defaultGetSwitches.then(defaultGetSwitches => defaultGetSwitches.ids?.[0]),
    },
    paymentType: "PayAsYouGo",
    gatewayName: name,
});
const defaultGetGateways = alicloud.apig.getGatewaysOutput({
    ids: [defaultGateway.id],
    nameRegex: defaultGateway.gatewayName,
    gatewayName: name,
});
export const alicloudApigGatewayExampleId = defaultGetGateways.apply(defaultGetGateways => defaultGetGateways.gateways?.[0]?.id);

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = alicloud.resourcemanager.get_resource_groups()
default_get_networks = alicloud.vpc.get_networks(name_regex="^default-NODELETING$")
default_get_switches = alicloud.vpc.get_switches(vpc_id=default_get_networks.ids[0])
default_gateway = alicloud.apig.Gateway("default",
    network_access_config={
        "type": "Intranet",
    },
    log_config={
        "sls": {
            "enable": False,
        },
    },
    resource_group_id=default.ids[1],
    spec="apigw.small.x1",
    vpc={
        "vpc_id": default_get_networks.ids[0],
    },
    zone_config={
        "select_option": "Auto",
    },
    vswitch={
        "vswitch_id": default_get_switches.ids[0],
    },
    payment_type="PayAsYouGo",
    gateway_name=name)
default_get_gateways = alicloud.apig.get_gateways_output(ids=[default_gateway.id],
    name_regex=default_gateway.gateway_name,
    gateway_name=name)
pulumi.export("alicloudApigGatewayExampleId", default_get_gateways.gateways[0].id)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apig"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{}, nil)
		if err != nil {
			return err
		}
		defaultGetNetworks, err := vpc.GetNetworks(ctx, &vpc.GetNetworksArgs{
			NameRegex: pulumi.StringRef("^default-NODELETING$"),
		}, nil)
		if err != nil {
			return err
		}
		defaultGetSwitches, err := vpc.GetSwitches(ctx, &vpc.GetSwitchesArgs{
			VpcId: pulumi.StringRef(defaultGetNetworks.Ids[0]),
		}, nil)
		if err != nil {
			return err
		}
		defaultGateway, err := apig.NewGateway(ctx, "default", &apig.GatewayArgs{
			NetworkAccessConfig: &apig.GatewayNetworkAccessConfigArgs{
				Type: pulumi.String("Intranet"),
			},
			LogConfig: &apig.GatewayLogConfigArgs{
				Sls: &apig.GatewayLogConfigSlsArgs{
					Enable: pulumi.Bool(false),
				},
			},
			ResourceGroupId: pulumi.String(_default.Ids[1]),
			Spec:            pulumi.String("apigw.small.x1"),
			Vpc: &apig.GatewayVpcArgs{
				VpcId: pulumi.String(defaultGetNetworks.Ids[0]),
			},
			ZoneConfig: &apig.GatewayZoneConfigArgs{
				SelectOption: pulumi.String("Auto"),
			},
			Vswitch: &apig.GatewayVswitchArgs{
				VswitchId: pulumi.String(defaultGetSwitches.Ids[0]),
			},
			PaymentType: pulumi.String("PayAsYouGo"),
			GatewayName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		defaultGetGateways := apig.GetGatewaysOutput(ctx, apig.GetGatewaysOutputArgs{
			Ids: pulumi.StringArray{
				defaultGateway.ID().ToIDOutput().ToStringOutput(),
			},
			NameRegex:   defaultGateway.GatewayName,
			GatewayName: pulumi.String(name),
		}, nil)
		ctx.Export("alicloudApigGatewayExampleId", defaultGetGateways.ApplyT(func(defaultGetGateways apig.GetGatewaysResult) (*string, error) {
			return defaultGetGateways.Gateways[0].Id, nil
		}).(pulumi.StringPtrOutput))
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var @default = AliCloud.ResourceManager.GetResourceGroups.Invoke();

    var defaultGetNetworks = AliCloud.Vpc.GetNetworks.Invoke(new()
    {
        NameRegex = "^default-NODELETING$",
    });

    var defaultGetSwitches = AliCloud.Vpc.GetSwitches.Invoke(new()
    {
        VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
    });

    var defaultGateway = new AliCloud.Apig.Gateway("default", new()
    {
        NetworkAccessConfig = new AliCloud.Apig.Inputs.GatewayNetworkAccessConfigArgs
        {
            Type = "Intranet",
        },
        LogConfig = new AliCloud.Apig.Inputs.GatewayLogConfigArgs
        {
            Sls = new AliCloud.Apig.Inputs.GatewayLogConfigSlsArgs
            {
                Enable = false,
            },
        },
        ResourceGroupId = @default.Apply(@default => @default.Apply(getResourceGroupsResult => getResourceGroupsResult.Ids[1])),
        Spec = "apigw.small.x1",
        Vpc = new AliCloud.Apig.Inputs.GatewayVpcArgs
        {
            VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
        },
        ZoneConfig = new AliCloud.Apig.Inputs.GatewayZoneConfigArgs
        {
            SelectOption = "Auto",
        },
        Vswitch = new AliCloud.Apig.Inputs.GatewayVswitchArgs
        {
            VswitchId = defaultGetSwitches.Apply(getSwitchesResult => getSwitchesResult.Ids[0]),
        },
        PaymentType = "PayAsYouGo",
        GatewayName = name,
    });

    var defaultGetGateways = AliCloud.Apig.GetGateways.Invoke(new()
    {
        Ids = new[]
        {
            defaultGateway.Id,
        },
        NameRegex = defaultGateway.GatewayName,
        GatewayName = name,
    });

    return new Dictionary<string, object?>
    {
        ["alicloudApigGatewayExampleId"] = defaultGetGateways.Apply(getGatewaysResult => getGatewaysResult.Gateways[0]?.Id),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.alicloud.vpc.VpcFunctions;
import com.pulumi.alicloud.vpc.inputs.GetNetworksArgs;
import com.pulumi.alicloud.vpc.inputs.GetSwitchesArgs;
import com.pulumi.alicloud.apig.Gateway;
import com.pulumi.alicloud.apig.GatewayArgs;
import com.pulumi.alicloud.apig.inputs.GatewayNetworkAccessConfigArgs;
import com.pulumi.alicloud.apig.inputs.GatewayLogConfigArgs;
import com.pulumi.alicloud.apig.inputs.GatewayLogConfigSlsArgs;
import com.pulumi.alicloud.apig.inputs.GatewayVpcArgs;
import com.pulumi.alicloud.apig.inputs.GatewayZoneConfigArgs;
import com.pulumi.alicloud.apig.inputs.GatewayVswitchArgs;
import com.pulumi.alicloud.apig.ApigFunctions;
import com.pulumi.alicloud.apig.inputs.GetGatewaysArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        final var default = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
            .build());

        final var defaultGetNetworks = VpcFunctions.getNetworks(GetNetworksArgs.builder()
            .nameRegex("^default-NODELETING$")
            .build());

        final var defaultGetSwitches = VpcFunctions.getSwitches(GetSwitchesArgs.builder()
            .vpcId(defaultGetNetworks.ids()[0])
            .build());

        var defaultGateway = new Gateway("defaultGateway", GatewayArgs.builder()
            .networkAccessConfig(GatewayNetworkAccessConfigArgs.builder()
                .type("Intranet")
                .build())
            .logConfig(GatewayLogConfigArgs.builder()
                .sls(GatewayLogConfigSlsArgs.builder()
                    .enable(false)
                    .build())
                .build())
            .resourceGroupId(default_.ids()[1])
            .spec("apigw.small.x1")
            .vpc(GatewayVpcArgs.builder()
                .vpcId(defaultGetNetworks.ids()[0])
                .build())
            .zoneConfig(GatewayZoneConfigArgs.builder()
                .selectOption("Auto")
                .build())
            .vswitch(GatewayVswitchArgs.builder()
                .vswitchId(defaultGetSwitches.ids()[0])
                .build())
            .paymentType("PayAsYouGo")
            .gatewayName(name)
            .build());

        final var defaultGetGateways = ApigFunctions.getGateways(GetGatewaysArgs.builder()
            .ids(defaultGateway.id())
            .nameRegex(defaultGateway.gatewayName())
            .gatewayName(name)
            .build());

        ctx.export("alicloudApigGatewayExampleId", defaultGetGateways.applyValue(_defaultGetGateways -> _defaultGetGateways.gateways()[0].id()));
    }
}

    configuration:
  name:
    type: string
    default: terraform-example
resources:
  defaultGateway:
    type: alicloud:apig:Gateway
    name: default
    properties:
      networkAccessConfig:
        type: Intranet
      logConfig:
        sls:
          enable: 'false'
      resourceGroupId: ${default.ids[1]}
      spec: apigw.small.x1
      vpc:
        vpcId: ${defaultGetNetworks.ids[0]}
      zoneConfig:
        selectOption: Auto
      vswitch:
        vswitchId: ${defaultGetSwitches.ids[0]}
      paymentType: PayAsYouGo
      gatewayName: ${name}
variables:
  default:
    fn::invoke:
      function: alicloud:resourcemanager:getResourceGroups
      arguments: {}
  defaultGetNetworks:
    fn::invoke:
      function: alicloud:vpc:getNetworks
      arguments:
        nameRegex: ^default-NODELETING$
  defaultGetSwitches:
    fn::invoke:
      function: alicloud:vpc:getSwitches
      arguments:
        vpcId: ${defaultGetNetworks.ids[0]}
  defaultGetGateways:
    fn::invoke:
      function: alicloud:apig:getGateways
      arguments:
        ids:
          - ${defaultGateway.id}
        nameRegex: ${defaultGateway.gatewayName}
        gatewayName: ${name}
outputs:
  alicloudApigGatewayExampleId: ${defaultGetGateways.gateways[0].id}

    pulumi {
  required_providers {
    alicloud = {
      source = "pulumi/alicloud"
    }
  }
}

data "alicloud_resourcemanager_getresourcegroups" "default" {
}
data "alicloud_vpc_getnetworks" "defaultGetNetworks" {
  name_regex = "^default-NODELETING$"
}
data "alicloud_vpc_getswitches" "defaultGetSwitches" {
  vpc_id = data.alicloud_vpc_getnetworks.defaultGetNetworks.ids[0]
}
data "alicloud_apig_getgateways" "defaultGetGateways" {
  ids          = [alicloud_apig_gateway.default.id]
  name_regex   = alicloud_apig_gateway.default.gateway_name
  gateway_name = var.name
}

resource "alicloud_apig_gateway" "default" {
  network_access_config = {
    type = "Intranet"
  }
  log_config = {
    sls = {
      enable = "false"
    }
  }
  resource_group_id = data.alicloud_resourcemanager_getresourcegroups.default.ids[1]
  spec              = "apigw.small.x1"
  vpc = {
    vpc_id = data.alicloud_vpc_getnetworks.defaultGetNetworks.ids[0]
  }
  zone_config = {
    select_option = "Auto"
  }
  vswitch = {
    vswitch_id = data.alicloud_vpc_getswitches.defaultGetSwitches.ids[0]
  }
  payment_type = "PayAsYouGo"
  gateway_name = var.name
}
variable "name" {
  type    = string
  default = "terraform-example"
}
output "alicloudApigGatewayExampleId" {
  value = data.alicloud_apig_getgateways.defaultGetGateways.gateways[0].id
}

    Using getGateways

    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 getGateways(args: GetGatewaysArgs, opts?: InvokeOptions): Promise<GetGatewaysResult>
function getGatewaysOutput(args: GetGatewaysOutputArgs, opts?: InvokeOutputOptions): Output<GetGatewaysResult>
    def get_gateways(enable_details: Optional[bool] = None,
                 gateway_id: Optional[str] = None,
                 gateway_name: Optional[str] = None,
                 ids: Optional[Sequence[str]] = None,
                 name_regex: Optional[str] = None,
                 output_file: Optional[str] = None,
                 resource_group_id: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetGatewaysResult
def get_gateways_output(enable_details: pulumi.Input[Optional[bool]] = None,
                 gateway_id: pulumi.Input[Optional[str]] = None,
                 gateway_name: pulumi.Input[Optional[str]] = None,
                 ids: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
                 name_regex: pulumi.Input[Optional[str]] = None,
                 output_file: pulumi.Input[Optional[str]] = None,
                 resource_group_id: pulumi.Input[Optional[str]] = None,
                 tags: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOutputOptions] = None) -> Output[GetGatewaysResult]
    func GetGateways(ctx *Context, args *GetGatewaysArgs, opts ...InvokeOption) (*GetGatewaysResult, error)
func GetGatewaysOutput(ctx *Context, args *GetGatewaysOutputArgs, opts ...InvokeOption) GetGatewaysResultOutput

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

    public static class GetGateways 
{
    public static Task<GetGatewaysResult> InvokeAsync(GetGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewaysResult> Invoke(GetGatewaysInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewaysResult> Invoke(GetGatewaysInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetGatewaysResult> getGateways(GetGatewaysArgs args, InvokeOptions options)
public static Output<GetGatewaysResult> getGateways(GetGatewaysArgs args, InvokeOptions options)
public static Output<GetGatewaysResult> getGateways(GetGatewaysArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: alicloud:apig/getGateways:getGateways
  arguments:
    # arguments dictionary
    data "alicloud_apig_get_gateways" "name" {
    # arguments
}

    The following arguments are supported:

    EnableDetails bool
    Default to false. Set it to true can output more details about resource attributes.
    GatewayId string
    Cloud-native API gateway ID.
    GatewayName string
    The name of the gateway.
    Ids List<string>
    A list of Gateway IDs.
    NameRegex string
    A regex string to filter results by Gateway name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    ResourceGroupId string
    The ID of the resource group.
    Tags Dictionary<string, string>
    The tag of the resource.
    EnableDetails bool
    Default to false. Set it to true can output more details about resource attributes.
    GatewayId string
    Cloud-native API gateway ID.
    GatewayName string
    The name of the gateway.
    Ids []string
    A list of Gateway IDs.
    NameRegex string
    A regex string to filter results by Gateway name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    ResourceGroupId string
    The ID of the resource group.
    Tags map[string]string
    The tag of the resource.
    enable_details bool
    Default to false. Set it to true can output more details about resource attributes.
    gateway_id string
    Cloud-native API gateway ID.
    gateway_name string
    The name of the gateway.
    ids list(string)
    A list of Gateway IDs.
    name_regex string
    A regex string to filter results by Gateway name.
    output_file string
    File name where to save data source results (after running pulumi preview).
    resource_group_id string
    The ID of the resource group.
    tags map(string)
    The tag of the resource.
    enableDetails Boolean
    Default to false. Set it to true can output more details about resource attributes.
    gatewayId String
    Cloud-native API gateway ID.
    gatewayName String
    The name of the gateway.
    ids List<String>
    A list of Gateway IDs.
    nameRegex String
    A regex string to filter results by Gateway name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    resourceGroupId String
    The ID of the resource group.
    tags Map<String,String>
    The tag of the resource.
    enableDetails boolean
    Default to false. Set it to true can output more details about resource attributes.
    gatewayId string
    Cloud-native API gateway ID.
    gatewayName string
    The name of the gateway.
    ids string[]
    A list of Gateway IDs.
    nameRegex string
    A regex string to filter results by Gateway name.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    resourceGroupId string
    The ID of the resource group.
    tags {[key: string]: string}
    The tag of the resource.
    enable_details bool
    Default to false. Set it to true can output more details about resource attributes.
    gateway_id str
    Cloud-native API gateway ID.
    gateway_name str
    The name of the gateway.
    ids Sequence[str]
    A list of Gateway IDs.
    name_regex str
    A regex string to filter results by Gateway name.
    output_file str
    File name where to save data source results (after running pulumi preview).
    resource_group_id str
    The ID of the resource group.
    tags Mapping[str, str]
    The tag of the resource.
    enableDetails Boolean
    Default to false. Set it to true can output more details about resource attributes.
    gatewayId String
    Cloud-native API gateway ID.
    gatewayName String
    The name of the gateway.
    ids List<String>
    A list of Gateway IDs.
    nameRegex String
    A regex string to filter results by Gateway name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    resourceGroupId String
    The ID of the resource group.
    tags Map<String>
    The tag of the resource.

    getGateways Result

    The following output properties are available:

    Gateways List<Pulumi.AliCloud.Apig.Outputs.GetGatewaysGateway>
    A list of Gateway Entries. Each element contains the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    A list of Gateway IDs.
    Names List<string>
    A list of name of Gateways.
    EnableDetails bool
    GatewayId string
    Cloud-native API gateway ID.
    GatewayName string
    Query by exact match of the gateway name.
    NameRegex string
    OutputFile string
    ResourceGroupId string
    The ID of the destination resource group.
    Tags Dictionary<string, string>
    The tag of the resource.
    Gateways []GetGatewaysGateway
    A list of Gateway Entries. Each element contains the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    A list of Gateway IDs.
    Names []string
    A list of name of Gateways.
    EnableDetails bool
    GatewayId string
    Cloud-native API gateway ID.
    GatewayName string
    Query by exact match of the gateway name.
    NameRegex string
    OutputFile string
    ResourceGroupId string
    The ID of the destination resource group.
    Tags map[string]string
    The tag of the resource.
    gateways list(object)
    A list of Gateway Entries. Each element contains the following attributes:
    id string
    The provider-assigned unique ID for this managed resource.
    ids list(string)
    A list of Gateway IDs.
    names list(string)
    A list of name of Gateways.
    enable_details bool
    gateway_id string
    Cloud-native API gateway ID.
    gateway_name string
    Query by exact match of the gateway name.
    name_regex string
    output_file string
    resource_group_id string
    The ID of the destination resource group.
    tags map(string)
    The tag of the resource.
    gateways List<GetGatewaysGateway>
    A list of Gateway Entries. Each element contains the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of Gateway IDs.
    names List<String>
    A list of name of Gateways.
    enableDetails Boolean
    gatewayId String
    Cloud-native API gateway ID.
    gatewayName String
    Query by exact match of the gateway name.
    nameRegex String
    outputFile String
    resourceGroupId String
    The ID of the destination resource group.
    tags Map<String,String>
    The tag of the resource.
    gateways GetGatewaysGateway[]
    A list of Gateway Entries. Each element contains the following attributes:
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    A list of Gateway IDs.
    names string[]
    A list of name of Gateways.
    enableDetails boolean
    gatewayId string
    Cloud-native API gateway ID.
    gatewayName string
    Query by exact match of the gateway name.
    nameRegex string
    outputFile string
    resourceGroupId string
    The ID of the destination resource group.
    tags {[key: string]: string}
    The tag of the resource.
    gateways Sequence[GetGatewaysGateway]
    A list of Gateway Entries. Each element contains the following attributes:
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    A list of Gateway IDs.
    names Sequence[str]
    A list of name of Gateways.
    enable_details bool
    gateway_id str
    Cloud-native API gateway ID.
    gateway_name str
    Query by exact match of the gateway name.
    name_regex str
    output_file str
    resource_group_id str
    The ID of the destination resource group.
    tags Mapping[str, str]
    The tag of the resource.
    gateways List<Property Map>
    A list of Gateway Entries. Each element contains the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of Gateway IDs.
    names List<String>
    A list of name of Gateways.
    enableDetails Boolean
    gatewayId String
    Cloud-native API gateway ID.
    gatewayName String
    Query by exact match of the gateway name.
    nameRegex String
    outputFile String
    resourceGroupId String
    The ID of the destination resource group.
    tags Map<String>
    The tag of the resource.

    Supporting Types

    GetGatewaysGateway

    CreateFrom string
    The source from which the gateway was created.
    CreateTime int
    Creation timestamp.
    Environments List<Pulumi.AliCloud.Apig.Inputs.GetGatewaysGatewayEnvironment>
    NOTE: This field is only available when enableDetails is true. The list of environments associated with the gateway.
    ExpireTime int
    Timestamp indicating when the subscription expires.
    GatewayEdition string
    Gateway instance edition:.
    GatewayId string
    Cloud-native API gateway ID.
    GatewayName string
    The name of the gateway.
    GatewayType string
    The gateway type.
    Id string
    The ID of the resource supplied above.
    LoadBalancers List<Pulumi.AliCloud.Apig.Inputs.GetGatewaysGatewayLoadBalancer>
    The list of Gateway ingress addresses.
    PaymentType string
    Payment type:.
    ResourceGroupId string
    The ID of the resource group.
    SecurityGroups List<Pulumi.AliCloud.Apig.Inputs.GetGatewaysGatewaySecurityGroup>
    Security group of the gateway.
    Spec string
    Gateway specification:.
    Status string
    Gateway status:.
    SubDomainInfos List<Pulumi.AliCloud.Apig.Inputs.GetGatewaysGatewaySubDomainInfo>
    List of second-level domain names.
    Tags Dictionary<string, string>
    The tag of the resource.
    TargetVersion string
    The target version of the gateway instance.
    UpdateTime int
    The timestamp when the resource was last updated.
    Version string
    The current running version of the gateway instance.
    Vpcs List<Pulumi.AliCloud.Apig.Inputs.GetGatewaysGatewayVpc>
    The Virtual Private Cloud (VPC) associated with the gateway.
    Vswitches List<Pulumi.AliCloud.Apig.Inputs.GetGatewaysGatewayVswitch>
    NOTE: This field is only available when enableDetails is true. The vSwitch associated with the gateway.
    Zones List<Pulumi.AliCloud.Apig.Inputs.GetGatewaysGatewayZone>
    The list of zones associated with the gateway.
    CreateFrom string
    The source from which the gateway was created.
    CreateTime int
    Creation timestamp.
    Environments []GetGatewaysGatewayEnvironment
    NOTE: This field is only available when enableDetails is true. The list of environments associated with the gateway.
    ExpireTime int
    Timestamp indicating when the subscription expires.
    GatewayEdition string
    Gateway instance edition:.
    GatewayId string
    Cloud-native API gateway ID.
    GatewayName string
    The name of the gateway.
    GatewayType string
    The gateway type.
    Id string
    The ID of the resource supplied above.
    LoadBalancers []GetGatewaysGatewayLoadBalancer
    The list of Gateway ingress addresses.
    PaymentType string
    Payment type:.
    ResourceGroupId string
    The ID of the resource group.
    SecurityGroups []GetGatewaysGatewaySecurityGroup
    Security group of the gateway.
    Spec string
    Gateway specification:.
    Status string
    Gateway status:.
    SubDomainInfos []GetGatewaysGatewaySubDomainInfo
    List of second-level domain names.
    Tags map[string]string
    The tag of the resource.
    TargetVersion string
    The target version of the gateway instance.
    UpdateTime int
    The timestamp when the resource was last updated.
    Version string
    The current running version of the gateway instance.
    Vpcs []GetGatewaysGatewayVpc
    The Virtual Private Cloud (VPC) associated with the gateway.
    Vswitches []GetGatewaysGatewayVswitch
    NOTE: This field is only available when enableDetails is true. The vSwitch associated with the gateway.
    Zones []GetGatewaysGatewayZone
    The list of zones associated with the gateway.
    create_from string
    The source from which the gateway was created.
    create_time number
    Creation timestamp.
    environments list(object)
    NOTE: This field is only available when enableDetails is true. The list of environments associated with the gateway.
    expire_time number
    Timestamp indicating when the subscription expires.
    gateway_edition string
    Gateway instance edition:.
    gateway_id string
    Cloud-native API gateway ID.
    gateway_name string
    The name of the gateway.
    gateway_type string
    The gateway type.
    id string
    The ID of the resource supplied above.
    load_balancers list(object)
    The list of Gateway ingress addresses.
    payment_type string
    Payment type:.
    resource_group_id string
    The ID of the resource group.
    security_groups list(object)
    Security group of the gateway.
    spec string
    Gateway specification:.
    status string
    Gateway status:.
    sub_domain_infos list(object)
    List of second-level domain names.
    tags map(string)
    The tag of the resource.
    target_version string
    The target version of the gateway instance.
    update_time number
    The timestamp when the resource was last updated.
    version string
    The current running version of the gateway instance.
    vpcs list(object)
    The Virtual Private Cloud (VPC) associated with the gateway.
    vswitches list(object)
    NOTE: This field is only available when enableDetails is true. The vSwitch associated with the gateway.
    zones list(object)
    The list of zones associated with the gateway.
    createFrom String
    The source from which the gateway was created.
    createTime Integer
    Creation timestamp.
    environments List<GetGatewaysGatewayEnvironment>
    NOTE: This field is only available when enableDetails is true. The list of environments associated with the gateway.
    expireTime Integer
    Timestamp indicating when the subscription expires.
    gatewayEdition String
    Gateway instance edition:.
    gatewayId String
    Cloud-native API gateway ID.
    gatewayName String
    The name of the gateway.
    gatewayType String
    The gateway type.
    id String
    The ID of the resource supplied above.
    loadBalancers List<GetGatewaysGatewayLoadBalancer>
    The list of Gateway ingress addresses.
    paymentType String
    Payment type:.
    resourceGroupId String
    The ID of the resource group.
    securityGroups List<GetGatewaysGatewaySecurityGroup>
    Security group of the gateway.
    spec String
    Gateway specification:.
    status String
    Gateway status:.
    subDomainInfos List<GetGatewaysGatewaySubDomainInfo>
    List of second-level domain names.
    tags Map<String,String>
    The tag of the resource.
    targetVersion String
    The target version of the gateway instance.
    updateTime Integer
    The timestamp when the resource was last updated.
    version String
    The current running version of the gateway instance.
    vpcs List<GetGatewaysGatewayVpc>
    The Virtual Private Cloud (VPC) associated with the gateway.
    vswitches List<GetGatewaysGatewayVswitch>
    NOTE: This field is only available when enableDetails is true. The vSwitch associated with the gateway.
    zones List<GetGatewaysGatewayZone>
    The list of zones associated with the gateway.
    createFrom string
    The source from which the gateway was created.
    createTime number
    Creation timestamp.
    environments GetGatewaysGatewayEnvironment[]
    NOTE: This field is only available when enableDetails is true. The list of environments associated with the gateway.
    expireTime number
    Timestamp indicating when the subscription expires.
    gatewayEdition string
    Gateway instance edition:.
    gatewayId string
    Cloud-native API gateway ID.
    gatewayName string
    The name of the gateway.
    gatewayType string
    The gateway type.
    id string
    The ID of the resource supplied above.
    loadBalancers GetGatewaysGatewayLoadBalancer[]
    The list of Gateway ingress addresses.
    paymentType string
    Payment type:.
    resourceGroupId string
    The ID of the resource group.
    securityGroups GetGatewaysGatewaySecurityGroup[]
    Security group of the gateway.
    spec string
    Gateway specification:.
    status string
    Gateway status:.
    subDomainInfos GetGatewaysGatewaySubDomainInfo[]
    List of second-level domain names.
    tags {[key: string]: string}
    The tag of the resource.
    targetVersion string
    The target version of the gateway instance.
    updateTime number
    The timestamp when the resource was last updated.
    version string
    The current running version of the gateway instance.
    vpcs GetGatewaysGatewayVpc[]
    The Virtual Private Cloud (VPC) associated with the gateway.
    vswitches GetGatewaysGatewayVswitch[]
    NOTE: This field is only available when enableDetails is true. The vSwitch associated with the gateway.
    zones GetGatewaysGatewayZone[]
    The list of zones associated with the gateway.
    create_from str
    The source from which the gateway was created.
    create_time int
    Creation timestamp.
    environments Sequence[GetGatewaysGatewayEnvironment]
    NOTE: This field is only available when enableDetails is true. The list of environments associated with the gateway.
    expire_time int
    Timestamp indicating when the subscription expires.
    gateway_edition str
    Gateway instance edition:.
    gateway_id str
    Cloud-native API gateway ID.
    gateway_name str
    The name of the gateway.
    gateway_type str
    The gateway type.
    id str
    The ID of the resource supplied above.
    load_balancers Sequence[GetGatewaysGatewayLoadBalancer]
    The list of Gateway ingress addresses.
    payment_type str
    Payment type:.
    resource_group_id str
    The ID of the resource group.
    security_groups Sequence[GetGatewaysGatewaySecurityGroup]
    Security group of the gateway.
    spec str
    Gateway specification:.
    status str
    Gateway status:.
    sub_domain_infos Sequence[GetGatewaysGatewaySubDomainInfo]
    List of second-level domain names.
    tags Mapping[str, str]
    The tag of the resource.
    target_version str
    The target version of the gateway instance.
    update_time int
    The timestamp when the resource was last updated.
    version str
    The current running version of the gateway instance.
    vpcs Sequence[GetGatewaysGatewayVpc]
    The Virtual Private Cloud (VPC) associated with the gateway.
    vswitches Sequence[GetGatewaysGatewayVswitch]
    NOTE: This field is only available when enableDetails is true. The vSwitch associated with the gateway.
    zones Sequence[GetGatewaysGatewayZone]
    The list of zones associated with the gateway.
    createFrom String
    The source from which the gateway was created.
    createTime Number
    Creation timestamp.
    environments List<Property Map>
    NOTE: This field is only available when enableDetails is true. The list of environments associated with the gateway.
    expireTime Number
    Timestamp indicating when the subscription expires.
    gatewayEdition String
    Gateway instance edition:.
    gatewayId String
    Cloud-native API gateway ID.
    gatewayName String
    The name of the gateway.
    gatewayType String
    The gateway type.
    id String
    The ID of the resource supplied above.
    loadBalancers List<Property Map>
    The list of Gateway ingress addresses.
    paymentType String
    Payment type:.
    resourceGroupId String
    The ID of the resource group.
    securityGroups List<Property Map>
    Security group of the gateway.
    spec String
    Gateway specification:.
    status String
    Gateway status:.
    subDomainInfos List<Property Map>
    List of second-level domain names.
    tags Map<String>
    The tag of the resource.
    targetVersion String
    The target version of the gateway instance.
    updateTime Number
    The timestamp when the resource was last updated.
    version String
    The current running version of the gateway instance.
    vpcs List<Property Map>
    The Virtual Private Cloud (VPC) associated with the gateway.
    vswitches List<Property Map>
    NOTE: This field is only available when enableDetails is true. The vSwitch associated with the gateway.
    zones List<Property Map>
    The list of zones associated with the gateway.

    GetGatewaysGatewayEnvironment

    Alias string
    The alias of the environment.
    EnvironmentId string
    The ID of the environment.
    Name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    Alias string
    The alias of the environment.
    EnvironmentId string
    The ID of the environment.
    Name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    alias string
    The alias of the environment.
    environment_id string
    The ID of the environment.
    name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    alias String
    The alias of the environment.
    environmentId String
    The ID of the environment.
    name String
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    alias string
    The alias of the environment.
    environmentId string
    The ID of the environment.
    name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    alias str
    The alias of the environment.
    environment_id str
    The ID of the environment.
    name str
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    alias String
    The alias of the environment.
    environmentId String
    The ID of the environment.
    name String
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.

    GetGatewaysGatewayLoadBalancer

    Address string
    The address of the load balancer for the gateway.
    AddressIpVersion string
    IP version:.
    AddressType string
    Load balancer address type:.
    GatewayDefault bool
    Indicates whether this is the default ingress address of the gateway.
    Ipv4Addresses List<string>
    The list of IPv4 addresses.
    Ipv6Addresses List<string>
    The list of IPv6 addresses.
    LoadBalancerId string
    The ID of the load balancer associated with the gateway.
    Mode string
    Load balancing provisioning mode for the gateway:.
    Ports List<Pulumi.AliCloud.Apig.Inputs.GetGatewaysGatewayLoadBalancerPort>
    The list of listening ports.
    Status string
    Gateway status:.
    Type string
    Load balancer type:.
    Address string
    The address of the load balancer for the gateway.
    AddressIpVersion string
    IP version:.
    AddressType string
    Load balancer address type:.
    GatewayDefault bool
    Indicates whether this is the default ingress address of the gateway.
    Ipv4Addresses []string
    The list of IPv4 addresses.
    Ipv6Addresses []string
    The list of IPv6 addresses.
    LoadBalancerId string
    The ID of the load balancer associated with the gateway.
    Mode string
    Load balancing provisioning mode for the gateway:.
    Ports []GetGatewaysGatewayLoadBalancerPort
    The list of listening ports.
    Status string
    Gateway status:.
    Type string
    Load balancer type:.
    address string
    The address of the load balancer for the gateway.
    address_ip_version string
    IP version:.
    address_type string
    Load balancer address type:.
    gateway_default bool
    Indicates whether this is the default ingress address of the gateway.
    ipv4_addresses list(string)
    The list of IPv4 addresses.
    ipv6_addresses list(string)
    The list of IPv6 addresses.
    load_balancer_id string
    The ID of the load balancer associated with the gateway.
    mode string
    Load balancing provisioning mode for the gateway:.
    ports list(object)
    The list of listening ports.
    status string
    Gateway status:.
    type string
    Load balancer type:.
    address String
    The address of the load balancer for the gateway.
    addressIpVersion String
    IP version:.
    addressType String
    Load balancer address type:.
    gatewayDefault Boolean
    Indicates whether this is the default ingress address of the gateway.
    ipv4Addresses List<String>
    The list of IPv4 addresses.
    ipv6Addresses List<String>
    The list of IPv6 addresses.
    loadBalancerId String
    The ID of the load balancer associated with the gateway.
    mode String
    Load balancing provisioning mode for the gateway:.
    ports List<GetGatewaysGatewayLoadBalancerPort>
    The list of listening ports.
    status String
    Gateway status:.
    type String
    Load balancer type:.
    address string
    The address of the load balancer for the gateway.
    addressIpVersion string
    IP version:.
    addressType string
    Load balancer address type:.
    gatewayDefault boolean
    Indicates whether this is the default ingress address of the gateway.
    ipv4Addresses string[]
    The list of IPv4 addresses.
    ipv6Addresses string[]
    The list of IPv6 addresses.
    loadBalancerId string
    The ID of the load balancer associated with the gateway.
    mode string
    Load balancing provisioning mode for the gateway:.
    ports GetGatewaysGatewayLoadBalancerPort[]
    The list of listening ports.
    status string
    Gateway status:.
    type string
    Load balancer type:.
    address str
    The address of the load balancer for the gateway.
    address_ip_version str
    IP version:.
    address_type str
    Load balancer address type:.
    gateway_default bool
    Indicates whether this is the default ingress address of the gateway.
    ipv4_addresses Sequence[str]
    The list of IPv4 addresses.
    ipv6_addresses Sequence[str]
    The list of IPv6 addresses.
    load_balancer_id str
    The ID of the load balancer associated with the gateway.
    mode str
    Load balancing provisioning mode for the gateway:.
    ports Sequence[GetGatewaysGatewayLoadBalancerPort]
    The list of listening ports.
    status str
    Gateway status:.
    type str
    Load balancer type:.
    address String
    The address of the load balancer for the gateway.
    addressIpVersion String
    IP version:.
    addressType String
    Load balancer address type:.
    gatewayDefault Boolean
    Indicates whether this is the default ingress address of the gateway.
    ipv4Addresses List<String>
    The list of IPv4 addresses.
    ipv6Addresses List<String>
    The list of IPv6 addresses.
    loadBalancerId String
    The ID of the load balancer associated with the gateway.
    mode String
    Load balancing provisioning mode for the gateway:.
    ports List<Property Map>
    The list of listening ports.
    status String
    Gateway status:.
    type String
    Load balancer type:.

    GetGatewaysGatewayLoadBalancerPort

    Port int
    The port number of the load balancer listener.
    Protocol string
    The protocol used by the secondary domain name.
    Port int
    The port number of the load balancer listener.
    Protocol string
    The protocol used by the secondary domain name.
    port number
    The port number of the load balancer listener.
    protocol string
    The protocol used by the secondary domain name.
    port Integer
    The port number of the load balancer listener.
    protocol String
    The protocol used by the secondary domain name.
    port number
    The port number of the load balancer listener.
    protocol string
    The protocol used by the secondary domain name.
    port int
    The port number of the load balancer listener.
    protocol str
    The protocol used by the secondary domain name.
    port Number
    The port number of the load balancer listener.
    protocol String
    The protocol used by the secondary domain name.

    GetGatewaysGatewaySecurityGroup

    Name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    SecurityGroupId string
    The ID of the security group.
    Name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    SecurityGroupId string
    The ID of the security group.
    name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    security_group_id string
    The ID of the security group.
    name String
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    securityGroupId String
    The ID of the security group.
    name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    securityGroupId string
    The ID of the security group.
    name str
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    security_group_id str
    The ID of the security group.
    name String
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    securityGroupId String
    The ID of the security group.

    GetGatewaysGatewaySubDomainInfo

    DomainId string
    The ID of the secondary domain name for the gateway.
    Name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    NetworkType string
    Network type:.
    Protocol string
    The protocol used by the secondary domain name.
    DomainId string
    The ID of the secondary domain name for the gateway.
    Name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    NetworkType string
    Network type:.
    Protocol string
    The protocol used by the secondary domain name.
    domain_id string
    The ID of the secondary domain name for the gateway.
    name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    network_type string
    Network type:.
    protocol string
    The protocol used by the secondary domain name.
    domainId String
    The ID of the secondary domain name for the gateway.
    name String
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    networkType String
    Network type:.
    protocol String
    The protocol used by the secondary domain name.
    domainId string
    The ID of the secondary domain name for the gateway.
    name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    networkType string
    Network type:.
    protocol string
    The protocol used by the secondary domain name.
    domain_id str
    The ID of the secondary domain name for the gateway.
    name str
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    network_type str
    Network type:.
    protocol str
    The protocol used by the secondary domain name.
    domainId String
    The ID of the secondary domain name for the gateway.
    name String
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    networkType String
    Network type:.
    protocol String
    The protocol used by the secondary domain name.

    GetGatewaysGatewayVpc

    Name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    VpcId string
    The ID of the VPC network associated with the gateway.
    Name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    VpcId string
    The ID of the VPC network associated with the gateway.
    name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vpc_id string
    The ID of the VPC network associated with the gateway.
    name String
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vpcId String
    The ID of the VPC network associated with the gateway.
    name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vpcId string
    The ID of the VPC network associated with the gateway.
    name str
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vpc_id str
    The ID of the VPC network associated with the gateway.
    name String
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vpcId String
    The ID of the VPC network associated with the gateway.

    GetGatewaysGatewayVswitch

    Name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    VswitchId string
    The ID of the virtual switch in the availability zone.
    Name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    VswitchId string
    The ID of the virtual switch in the availability zone.
    name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vswitch_id string
    The ID of the virtual switch in the availability zone.
    name String
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vswitchId String
    The ID of the virtual switch in the availability zone.
    name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vswitchId string
    The ID of the virtual switch in the availability zone.
    name str
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vswitch_id str
    The ID of the virtual switch in the availability zone.
    name String
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vswitchId String
    The ID of the virtual switch in the availability zone.

    GetGatewaysGatewayZone

    Name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    VswitchId string
    The ID of the virtual switch in the availability zone.
    ZoneId string
    The ID of the availability zone for the gateway.
    Name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    VswitchId string
    The ID of the virtual switch in the availability zone.
    ZoneId string
    The ID of the availability zone for the gateway.
    name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vswitch_id string
    The ID of the virtual switch in the availability zone.
    zone_id string
    The ID of the availability zone for the gateway.
    name String
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vswitchId String
    The ID of the virtual switch in the availability zone.
    zoneId String
    The ID of the availability zone for the gateway.
    name string
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vswitchId string
    The ID of the virtual switch in the availability zone.
    zoneId string
    The ID of the availability zone for the gateway.
    name str
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vswitch_id str
    The ID of the virtual switch in the availability zone.
    zone_id str
    The ID of the availability zone for the gateway.
    name String
    NOTE: This field is only available when enableDetails is true. The name of the availability zone for the gateway.
    vswitchId String
    The ID of the virtual switch in the availability zone.
    zoneId String
    The ID of the availability zone for the gateway.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo alicloud logo
    Viewing docs for Alibaba Cloud v3.108.0
    published on Thursday, Sep 17, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-alicloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial