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

volcengine.apig.getUpstreamSources

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 upstream sources

    Example Usage

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

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

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.apig.get_upstream_sources(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.GetUpstreamSources(ctx, &apig.GetUpstreamSourcesArgs{
			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.GetUpstreamSources.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.GetUpstreamSourcesArgs;
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.getUpstreamSources(GetUpstreamSourcesArgs.builder()
            .gatewayId("gd13d8c6eq1emkiunq6p0")
            .build());

    }
}

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

    Using getUpstreamSources

    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 getUpstreamSources(args: GetUpstreamSourcesArgs, opts?: InvokeOptions): Promise<GetUpstreamSourcesResult>
function getUpstreamSourcesOutput(args: GetUpstreamSourcesOutputArgs, opts?: InvokeOptions): Output<GetUpstreamSourcesResult>
    def get_upstream_sources(enable_ingress: Optional[bool] = None,
                         gateway_id: Optional[str] = None,
                         name: Optional[str] = None,
                         output_file: Optional[str] = None,
                         source_type: Optional[str] = None,
                         status: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetUpstreamSourcesResult
def get_upstream_sources_output(enable_ingress: Optional[pulumi.Input[bool]] = None,
                         gateway_id: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         output_file: Optional[pulumi.Input[str]] = None,
                         source_type: Optional[pulumi.Input[str]] = None,
                         status: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetUpstreamSourcesResult]
    func GetUpstreamSources(ctx *Context, args *GetUpstreamSourcesArgs, opts ...InvokeOption) (*GetUpstreamSourcesResult, error)
func GetUpstreamSourcesOutput(ctx *Context, args *GetUpstreamSourcesOutputArgs, opts ...InvokeOption) GetUpstreamSourcesResultOutput

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

    public static class GetUpstreamSources 
{
    public static Task<GetUpstreamSourcesResult> InvokeAsync(GetUpstreamSourcesArgs args, InvokeOptions? opts = null)
    public static Output<GetUpstreamSourcesResult> Invoke(GetUpstreamSourcesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUpstreamSourcesResult> getUpstreamSources(GetUpstreamSourcesArgs args, InvokeOptions options)
public static Output<GetUpstreamSourcesResult> getUpstreamSources(GetUpstreamSourcesArgs args, InvokeOptions options)

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

    The following arguments are supported:

    EnableIngress bool
    The enable ingress of apig upstream source.
    GatewayId string
    The id of api gateway.
    Name string
    The name of nacos source.
    OutputFile string
    File name where to save data source results.
    SourceType string
    The source type of apig upstream source. Valid values: K8S, Nacos.
    Status string
    The status of apig upstream source. Valid values: Syncing, SyncedSucceed, SyncedFailed.
    EnableIngress bool
    The enable ingress of apig upstream source.
    GatewayId string
    The id of api gateway.
    Name string
    The name of nacos source.
    OutputFile string
    File name where to save data source results.
    SourceType string
    The source type of apig upstream source. Valid values: K8S, Nacos.
    Status string
    The status of apig upstream source. Valid values: Syncing, SyncedSucceed, SyncedFailed.
    enableIngress Boolean
    The enable ingress of apig upstream source.
    gatewayId String
    The id of api gateway.
    name String
    The name of nacos source.
    outputFile String
    File name where to save data source results.
    sourceType String
    The source type of apig upstream source. Valid values: K8S, Nacos.
    status String
    The status of apig upstream source. Valid values: Syncing, SyncedSucceed, SyncedFailed.
    enableIngress boolean
    The enable ingress of apig upstream source.
    gatewayId string
    The id of api gateway.
    name string
    The name of nacos source.
    outputFile string
    File name where to save data source results.
    sourceType string
    The source type of apig upstream source. Valid values: K8S, Nacos.
    status string
    The status of apig upstream source. Valid values: Syncing, SyncedSucceed, SyncedFailed.
    enable_ingress bool
    The enable ingress of apig upstream source.
    gateway_id str
    The id of api gateway.
    name str
    The name of nacos source.
    output_file str
    File name where to save data source results.
    source_type str
    The source type of apig upstream source. Valid values: K8S, Nacos.
    status str
    The status of apig upstream source. Valid values: Syncing, SyncedSucceed, SyncedFailed.
    enableIngress Boolean
    The enable ingress of apig upstream source.
    gatewayId String
    The id of api gateway.
    name String
    The name of nacos source.
    outputFile String
    File name where to save data source results.
    sourceType String
    The source type of apig upstream source. Valid values: K8S, Nacos.
    status String
    The status of apig upstream source. Valid values: Syncing, SyncedSucceed, SyncedFailed.

    getUpstreamSources Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    UpstreamSources List<GetUpstreamSourcesUpstreamSource>
    The collection of query.
    EnableIngress bool
    Whether to enable ingress.
    GatewayId string
    The id of api gateway.
    Name string
    OutputFile string
    SourceType string
    The source type of apig upstream source.
    Status string
    The status of apig upstream source.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    UpstreamSources []GetUpstreamSourcesUpstreamSource
    The collection of query.
    EnableIngress bool
    Whether to enable ingress.
    GatewayId string
    The id of api gateway.
    Name string
    OutputFile string
    SourceType string
    The source type of apig upstream source.
    Status string
    The status of apig upstream source.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    upstreamSources List<GetUpstreamSourcesUpstreamSource>
    The collection of query.
    enableIngress Boolean
    Whether to enable ingress.
    gatewayId String
    The id of api gateway.
    name String
    outputFile String
    sourceType String
    The source type of apig upstream source.
    status String
    The status of apig upstream source.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    upstreamSources GetUpstreamSourcesUpstreamSource[]
    The collection of query.
    enableIngress boolean
    Whether to enable ingress.
    gatewayId string
    The id of api gateway.
    name string
    outputFile string
    sourceType string
    The source type of apig upstream source.
    status string
    The status of apig upstream source.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    upstream_sources Sequence[GetUpstreamSourcesUpstreamSource]
    The collection of query.
    enable_ingress bool
    Whether to enable ingress.
    gateway_id str
    The id of api gateway.
    name str
    output_file str
    source_type str
    The source type of apig upstream source.
    status str
    The status of apig upstream source.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    upstreamSources List<Property Map>
    The collection of query.
    enableIngress Boolean
    Whether to enable ingress.
    gatewayId String
    The id of api gateway.
    name String
    outputFile String
    sourceType String
    The source type of apig upstream source.
    status String
    The status of apig upstream source.

    Supporting Types

    GetUpstreamSourcesUpstreamSource

    Comments string
    The comments of apig upstream source.
    CreateTime string
    The create time of apig upstream source.
    GatewayId string
    The id of api gateway.
    Id string
    The id of apig upstream source.
    IngressSettings List<GetUpstreamSourcesUpstreamSourceIngressSetting>
    The ingress settings of apig upstream source.
    SourceSpecs List<GetUpstreamSourcesUpstreamSourceSourceSpec>
    The source spec of apig upstream source.
    SourceType string
    The source type of apig upstream source. Valid values: K8S, Nacos.
    Status string
    The status of apig upstream source. Valid values: Syncing, SyncedSucceed, SyncedFailed.
    StatusMessage string
    The status message of apig upstream source.
    UpdateTime string
    The update time of apig upstream source.
    Comments string
    The comments of apig upstream source.
    CreateTime string
    The create time of apig upstream source.
    GatewayId string
    The id of api gateway.
    Id string
    The id of apig upstream source.
    IngressSettings []GetUpstreamSourcesUpstreamSourceIngressSetting
    The ingress settings of apig upstream source.
    SourceSpecs []GetUpstreamSourcesUpstreamSourceSourceSpec
    The source spec of apig upstream source.
    SourceType string
    The source type of apig upstream source. Valid values: K8S, Nacos.
    Status string
    The status of apig upstream source. Valid values: Syncing, SyncedSucceed, SyncedFailed.
    StatusMessage string
    The status message of apig upstream source.
    UpdateTime string
    The update time of apig upstream source.
    comments String
    The comments of apig upstream source.
    createTime String
    The create time of apig upstream source.
    gatewayId String
    The id of api gateway.
    id String
    The id of apig upstream source.
    ingressSettings List<GetUpstreamSourcesUpstreamSourceIngressSetting>
    The ingress settings of apig upstream source.
    sourceSpecs List<GetUpstreamSourcesUpstreamSourceSourceSpec>
    The source spec of apig upstream source.
    sourceType String
    The source type of apig upstream source. Valid values: K8S, Nacos.
    status String
    The status of apig upstream source. Valid values: Syncing, SyncedSucceed, SyncedFailed.
    statusMessage String
    The status message of apig upstream source.
    updateTime String
    The update time of apig upstream source.
    comments string
    The comments of apig upstream source.
    createTime string
    The create time of apig upstream source.
    gatewayId string
    The id of api gateway.
    id string
    The id of apig upstream source.
    ingressSettings GetUpstreamSourcesUpstreamSourceIngressSetting[]
    The ingress settings of apig upstream source.
    sourceSpecs GetUpstreamSourcesUpstreamSourceSourceSpec[]
    The source spec of apig upstream source.
    sourceType string
    The source type of apig upstream source. Valid values: K8S, Nacos.
    status string
    The status of apig upstream source. Valid values: Syncing, SyncedSucceed, SyncedFailed.
    statusMessage string
    The status message of apig upstream source.
    updateTime string
    The update time of apig upstream source.
    comments str
    The comments of apig upstream source.
    create_time str
    The create time of apig upstream source.
    gateway_id str
    The id of api gateway.
    id str
    The id of apig upstream source.
    ingress_settings Sequence[GetUpstreamSourcesUpstreamSourceIngressSetting]
    The ingress settings of apig upstream source.
    source_specs Sequence[GetUpstreamSourcesUpstreamSourceSourceSpec]
    The source spec of apig upstream source.
    source_type str
    The source type of apig upstream source. Valid values: K8S, Nacos.
    status str
    The status of apig upstream source. Valid values: Syncing, SyncedSucceed, SyncedFailed.
    status_message str
    The status message of apig upstream source.
    update_time str
    The update time of apig upstream source.
    comments String
    The comments of apig upstream source.
    createTime String
    The create time of apig upstream source.
    gatewayId String
    The id of api gateway.
    id String
    The id of apig upstream source.
    ingressSettings List<Property Map>
    The ingress settings of apig upstream source.
    sourceSpecs List<Property Map>
    The source spec of apig upstream source.
    sourceType String
    The source type of apig upstream source. Valid values: K8S, Nacos.
    status String
    The status of apig upstream source. Valid values: Syncing, SyncedSucceed, SyncedFailed.
    statusMessage String
    The status message of apig upstream source.
    updateTime String
    The update time of apig upstream source.

    GetUpstreamSourcesUpstreamSourceIngressSetting

    EnableAllIngressClasses bool
    Whether to enable all ingress classes.
    EnableAllNamespaces bool
    Whether to enable all namespaces.
    EnableIngress bool
    The enable ingress of apig upstream source.
    EnableIngressWithoutIngressClass bool
    Whether to enable ingress without ingress class.
    IngressClasses List<string>
    The ingress classes of ingress settings.
    UpdateStatus bool
    The update status of ingress settings.
    WatchNamespaces List<string>
    The watch namespaces of ingress settings.
    EnableAllIngressClasses bool
    Whether to enable all ingress classes.
    EnableAllNamespaces bool
    Whether to enable all namespaces.
    EnableIngress bool
    The enable ingress of apig upstream source.
    EnableIngressWithoutIngressClass bool
    Whether to enable ingress without ingress class.
    IngressClasses []string
    The ingress classes of ingress settings.
    UpdateStatus bool
    The update status of ingress settings.
    WatchNamespaces []string
    The watch namespaces of ingress settings.
    enableAllIngressClasses Boolean
    Whether to enable all ingress classes.
    enableAllNamespaces Boolean
    Whether to enable all namespaces.
    enableIngress Boolean
    The enable ingress of apig upstream source.
    enableIngressWithoutIngressClass Boolean
    Whether to enable ingress without ingress class.
    ingressClasses List<String>
    The ingress classes of ingress settings.
    updateStatus Boolean
    The update status of ingress settings.
    watchNamespaces List<String>
    The watch namespaces of ingress settings.
    enableAllIngressClasses boolean
    Whether to enable all ingress classes.
    enableAllNamespaces boolean
    Whether to enable all namespaces.
    enableIngress boolean
    The enable ingress of apig upstream source.
    enableIngressWithoutIngressClass boolean
    Whether to enable ingress without ingress class.
    ingressClasses string[]
    The ingress classes of ingress settings.
    updateStatus boolean
    The update status of ingress settings.
    watchNamespaces string[]
    The watch namespaces of ingress settings.
    enable_all_ingress_classes bool
    Whether to enable all ingress classes.
    enable_all_namespaces bool
    Whether to enable all namespaces.
    enable_ingress bool
    The enable ingress of apig upstream source.
    enable_ingress_without_ingress_class bool
    Whether to enable ingress without ingress class.
    ingress_classes Sequence[str]
    The ingress classes of ingress settings.
    update_status bool
    The update status of ingress settings.
    watch_namespaces Sequence[str]
    The watch namespaces of ingress settings.
    enableAllIngressClasses Boolean
    Whether to enable all ingress classes.
    enableAllNamespaces Boolean
    Whether to enable all namespaces.
    enableIngress Boolean
    The enable ingress of apig upstream source.
    enableIngressWithoutIngressClass Boolean
    Whether to enable ingress without ingress class.
    ingressClasses List<String>
    The ingress classes of ingress settings.
    updateStatus Boolean
    The update status of ingress settings.
    watchNamespaces List<String>
    The watch namespaces of ingress settings.

    GetUpstreamSourcesUpstreamSourceSourceSpec

    k8sSources List<Property Map>
    The k8s source of apig upstream source.
    nacosSources List<Property Map>
    The nacos source of apig upstream source.

    GetUpstreamSourcesUpstreamSourceSourceSpecK8sSource

    ClusterId string
    The cluster id of k8s source.
    ClusterType string
    The cluster type of k8s source.
    ClusterId string
    The cluster id of k8s source.
    ClusterType string
    The cluster type of k8s source.
    clusterId String
    The cluster id of k8s source.
    clusterType String
    The cluster type of k8s source.
    clusterId string
    The cluster id of k8s source.
    clusterType string
    The cluster type of k8s source.
    cluster_id str
    The cluster id of k8s source.
    cluster_type str
    The cluster type of k8s source.
    clusterId String
    The cluster id of k8s source.
    clusterType String
    The cluster type of k8s source.

    GetUpstreamSourcesUpstreamSourceSourceSpecNacosSource

    Address string
    The address of nacos source.
    AuthConfigs List<GetUpstreamSourcesUpstreamSourceSourceSpecNacosSourceAuthConfig>
    The auth config of nacos source.
    ContextPath string
    The context path of nacos source.
    GrpcPort int
    The grpc port of nacos source.
    HttpPort int
    The http port of nacos source.
    NacosId string
    The nacos id of nacos source.
    NacosName string
    The nacos name of nacos source.
    Address string
    The address of nacos source.
    AuthConfigs []GetUpstreamSourcesUpstreamSourceSourceSpecNacosSourceAuthConfig
    The auth config of nacos source.
    ContextPath string
    The context path of nacos source.
    GrpcPort int
    The grpc port of nacos source.
    HttpPort int
    The http port of nacos source.
    NacosId string
    The nacos id of nacos source.
    NacosName string
    The nacos name of nacos source.
    address String
    The address of nacos source.
    authConfigs List<GetUpstreamSourcesUpstreamSourceSourceSpecNacosSourceAuthConfig>
    The auth config of nacos source.
    contextPath String
    The context path of nacos source.
    grpcPort Integer
    The grpc port of nacos source.
    httpPort Integer
    The http port of nacos source.
    nacosId String
    The nacos id of nacos source.
    nacosName String
    The nacos name of nacos source.
    address string
    The address of nacos source.
    authConfigs GetUpstreamSourcesUpstreamSourceSourceSpecNacosSourceAuthConfig[]
    The auth config of nacos source.
    contextPath string
    The context path of nacos source.
    grpcPort number
    The grpc port of nacos source.
    httpPort number
    The http port of nacos source.
    nacosId string
    The nacos id of nacos source.
    nacosName string
    The nacos name of nacos source.
    address str
    The address of nacos source.
    auth_configs Sequence[GetUpstreamSourcesUpstreamSourceSourceSpecNacosSourceAuthConfig]
    The auth config of nacos source.
    context_path str
    The context path of nacos source.
    grpc_port int
    The grpc port of nacos source.
    http_port int
    The http port of nacos source.
    nacos_id str
    The nacos id of nacos source.
    nacos_name str
    The nacos name of nacos source.
    address String
    The address of nacos source.
    authConfigs List<Property Map>
    The auth config of nacos source.
    contextPath String
    The context path of nacos source.
    grpcPort Number
    The grpc port of nacos source.
    httpPort Number
    The http port of nacos source.
    nacosId String
    The nacos id of nacos source.
    nacosName String
    The nacos name of nacos source.

    GetUpstreamSourcesUpstreamSourceSourceSpecNacosSourceAuthConfig

    basics List<Property Map>
    The basic auth config of nacos source.

    GetUpstreamSourcesUpstreamSourceSourceSpecNacosSourceAuthConfigBasic

    Password string
    The password of basic auth config.
    Username string
    The username of basic auth config.
    Password string
    The password of basic auth config.
    Username string
    The username of basic auth config.
    password String
    The password of basic auth config.
    username String
    The username of basic auth config.
    password string
    The password of basic auth config.
    username string
    The username of basic auth config.
    password str
    The password of basic auth config.
    username str
    The username of basic auth config.
    password String
    The password of basic auth config.
    username String
    The username of basic auth config.

    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