Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
volcengine.apig.Gateways
Explore with Pulumi AI
Deprecated: volcengine.apig.Gateways has been deprecated in favor of volcengine.apig.getGateways
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 Gateways
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 gateways(args: GatewaysArgs, opts?: InvokeOptions): Promise<GatewaysResult>
function gatewaysOutput(args: GatewaysOutputArgs, opts?: InvokeOptions): Output<GatewaysResult>
def 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[GatewaysTag]] = None,
type: Optional[str] = None,
vpc_ids: Optional[Sequence[str]] = None,
opts: Optional[InvokeOptions] = None) -> GatewaysResult
def 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[GatewaysTagArgs]]]] = None,
type: Optional[pulumi.Input[str]] = None,
vpc_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GatewaysResult]
func Gateways(ctx *Context, args *GatewaysArgs, opts ...InvokeOption) (*GatewaysResult, error)
func GatewaysOutput(ctx *Context, args *GatewaysOutputArgs, opts ...InvokeOption) GatewaysResultOutput
public static class Gateways
{
public static Task<GatewaysResult> InvokeAsync(GatewaysArgs args, InvokeOptions? opts = null)
public static Output<GatewaysResult> Invoke(GatewaysInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GatewaysResult> gateways(GatewaysArgs args, InvokeOptions options)
public static Output<GatewaysResult> gateways(GatewaysArgs args, InvokeOptions options)
fn::invoke:
function: volcengine:apig:Gateways
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.
- Name
Regex string - A Name Regex of Resource.
- Output
File string - File name where to save data source results.
- Project
Name string - The project name of api gateway.
- Status string
- The status of api gateway.
- List<Gateways
Tag> - Tags.
- Type string
- The type of api gateway.
- Vpc
Ids 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.
- Name
Regex string - A Name Regex of Resource.
- Output
File string - File name where to save data source results.
- Project
Name string - The project name of api gateway.
- Status string
- The status of api gateway.
- []Gateways
Tag - Tags.
- Type string
- The type of api gateway.
- Vpc
Ids []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.
- name
Regex String - A Name Regex of Resource.
- output
File String - File name where to save data source results.
- project
Name String - The project name of api gateway.
- status String
- The status of api gateway.
- List<Gateways
Tag> - Tags.
- type String
- The type of api gateway.
- vpc
Ids 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.
- name
Regex string - A Name Regex of Resource.
- output
File string - File name where to save data source results.
- project
Name string - The project name of api gateway.
- status string
- The status of api gateway.
- Gateways
Tag[] - Tags.
- type string
- The type of api gateway.
- vpc
Ids 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.
- Sequence[Gateways
Tag] - 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.
- name
Regex String - A Name Regex of Resource.
- output
File String - File name where to save data source results.
- project
Name String - The project name of api gateway.
- status String
- The status of api gateway.
- List<Property Map>
- Tags.
- type String
- The type of api gateway.
- vpc
Ids List<String> - A list of vpc IDs.
Gateways Result
The following output properties are available:
- Gateways
List<Gateways
Gateway> - The collection of query.
- Id string
- The provider-assigned unique ID for this managed resource.
- Total
Count int - The total count of query.
- Ids List<string>
- Name string
- The name of the api gateway.
- Name
Regex string - Output
File string - Project
Name string - The project name of the api gateway.
- Status string
- The status of the api gateway.
- List<Gateways
Tag> - Tags.
- Type string
- The type of the api gateway.
- Vpc
Ids List<string>
- Gateways
[]Gateways
Gateway - The collection of query.
- Id string
- The provider-assigned unique ID for this managed resource.
- Total
Count int - The total count of query.
- Ids []string
- Name string
- The name of the api gateway.
- Name
Regex string - Output
File string - Project
Name string - The project name of the api gateway.
- Status string
- The status of the api gateway.
- []Gateways
Tag - Tags.
- Type string
- The type of the api gateway.
- Vpc
Ids []string
- gateways
List<Gateways
Gateway> - The collection of query.
- id String
- The provider-assigned unique ID for this managed resource.
- total
Count Integer - The total count of query.
- ids List<String>
- name String
- The name of the api gateway.
- name
Regex String - output
File String - project
Name String - The project name of the api gateway.
- status String
- The status of the api gateway.
- List<Gateways
Tag> - Tags.
- type String
- The type of the api gateway.
- vpc
Ids List<String>
- gateways
Gateways
Gateway[] - The collection of query.
- id string
- The provider-assigned unique ID for this managed resource.
- total
Count number - The total count of query.
- ids string[]
- name string
- The name of the api gateway.
- name
Regex string - output
File string - project
Name string - The project name of the api gateway.
- status string
- The status of the api gateway.
- Gateways
Tag[] - Tags.
- type string
- The type of the api gateway.
- vpc
Ids string[]
- gateways
Sequence[Gateways
Gateway] - 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.
- Sequence[Gateways
Tag] - 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.
- total
Count Number - The total count of query.
- ids List<String>
- name String
- The name of the api gateway.
- name
Regex String - output
File String - project
Name String - The project name of the api gateway.
- status String
- The status of the api gateway.
- List<Property Map>
- Tags.
- type String
- The type of the api gateway.
- vpc
Ids List<String>
Supporting Types
GatewaysGateway
- Backend
Specs List<GatewaysGateway Backend Spec> - The backend spec of the api gateway.
- Comments string
- The comments of the api gateway.
- Create
Time string - The create time of the api gateway.
- Id string
- The Id of the api gateway.
- Log
Specs List<GatewaysGateway Log Spec> - The log spec of the api gateway.
- Message string
- The error message of the api gateway.
- Monitor
Specs List<GatewaysGateway Monitor Spec> - The monitor spec of the api gateway.
- Name string
- The name of api gateway. This field support fuzzy query.
- Network
Specs List<GatewaysGateway Network Spec> - The network spec of the api gateway.
- Project
Name string - The project name of api gateway.
- Region string
- The region of the api gateway.
- Resource
Specs List<GatewaysGateway Resource Spec> - The resource spec of the api gateway.
- Status string
- The status of api gateway.
- List<Gateways
Gateway Tag> - Tags.
- Type string
- The type of api gateway.
- Version string
- The version of the api gateway.
- Backend
Specs []GatewaysGateway Backend Spec - The backend spec of the api gateway.
- Comments string
- The comments of the api gateway.
- Create
Time string - The create time of the api gateway.
- Id string
- The Id of the api gateway.
- Log
Specs []GatewaysGateway Log Spec - The log spec of the api gateway.
- Message string
- The error message of the api gateway.
- Monitor
Specs []GatewaysGateway Monitor Spec - The monitor spec of the api gateway.
- Name string
- The name of api gateway. This field support fuzzy query.
- Network
Specs []GatewaysGateway Network Spec - The network spec of the api gateway.
- Project
Name string - The project name of api gateway.
- Region string
- The region of the api gateway.
- Resource
Specs []GatewaysGateway Resource Spec - The resource spec of the api gateway.
- Status string
- The status of api gateway.
- []Gateways
Gateway Tag - Tags.
- Type string
- The type of api gateway.
- Version string
- The version of the api gateway.
- backend
Specs List<GatewaysGateway Backend Spec> - The backend spec of the api gateway.
- comments String
- The comments of the api gateway.
- create
Time String - The create time of the api gateway.
- id String
- The Id of the api gateway.
- log
Specs List<GatewaysGateway Log Spec> - The log spec of the api gateway.
- message String
- The error message of the api gateway.
- monitor
Specs List<GatewaysGateway Monitor Spec> - The monitor spec of the api gateway.
- name String
- The name of api gateway. This field support fuzzy query.
- network
Specs List<GatewaysGateway Network Spec> - The network spec of the api gateway.
- project
Name String - The project name of api gateway.
- region String
- The region of the api gateway.
- resource
Specs List<GatewaysGateway Resource Spec> - The resource spec of the api gateway.
- status String
- The status of api gateway.
- List<Gateways
Gateway Tag> - Tags.
- type String
- The type of api gateway.
- version String
- The version of the api gateway.
- backend
Specs GatewaysGateway Backend Spec[] - The backend spec of the api gateway.
- comments string
- The comments of the api gateway.
- create
Time string - The create time of the api gateway.
- id string
- The Id of the api gateway.
- log
Specs GatewaysGateway Log Spec[] - The log spec of the api gateway.
- message string
- The error message of the api gateway.
- monitor
Specs GatewaysGateway Monitor Spec[] - The monitor spec of the api gateway.
- name string
- The name of api gateway. This field support fuzzy query.
- network
Specs GatewaysGateway Network Spec[] - The network spec of the api gateway.
- project
Name string - The project name of api gateway.
- region string
- The region of the api gateway.
- resource
Specs GatewaysGateway Resource Spec[] - The resource spec of the api gateway.
- status string
- The status of api gateway.
- Gateways
Gateway Tag[] - Tags.
- type string
- The type of api gateway.
- version string
- The version of the api gateway.
- backend_
specs Sequence[GatewaysGateway Backend Spec] - 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[GatewaysGateway Log Spec] - The log spec of the api gateway.
- message str
- The error message of the api gateway.
- monitor_
specs Sequence[GatewaysGateway Monitor Spec] - The monitor spec of the api gateway.
- name str
- The name of api gateway. This field support fuzzy query.
- network_
specs Sequence[GatewaysGateway Network Spec] - 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[GatewaysGateway Resource Spec] - The resource spec of the api gateway.
- status str
- The status of api gateway.
- Sequence[Gateways
Gateway Tag] - Tags.
- type str
- The type of api gateway.
- version str
- The version of the api gateway.
- backend
Specs List<Property Map> - The backend spec of the api gateway.
- comments String
- The comments of the api gateway.
- create
Time String - The create time of the api gateway.
- id String
- The Id of the api gateway.
- log
Specs List<Property Map> - The log spec of the api gateway.
- message String
- The error message of the api gateway.
- monitor
Specs List<Property Map> - The monitor spec of the api gateway.
- name String
- The name of api gateway. This field support fuzzy query.
- network
Specs List<Property Map> - The network spec of the api gateway.
- project
Name String - The project name of api gateway.
- region String
- The region of the api gateway.
- resource
Specs List<Property Map> - The resource spec of the api gateway.
- status String
- The status of api gateway.
- List<Property Map>
- Tags.
- type String
- The type of api gateway.
- version String
- The version of the api gateway.
GatewaysGatewayBackendSpec
- Is
Vke boolWith Flannel Cni Supported - Whether the api gateway support vke flannel cni.
- Vke
Pod stringCidr - The vke pod cidr of the api gateway.
- Is
Vke boolWith Flannel Cni Supported - Whether the api gateway support vke flannel cni.
- Vke
Pod stringCidr - The vke pod cidr of the api gateway.
- is
Vke BooleanWith Flannel Cni Supported - Whether the api gateway support vke flannel cni.
- vke
Pod StringCidr - The vke pod cidr of the api gateway.
- is
Vke booleanWith Flannel Cni Supported - Whether the api gateway support vke flannel cni.
- vke
Pod stringCidr - The vke pod cidr of the api gateway.
- is_
vke_ boolwith_ flannel_ cni_ supported - Whether the api gateway support vke flannel cni.
- vke_
pod_ strcidr - The vke pod cidr of the api gateway.
- is
Vke BooleanWith Flannel Cni Supported - Whether the api gateway support vke flannel cni.
- vke
Pod StringCidr - The vke pod cidr of the api gateway.
GatewaysGatewayLogSpec
- 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.
GatewaysGatewayMonitorSpec
- Enable bool
- Whether the api gateway enable monitor.
- Workspace
Id string - The workspace id of the monitor.
- Enable bool
- Whether the api gateway enable monitor.
- Workspace
Id string - The workspace id of the monitor.
- enable Boolean
- Whether the api gateway enable monitor.
- workspace
Id String - The workspace id of the monitor.
- enable boolean
- Whether the api gateway enable monitor.
- workspace
Id 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.
- workspace
Id String - The workspace id of the monitor.
GatewaysGatewayNetworkSpec
- subnet_
ids Sequence[str] - The subnet ids of the api gateway.
- vpc_
id str - The vpc id of the api gateway.
GatewaysGatewayResourceSpec
- Clb
Spec stringCode - The clb spec code of the resource spec.
- Instance
Spec stringCode - The instance spec code of the resource spec.
- Network
Types List<GatewaysGateway Resource Spec Network Type> - The network type of the api gateway.
- Public
Network intBandwidth - The public network bandwidth of the resource spec.
- Public
Network stringBilling Type - The public network billing type of the resource spec.
- Replicas int
- The replicas of the resource spec.
- Clb
Spec stringCode - The clb spec code of the resource spec.
- Instance
Spec stringCode - The instance spec code of the resource spec.
- Network
Types []GatewaysGateway Resource Spec Network Type - The network type of the api gateway.
- Public
Network intBandwidth - The public network bandwidth of the resource spec.
- Public
Network stringBilling Type - The public network billing type of the resource spec.
- Replicas int
- The replicas of the resource spec.
- clb
Spec StringCode - The clb spec code of the resource spec.
- instance
Spec StringCode - The instance spec code of the resource spec.
- network
Types List<GatewaysGateway Resource Spec Network Type> - The network type of the api gateway.
- public
Network IntegerBandwidth - The public network bandwidth of the resource spec.
- public
Network StringBilling Type - The public network billing type of the resource spec.
- replicas Integer
- The replicas of the resource spec.
- clb
Spec stringCode - The clb spec code of the resource spec.
- instance
Spec stringCode - The instance spec code of the resource spec.
- network
Types GatewaysGateway Resource Spec Network Type[] - The network type of the api gateway.
- public
Network numberBandwidth - The public network bandwidth of the resource spec.
- public
Network stringBilling Type - The public network billing type of the resource spec.
- replicas number
- The replicas of the resource spec.
- clb_
spec_ strcode - The clb spec code of the resource spec.
- instance_
spec_ strcode - The instance spec code of the resource spec.
- network_
types Sequence[GatewaysGateway Resource Spec Network Type] - The network type of the api gateway.
- public_
network_ intbandwidth - The public network bandwidth of the resource spec.
- public_
network_ strbilling_ type - The public network billing type of the resource spec.
- replicas int
- The replicas of the resource spec.
- clb
Spec StringCode - The clb spec code of the resource spec.
- instance
Spec StringCode - The instance spec code of the resource spec.
- network
Types List<Property Map> - The network type of the api gateway.
- public
Network NumberBandwidth - The public network bandwidth of the resource spec.
- public
Network StringBilling Type - The public network billing type of the resource spec.
- replicas Number
- The replicas of the resource spec.
GatewaysGatewayResourceSpecNetworkType
- Enable
Private boolNetwork - Whether the api gateway enable private network.
- Enable
Public boolNetwork - Whether the api gateway enable public network.
- Enable
Private boolNetwork - Whether the api gateway enable private network.
- Enable
Public boolNetwork - Whether the api gateway enable public network.
- enable
Private BooleanNetwork - Whether the api gateway enable private network.
- enable
Public BooleanNetwork - Whether the api gateway enable public network.
- enable
Private booleanNetwork - Whether the api gateway enable private network.
- enable
Public booleanNetwork - Whether the api gateway enable public network.
- enable_
private_ boolnetwork - Whether the api gateway enable private network.
- enable_
public_ boolnetwork - Whether the api gateway enable public network.
- enable
Private BooleanNetwork - Whether the api gateway enable private network.
- enable
Public BooleanNetwork - Whether the api gateway enable public network.
GatewaysGatewayTag
GatewaysTag
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengine
Terraform Provider.