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

volcengine.apig.getGatewayServices

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 gateway services

    Example Usage

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

const foo = volcengine.apig.getGatewayServices({
    gatewayId: "gd13d8c6eq1emkiunq6p0",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.apig.get_gateway_services(gateway_id="gd13d8c6eq1emkiunq6p0")

    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.GetGatewayServices(ctx, &apig.GetGatewayServicesArgs{
			GatewayId: pulumi.StringRef("gd13d8c6eq1emkiunq6p0"),
		}, 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.GetGatewayServices.Invoke(new()
    {
        GatewayId = "gd13d8c6eq1emkiunq6p0",
    });

});

    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.GetGatewayServicesArgs;
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.getGatewayServices(GetGatewayServicesArgs.builder()
            .gatewayId("gd13d8c6eq1emkiunq6p0")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:apig:getGatewayServices
      Arguments:
        gatewayId: gd13d8c6eq1emkiunq6p0

    Using getGatewayServices

    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 getGatewayServices(args: GetGatewayServicesArgs, opts?: InvokeOptions): Promise<GetGatewayServicesResult>
function getGatewayServicesOutput(args: GetGatewayServicesOutputArgs, opts?: InvokeOptions): Output<GetGatewayServicesResult>
    def get_gateway_services(gateway_id: Optional[str] = None,
                         name: Optional[str] = None,
                         output_file: Optional[str] = None,
                         status: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetGatewayServicesResult
def get_gateway_services_output(gateway_id: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         output_file: Optional[pulumi.Input[str]] = None,
                         status: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetGatewayServicesResult]
    func GetGatewayServices(ctx *Context, args *GetGatewayServicesArgs, opts ...InvokeOption) (*GetGatewayServicesResult, error)
func GetGatewayServicesOutput(ctx *Context, args *GetGatewayServicesOutputArgs, opts ...InvokeOption) GetGatewayServicesResultOutput

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

    public static class GetGatewayServices 
{
    public static Task<GetGatewayServicesResult> InvokeAsync(GetGatewayServicesArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayServicesResult> Invoke(GetGatewayServicesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayServicesResult> getGatewayServices(GetGatewayServicesArgs args, InvokeOptions options)
public static Output<GetGatewayServicesResult> getGatewayServices(GetGatewayServicesArgs args, InvokeOptions options)

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

    The following arguments are supported:

    GatewayId string
    The gateway id of api gateway service.
    Name string
    The name of api gateway service. This field support fuzzy query.
    OutputFile string
    File name where to save data source results.
    Status string
    The status of api gateway service.
    GatewayId string
    The gateway id of api gateway service.
    Name string
    The name of api gateway service. This field support fuzzy query.
    OutputFile string
    File name where to save data source results.
    Status string
    The status of api gateway service.
    gatewayId String
    The gateway id of api gateway service.
    name String
    The name of api gateway service. This field support fuzzy query.
    outputFile String
    File name where to save data source results.
    status String
    The status of api gateway service.
    gatewayId string
    The gateway id of api gateway service.
    name string
    The name of api gateway service. This field support fuzzy query.
    outputFile string
    File name where to save data source results.
    status string
    The status of api gateway service.
    gateway_id str
    The gateway id of api gateway service.
    name str
    The name of api gateway service. This field support fuzzy query.
    output_file str
    File name where to save data source results.
    status str
    The status of api gateway service.
    gatewayId String
    The gateway id of api gateway service.
    name String
    The name of api gateway service. This field support fuzzy query.
    outputFile String
    File name where to save data source results.
    status String
    The status of api gateway service.

    getGatewayServices Result

    The following output properties are available:

    GatewayServices List<GetGatewayServicesGatewayService>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    GatewayId string
    The gateway id of the api gateway service.
    Name string
    The name of the api gateway service.
    OutputFile string
    Status string
    The status of the api gateway service.
    GatewayServices []GetGatewayServicesGatewayService
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    GatewayId string
    The gateway id of the api gateway service.
    Name string
    The name of the api gateway service.
    OutputFile string
    Status string
    The status of the api gateway service.
    gatewayServices List<GetGatewayServicesGatewayService>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    gatewayId String
    The gateway id of the api gateway service.
    name String
    The name of the api gateway service.
    outputFile String
    status String
    The status of the api gateway service.
    gatewayServices GetGatewayServicesGatewayService[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    gatewayId string
    The gateway id of the api gateway service.
    name string
    The name of the api gateway service.
    outputFile string
    status string
    The status of the api gateway service.
    gateway_services Sequence[GetGatewayServicesGatewayService]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    gateway_id str
    The gateway id of the api gateway service.
    name str
    The name of the api gateway service.
    output_file str
    status str
    The status of the api gateway service.
    gatewayServices 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.
    gatewayId String
    The gateway id of the api gateway service.
    name String
    The name of the api gateway service.
    outputFile String
    status String
    The status of the api gateway service.

    Supporting Types

    GetGatewayServicesGatewayService

    AuthSpecs List<GetGatewayServicesGatewayServiceAuthSpec>
    The auth spec of the api gateway service.
    Comments string
    The comments of the api gateway service.
    CreateTime string
    The create time of the api gateway service.
    CustomDomains List<GetGatewayServicesGatewayServiceCustomDomain>
    The custom domains of the api gateway service.
    Domains List<GetGatewayServicesGatewayServiceDomain>
    The domains of the api gateway service.
    GatewayId string
    The gateway id of api gateway service.
    GatewayName string
    The gateway name of the api gateway service.
    Id string
    The Id of the api gateway service.
    Message string
    The error message of the api gateway service.
    Name string
    The name of api gateway service. This field support fuzzy query.
    Protocols List<string>
    The protocol of the api gateway service.
    Status string
    The status of api gateway service.
    AuthSpecs []GetGatewayServicesGatewayServiceAuthSpec
    The auth spec of the api gateway service.
    Comments string
    The comments of the api gateway service.
    CreateTime string
    The create time of the api gateway service.
    CustomDomains []GetGatewayServicesGatewayServiceCustomDomain
    The custom domains of the api gateway service.
    Domains []GetGatewayServicesGatewayServiceDomain
    The domains of the api gateway service.
    GatewayId string
    The gateway id of api gateway service.
    GatewayName string
    The gateway name of the api gateway service.
    Id string
    The Id of the api gateway service.
    Message string
    The error message of the api gateway service.
    Name string
    The name of api gateway service. This field support fuzzy query.
    Protocols []string
    The protocol of the api gateway service.
    Status string
    The status of api gateway service.
    authSpecs List<GetGatewayServicesGatewayServiceAuthSpec>
    The auth spec of the api gateway service.
    comments String
    The comments of the api gateway service.
    createTime String
    The create time of the api gateway service.
    customDomains List<GetGatewayServicesGatewayServiceCustomDomain>
    The custom domains of the api gateway service.
    domains List<GetGatewayServicesGatewayServiceDomain>
    The domains of the api gateway service.
    gatewayId String
    The gateway id of api gateway service.
    gatewayName String
    The gateway name of the api gateway service.
    id String
    The Id of the api gateway service.
    message String
    The error message of the api gateway service.
    name String
    The name of api gateway service. This field support fuzzy query.
    protocols List<String>
    The protocol of the api gateway service.
    status String
    The status of api gateway service.
    authSpecs GetGatewayServicesGatewayServiceAuthSpec[]
    The auth spec of the api gateway service.
    comments string
    The comments of the api gateway service.
    createTime string
    The create time of the api gateway service.
    customDomains GetGatewayServicesGatewayServiceCustomDomain[]
    The custom domains of the api gateway service.
    domains GetGatewayServicesGatewayServiceDomain[]
    The domains of the api gateway service.
    gatewayId string
    The gateway id of api gateway service.
    gatewayName string
    The gateway name of the api gateway service.
    id string
    The Id of the api gateway service.
    message string
    The error message of the api gateway service.
    name string
    The name of api gateway service. This field support fuzzy query.
    protocols string[]
    The protocol of the api gateway service.
    status string
    The status of api gateway service.
    auth_specs Sequence[GetGatewayServicesGatewayServiceAuthSpec]
    The auth spec of the api gateway service.
    comments str
    The comments of the api gateway service.
    create_time str
    The create time of the api gateway service.
    custom_domains Sequence[GetGatewayServicesGatewayServiceCustomDomain]
    The custom domains of the api gateway service.
    domains Sequence[GetGatewayServicesGatewayServiceDomain]
    The domains of the api gateway service.
    gateway_id str
    The gateway id of api gateway service.
    gateway_name str
    The gateway name of the api gateway service.
    id str
    The Id of the api gateway service.
    message str
    The error message of the api gateway service.
    name str
    The name of api gateway service. This field support fuzzy query.
    protocols Sequence[str]
    The protocol of the api gateway service.
    status str
    The status of api gateway service.
    authSpecs List<Property Map>
    The auth spec of the api gateway service.
    comments String
    The comments of the api gateway service.
    createTime String
    The create time of the api gateway service.
    customDomains List<Property Map>
    The custom domains of the api gateway service.
    domains List<Property Map>
    The domains of the api gateway service.
    gatewayId String
    The gateway id of api gateway service.
    gatewayName String
    The gateway name of the api gateway service.
    id String
    The Id of the api gateway service.
    message String
    The error message of the api gateway service.
    name String
    The name of api gateway service. This field support fuzzy query.
    protocols List<String>
    The protocol of the api gateway service.
    status String
    The status of api gateway service.

    GetGatewayServicesGatewayServiceAuthSpec

    Enable bool
    Whether the api gateway service enable auth.
    Enable bool
    Whether the api gateway service enable auth.
    enable Boolean
    Whether the api gateway service enable auth.
    enable boolean
    Whether the api gateway service enable auth.
    enable bool
    Whether the api gateway service enable auth.
    enable Boolean
    Whether the api gateway service enable auth.

    GetGatewayServicesGatewayServiceCustomDomain

    Domain string
    The domain of the api gateway service.
    Id string
    The Id of the api gateway service.
    Domain string
    The domain of the api gateway service.
    Id string
    The Id of the api gateway service.
    domain String
    The domain of the api gateway service.
    id String
    The Id of the api gateway service.
    domain string
    The domain of the api gateway service.
    id string
    The Id of the api gateway service.
    domain str
    The domain of the api gateway service.
    id str
    The Id of the api gateway service.
    domain String
    The domain of the api gateway service.
    id String
    The Id of the api gateway service.

    GetGatewayServicesGatewayServiceDomain

    Domain string
    The domain of the api gateway service.
    Type string
    The type of the domain.
    Domain string
    The domain of the api gateway service.
    Type string
    The type of the domain.
    domain String
    The domain of the api gateway service.
    type String
    The type of the domain.
    domain string
    The domain of the api gateway service.
    type string
    The type of the domain.
    domain str
    The domain of the api gateway service.
    type str
    The type of the domain.
    domain String
    The domain of the api gateway service.
    type String
    The type of the domain.

    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