1. Packages
  2. Volcengine
  3. API Docs
  4. apig
  5. getGateways
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.apig.getGateways

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of apig gateways

    Example Usage

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

const foo = volcengine.apig.getGateways({
    ids: [
        "gd13d8c6eq1emkiunq6p0",
        "gd07fq7pte3scmnaj1b1g",
    ],
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.apig.get_gateways(ids=[
    "gd13d8c6eq1emkiunq6p0",
    "gd07fq7pte3scmnaj1b1g",
])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/apig"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apig.GetGateways(ctx, &apig.GetGatewaysArgs{
			Ids: []string{
				"gd13d8c6eq1emkiunq6p0",
				"gd07fq7pte3scmnaj1b1g",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Apig.GetGateways.Invoke(new()
    {
        Ids = new[]
        {
            "gd13d8c6eq1emkiunq6p0",
            "gd07fq7pte3scmnaj1b1g",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.apig.ApigFunctions;
import com.pulumi.volcengine.apig.inputs.GetGatewaysArgs;
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 foo = ApigFunctions.getGateways(GetGatewaysArgs.builder()
            .ids(            
                "gd13d8c6eq1emkiunq6p0",
                "gd07fq7pte3scmnaj1b1g")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:apig:getGateways
      Arguments:
        ids:
          - gd13d8c6eq1emkiunq6p0
          - gd07fq7pte3scmnaj1b1g

    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?: InvokeOptions): Output<GetGatewaysResult>
    def get_gateways(ids: Optional[Sequence[str]] = None,
                 name: Optional[str] = None,
                 name_regex: Optional[str] = None,
                 output_file: Optional[str] = None,
                 project_name: Optional[str] = None,
                 status: Optional[str] = None,
                 tags: Optional[Sequence[GetGatewaysTag]] = None,
                 type: Optional[str] = None,
                 vpc_ids: Optional[Sequence[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetGatewaysResult
def get_gateways_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 name_regex: Optional[pulumi.Input[str]] = None,
                 output_file: Optional[pulumi.Input[str]] = None,
                 project_name: Optional[pulumi.Input[str]] = None,
                 status: Optional[pulumi.Input[str]] = None,
                 tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetGatewaysTagArgs]]]] = None,
                 type: Optional[pulumi.Input[str]] = None,
                 vpc_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOptions] = 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 CompletableFuture<GetGatewaysResult> getGateways(GetGatewaysArgs args, InvokeOptions options)
public static Output<GetGatewaysResult> getGateways(GetGatewaysArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:apig/getGateways:getGateways
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of api gateway IDs.
    Name string
    The name of api gateway. This field support fuzzy query.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name of api gateway.
    Status string
    The status of api gateway.
    Tags List<GetGatewaysTag>
    Tags.
    Type string
    The type of api gateway.
    VpcIds List<string>
    A list of vpc IDs.
    Ids []string
    A list of api gateway IDs.
    Name string
    The name of api gateway. This field support fuzzy query.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name of api gateway.
    Status string
    The status of api gateway.
    Tags []GetGatewaysTag
    Tags.
    Type string
    The type of api gateway.
    VpcIds []string
    A list of vpc IDs.
    ids List<String>
    A list of api gateway IDs.
    name String
    The name of api gateway. This field support fuzzy query.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name of api gateway.
    status String
    The status of api gateway.
    tags List<GetGatewaysTag>
    Tags.
    type String
    The type of api gateway.
    vpcIds List<String>
    A list of vpc IDs.
    ids string[]
    A list of api gateway IDs.
    name string
    The name of api gateway. This field support fuzzy query.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    projectName string
    The project name of api gateway.
    status string
    The status of api gateway.
    tags GetGatewaysTag[]
    Tags.
    type string
    The type of api gateway.
    vpcIds string[]
    A list of vpc IDs.
    ids Sequence[str]
    A list of api gateway IDs.
    name str
    The name of api gateway. This field support fuzzy query.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    project_name str
    The project name of api gateway.
    status str
    The status of api gateway.
    tags Sequence[GetGatewaysTag]
    Tags.
    type str
    The type of api gateway.
    vpc_ids Sequence[str]
    A list of vpc IDs.
    ids List<String>
    A list of api gateway IDs.
    name String
    The name of api gateway. This field support fuzzy query.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name of api gateway.
    status String
    The status of api gateway.
    tags List<Property Map>
    Tags.
    type String
    The type of api gateway.
    vpcIds List<String>
    A list of vpc IDs.

    getGateways Result

    The following output properties are available:

    Gateways List<GetGatewaysGateway>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    Ids List<string>
    Name string
    The name of the api gateway.
    NameRegex string
    OutputFile string
    ProjectName string
    The project name of the api gateway.
    Status string
    The status of the api gateway.
    Tags List<GetGatewaysTag>
    Tags.
    Type string
    The type of the api gateway.
    VpcIds List<string>
    Gateways []GetGatewaysGateway
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    Ids []string
    Name string
    The name of the api gateway.
    NameRegex string
    OutputFile string
    ProjectName string
    The project name of the api gateway.
    Status string
    The status of the api gateway.
    Tags []GetGatewaysTag
    Tags.
    Type string
    The type of the api gateway.
    VpcIds []string
    gateways List<GetGatewaysGateway>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    ids List<String>
    name String
    The name of the api gateway.
    nameRegex String
    outputFile String
    projectName String
    The project name of the api gateway.
    status String
    The status of the api gateway.
    tags List<GetGatewaysTag>
    Tags.
    type String
    The type of the api gateway.
    vpcIds List<String>
    gateways GetGatewaysGateway[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    ids string[]
    name string
    The name of the api gateway.
    nameRegex string
    outputFile string
    projectName string
    The project name of the api gateway.
    status string
    The status of the api gateway.
    tags GetGatewaysTag[]
    Tags.
    type string
    The type of the api gateway.
    vpcIds string[]
    gateways Sequence[GetGatewaysGateway]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    ids Sequence[str]
    name str
    The name of the api gateway.
    name_regex str
    output_file str
    project_name str
    The project name of the api gateway.
    status str
    The status of the api gateway.
    tags Sequence[GetGatewaysTag]
    Tags.
    type str
    The type of the api gateway.
    vpc_ids Sequence[str]
    gateways List<Property Map>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    ids List<String>
    name String
    The name of the api gateway.
    nameRegex String
    outputFile String
    projectName String
    The project name of the api gateway.
    status String
    The status of the api gateway.
    tags List<Property Map>
    Tags.
    type String
    The type of the api gateway.
    vpcIds List<String>

    Supporting Types

    GetGatewaysGateway

    BackendSpecs List<GetGatewaysGatewayBackendSpec>
    The backend spec of the api gateway.
    Comments string
    The comments of the api gateway.
    CreateTime string
    The create time of the api gateway.
    Id string
    The Id of the api gateway.
    LogSpecs List<GetGatewaysGatewayLogSpec>
    The log spec of the api gateway.
    Message string
    The error message of the api gateway.
    MonitorSpecs List<GetGatewaysGatewayMonitorSpec>
    The monitor spec of the api gateway.
    Name string
    The name of api gateway. This field support fuzzy query.
    NetworkSpecs List<GetGatewaysGatewayNetworkSpec>
    The network spec of the api gateway.
    ProjectName string
    The project name of api gateway.
    Region string
    The region of the api gateway.
    ResourceSpecs List<GetGatewaysGatewayResourceSpec>
    The resource spec of the api gateway.
    Status string
    The status of api gateway.
    Tags List<GetGatewaysGatewayTag>
    Tags.
    Type string
    The type of api gateway.
    Version string
    The version of the api gateway.
    BackendSpecs []GetGatewaysGatewayBackendSpec
    The backend spec of the api gateway.
    Comments string
    The comments of the api gateway.
    CreateTime string
    The create time of the api gateway.
    Id string
    The Id of the api gateway.
    LogSpecs []GetGatewaysGatewayLogSpec
    The log spec of the api gateway.
    Message string
    The error message of the api gateway.
    MonitorSpecs []GetGatewaysGatewayMonitorSpec
    The monitor spec of the api gateway.
    Name string
    The name of api gateway. This field support fuzzy query.
    NetworkSpecs []GetGatewaysGatewayNetworkSpec
    The network spec of the api gateway.
    ProjectName string
    The project name of api gateway.
    Region string
    The region of the api gateway.
    ResourceSpecs []GetGatewaysGatewayResourceSpec
    The resource spec of the api gateway.
    Status string
    The status of api gateway.
    Tags []GetGatewaysGatewayTag
    Tags.
    Type string
    The type of api gateway.
    Version string
    The version of the api gateway.
    backendSpecs List<GetGatewaysGatewayBackendSpec>
    The backend spec of the api gateway.
    comments String
    The comments of the api gateway.
    createTime String
    The create time of the api gateway.
    id String
    The Id of the api gateway.
    logSpecs List<GetGatewaysGatewayLogSpec>
    The log spec of the api gateway.
    message String
    The error message of the api gateway.
    monitorSpecs List<GetGatewaysGatewayMonitorSpec>
    The monitor spec of the api gateway.
    name String
    The name of api gateway. This field support fuzzy query.
    networkSpecs List<GetGatewaysGatewayNetworkSpec>
    The network spec of the api gateway.
    projectName String
    The project name of api gateway.
    region String
    The region of the api gateway.
    resourceSpecs List<GetGatewaysGatewayResourceSpec>
    The resource spec of the api gateway.
    status String
    The status of api gateway.
    tags List<GetGatewaysGatewayTag>
    Tags.
    type String
    The type of api gateway.
    version String
    The version of the api gateway.
    backendSpecs GetGatewaysGatewayBackendSpec[]
    The backend spec of the api gateway.
    comments string
    The comments of the api gateway.
    createTime string
    The create time of the api gateway.
    id string
    The Id of the api gateway.
    logSpecs GetGatewaysGatewayLogSpec[]
    The log spec of the api gateway.
    message string
    The error message of the api gateway.
    monitorSpecs GetGatewaysGatewayMonitorSpec[]
    The monitor spec of the api gateway.
    name string
    The name of api gateway. This field support fuzzy query.
    networkSpecs GetGatewaysGatewayNetworkSpec[]
    The network spec of the api gateway.
    projectName string
    The project name of api gateway.
    region string
    The region of the api gateway.
    resourceSpecs GetGatewaysGatewayResourceSpec[]
    The resource spec of the api gateway.
    status string
    The status of api gateway.
    tags GetGatewaysGatewayTag[]
    Tags.
    type string
    The type of api gateway.
    version string
    The version of the api gateway.
    backend_specs Sequence[GetGatewaysGatewayBackendSpec]
    The backend spec of the api gateway.
    comments str
    The comments of the api gateway.
    create_time str
    The create time of the api gateway.
    id str
    The Id of the api gateway.
    log_specs Sequence[GetGatewaysGatewayLogSpec]
    The log spec of the api gateway.
    message str
    The error message of the api gateway.
    monitor_specs Sequence[GetGatewaysGatewayMonitorSpec]
    The monitor spec of the api gateway.
    name str
    The name of api gateway. This field support fuzzy query.
    network_specs Sequence[GetGatewaysGatewayNetworkSpec]
    The network spec of the api gateway.
    project_name str
    The project name of api gateway.
    region str
    The region of the api gateway.
    resource_specs Sequence[GetGatewaysGatewayResourceSpec]
    The resource spec of the api gateway.
    status str
    The status of api gateway.
    tags Sequence[GetGatewaysGatewayTag]
    Tags.
    type str
    The type of api gateway.
    version str
    The version of the api gateway.
    backendSpecs List<Property Map>
    The backend spec of the api gateway.
    comments String
    The comments of the api gateway.
    createTime String
    The create time of the api gateway.
    id String
    The Id of the api gateway.
    logSpecs List<Property Map>
    The log spec of the api gateway.
    message String
    The error message of the api gateway.
    monitorSpecs List<Property Map>
    The monitor spec of the api gateway.
    name String
    The name of api gateway. This field support fuzzy query.
    networkSpecs List<Property Map>
    The network spec of the api gateway.
    projectName String
    The project name of api gateway.
    region String
    The region of the api gateway.
    resourceSpecs List<Property Map>
    The resource spec of the api gateway.
    status String
    The status of api gateway.
    tags List<Property Map>
    Tags.
    type String
    The type of api gateway.
    version String
    The version of the api gateway.

    GetGatewaysGatewayBackendSpec

    IsVkeWithFlannelCniSupported bool
    Whether the api gateway support vke flannel cni.
    VkePodCidr string
    The vke pod cidr of the api gateway.
    IsVkeWithFlannelCniSupported bool
    Whether the api gateway support vke flannel cni.
    VkePodCidr string
    The vke pod cidr of the api gateway.
    isVkeWithFlannelCniSupported Boolean
    Whether the api gateway support vke flannel cni.
    vkePodCidr String
    The vke pod cidr of the api gateway.
    isVkeWithFlannelCniSupported boolean
    Whether the api gateway support vke flannel cni.
    vkePodCidr string
    The vke pod cidr of the api gateway.
    is_vke_with_flannel_cni_supported bool
    Whether the api gateway support vke flannel cni.
    vke_pod_cidr str
    The vke pod cidr of the api gateway.
    isVkeWithFlannelCniSupported Boolean
    Whether the api gateway support vke flannel cni.
    vkePodCidr String
    The vke pod cidr of the api gateway.

    GetGatewaysGatewayLogSpec

    Enable bool
    Whether the api gateway enable monitor.
    ProjectId string
    The project id of the tls.
    TopicId string
    The topic id of the tls.
    Enable bool
    Whether the api gateway enable monitor.
    ProjectId string
    The project id of the tls.
    TopicId string
    The topic id of the tls.
    enable Boolean
    Whether the api gateway enable monitor.
    projectId String
    The project id of the tls.
    topicId String
    The topic id of the tls.
    enable boolean
    Whether the api gateway enable monitor.
    projectId string
    The project id of the tls.
    topicId string
    The topic id of the tls.
    enable bool
    Whether the api gateway enable monitor.
    project_id str
    The project id of the tls.
    topic_id str
    The topic id of the tls.
    enable Boolean
    Whether the api gateway enable monitor.
    projectId String
    The project id of the tls.
    topicId String
    The topic id of the tls.

    GetGatewaysGatewayMonitorSpec

    Enable bool
    Whether the api gateway enable monitor.
    WorkspaceId string
    The workspace id of the monitor.
    Enable bool
    Whether the api gateway enable monitor.
    WorkspaceId string
    The workspace id of the monitor.
    enable Boolean
    Whether the api gateway enable monitor.
    workspaceId String
    The workspace id of the monitor.
    enable boolean
    Whether the api gateway enable monitor.
    workspaceId string
    The workspace id of the monitor.
    enable bool
    Whether the api gateway enable monitor.
    workspace_id str
    The workspace id of the monitor.
    enable Boolean
    Whether the api gateway enable monitor.
    workspaceId String
    The workspace id of the monitor.

    GetGatewaysGatewayNetworkSpec

    SubnetIds List<string>
    The subnet ids of the api gateway.
    VpcId string
    The vpc id of the api gateway.
    SubnetIds []string
    The subnet ids of the api gateway.
    VpcId string
    The vpc id of the api gateway.
    subnetIds List<String>
    The subnet ids of the api gateway.
    vpcId String
    The vpc id of the api gateway.
    subnetIds string[]
    The subnet ids of the api gateway.
    vpcId string
    The vpc id of the api gateway.
    subnet_ids Sequence[str]
    The subnet ids of the api gateway.
    vpc_id str
    The vpc id of the api gateway.
    subnetIds List<String>
    The subnet ids of the api gateway.
    vpcId String
    The vpc id of the api gateway.

    GetGatewaysGatewayResourceSpec

    ClbSpecCode string
    The clb spec code of the resource spec.
    InstanceSpecCode string
    The instance spec code of the resource spec.
    NetworkTypes List<GetGatewaysGatewayResourceSpecNetworkType>
    The network type of the api gateway.
    PublicNetworkBandwidth int
    The public network bandwidth of the resource spec.
    PublicNetworkBillingType string
    The public network billing type of the resource spec.
    Replicas int
    The replicas of the resource spec.
    ClbSpecCode string
    The clb spec code of the resource spec.
    InstanceSpecCode string
    The instance spec code of the resource spec.
    NetworkTypes []GetGatewaysGatewayResourceSpecNetworkType
    The network type of the api gateway.
    PublicNetworkBandwidth int
    The public network bandwidth of the resource spec.
    PublicNetworkBillingType string
    The public network billing type of the resource spec.
    Replicas int
    The replicas of the resource spec.
    clbSpecCode String
    The clb spec code of the resource spec.
    instanceSpecCode String
    The instance spec code of the resource spec.
    networkTypes List<GetGatewaysGatewayResourceSpecNetworkType>
    The network type of the api gateway.
    publicNetworkBandwidth Integer
    The public network bandwidth of the resource spec.
    publicNetworkBillingType String
    The public network billing type of the resource spec.
    replicas Integer
    The replicas of the resource spec.
    clbSpecCode string
    The clb spec code of the resource spec.
    instanceSpecCode string
    The instance spec code of the resource spec.
    networkTypes GetGatewaysGatewayResourceSpecNetworkType[]
    The network type of the api gateway.
    publicNetworkBandwidth number
    The public network bandwidth of the resource spec.
    publicNetworkBillingType string
    The public network billing type of the resource spec.
    replicas number
    The replicas of the resource spec.
    clb_spec_code str
    The clb spec code of the resource spec.
    instance_spec_code str
    The instance spec code of the resource spec.
    network_types Sequence[GetGatewaysGatewayResourceSpecNetworkType]
    The network type of the api gateway.
    public_network_bandwidth int
    The public network bandwidth of the resource spec.
    public_network_billing_type str
    The public network billing type of the resource spec.
    replicas int
    The replicas of the resource spec.
    clbSpecCode String
    The clb spec code of the resource spec.
    instanceSpecCode String
    The instance spec code of the resource spec.
    networkTypes List<Property Map>
    The network type of the api gateway.
    publicNetworkBandwidth Number
    The public network bandwidth of the resource spec.
    publicNetworkBillingType String
    The public network billing type of the resource spec.
    replicas Number
    The replicas of the resource spec.

    GetGatewaysGatewayResourceSpecNetworkType

    EnablePrivateNetwork bool
    Whether the api gateway enable private network.
    EnablePublicNetwork bool
    Whether the api gateway enable public network.
    EnablePrivateNetwork bool
    Whether the api gateway enable private network.
    EnablePublicNetwork bool
    Whether the api gateway enable public network.
    enablePrivateNetwork Boolean
    Whether the api gateway enable private network.
    enablePublicNetwork Boolean
    Whether the api gateway enable public network.
    enablePrivateNetwork boolean
    Whether the api gateway enable private network.
    enablePublicNetwork boolean
    Whether the api gateway enable public network.
    enable_private_network bool
    Whether the api gateway enable private network.
    enable_public_network bool
    Whether the api gateway enable public network.
    enablePrivateNetwork Boolean
    Whether the api gateway enable private network.
    enablePublicNetwork Boolean
    Whether the api gateway enable public network.

    GetGatewaysGatewayTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    GetGatewaysTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate