1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. apig
  5. getUpstreamSource
volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

volcenginecc.apig.getUpstreamSource

Get Started
volcenginecc logo
volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

    Data Source schema for Volcengine::APIG::UpstreamSource

    Using getUpstreamSource

    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 getUpstreamSource(args: GetUpstreamSourceArgs, opts?: InvokeOptions): Promise<GetUpstreamSourceResult>
    function getUpstreamSourceOutput(args: GetUpstreamSourceOutputArgs, opts?: InvokeOptions): Output<GetUpstreamSourceResult>
    def get_upstream_source(id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetUpstreamSourceResult
    def get_upstream_source_output(id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetUpstreamSourceResult]
    func LookupUpstreamSource(ctx *Context, args *LookupUpstreamSourceArgs, opts ...InvokeOption) (*LookupUpstreamSourceResult, error)
    func LookupUpstreamSourceOutput(ctx *Context, args *LookupUpstreamSourceOutputArgs, opts ...InvokeOption) LookupUpstreamSourceResultOutput

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

    public static class GetUpstreamSource 
    {
        public static Task<GetUpstreamSourceResult> InvokeAsync(GetUpstreamSourceArgs args, InvokeOptions? opts = null)
        public static Output<GetUpstreamSourceResult> Invoke(GetUpstreamSourceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUpstreamSourceResult> getUpstreamSource(GetUpstreamSourceArgs args, InvokeOptions options)
    public static Output<GetUpstreamSourceResult> getUpstreamSource(GetUpstreamSourceArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:apig/getUpstreamSource:getUpstreamSource
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getUpstreamSource Result

    The following output properties are available:

    Comments string
    备注,长度限制为0~253个字符。
    CreatedTime string
    创建时间。
    GatewayId string
    网关实例ID。
    Id string
    Uniquely identifies the resource.
    IngressSettings Volcengine.GetUpstreamSourceIngressSettings
    路由同步。开启后,API网关会自动监听Ingress资源的变化,并将Ingress资源转义为服务,域名,Upstream等资源合并至当前网关。由Ingress转义的资源不支持在控制台操作。仅支持容器集群来源类型。
    SourceSpec Volcengine.GetUpstreamSourceSourceSpec
    Upstream来源配置。
    SourceType string
    Upstream来源类型,取值:K8S:容器集群。Nacos:注册中心。
    Status string
    导入状态,取值:Syncing:导入中。SyncedSucceed:导入成功。SyncedFailed:导入失败。
    StatusMessage string
    导入状态信息,取值:ConnectionFailed:Nacos集群无法连接。AuthenticationFailed:认证失败。PermissionFailed:Nacos集群无法连接。
    UpdatedTime string
    更新时间。
    UpstreamSourceId string
    Upstream来源ID。
    WatchNamespaces List<string>
    指定命名空间。
    Comments string
    备注,长度限制为0~253个字符。
    CreatedTime string
    创建时间。
    GatewayId string
    网关实例ID。
    Id string
    Uniquely identifies the resource.
    IngressSettings GetUpstreamSourceIngressSettings
    路由同步。开启后,API网关会自动监听Ingress资源的变化,并将Ingress资源转义为服务,域名,Upstream等资源合并至当前网关。由Ingress转义的资源不支持在控制台操作。仅支持容器集群来源类型。
    SourceSpec GetUpstreamSourceSourceSpec
    Upstream来源配置。
    SourceType string
    Upstream来源类型,取值:K8S:容器集群。Nacos:注册中心。
    Status string
    导入状态,取值:Syncing:导入中。SyncedSucceed:导入成功。SyncedFailed:导入失败。
    StatusMessage string
    导入状态信息,取值:ConnectionFailed:Nacos集群无法连接。AuthenticationFailed:认证失败。PermissionFailed:Nacos集群无法连接。
    UpdatedTime string
    更新时间。
    UpstreamSourceId string
    Upstream来源ID。
    WatchNamespaces []string
    指定命名空间。
    comments String
    备注,长度限制为0~253个字符。
    createdTime String
    创建时间。
    gatewayId String
    网关实例ID。
    id String
    Uniquely identifies the resource.
    ingressSettings GetUpstreamSourceIngressSettings
    路由同步。开启后,API网关会自动监听Ingress资源的变化,并将Ingress资源转义为服务,域名,Upstream等资源合并至当前网关。由Ingress转义的资源不支持在控制台操作。仅支持容器集群来源类型。
    sourceSpec GetUpstreamSourceSourceSpec
    Upstream来源配置。
    sourceType String
    Upstream来源类型,取值:K8S:容器集群。Nacos:注册中心。
    status String
    导入状态,取值:Syncing:导入中。SyncedSucceed:导入成功。SyncedFailed:导入失败。
    statusMessage String
    导入状态信息,取值:ConnectionFailed:Nacos集群无法连接。AuthenticationFailed:认证失败。PermissionFailed:Nacos集群无法连接。
    updatedTime String
    更新时间。
    upstreamSourceId String
    Upstream来源ID。
    watchNamespaces List<String>
    指定命名空间。
    comments string
    备注,长度限制为0~253个字符。
    createdTime string
    创建时间。
    gatewayId string
    网关实例ID。
    id string
    Uniquely identifies the resource.
    ingressSettings GetUpstreamSourceIngressSettings
    路由同步。开启后,API网关会自动监听Ingress资源的变化,并将Ingress资源转义为服务,域名,Upstream等资源合并至当前网关。由Ingress转义的资源不支持在控制台操作。仅支持容器集群来源类型。
    sourceSpec GetUpstreamSourceSourceSpec
    Upstream来源配置。
    sourceType string
    Upstream来源类型,取值:K8S:容器集群。Nacos:注册中心。
    status string
    导入状态,取值:Syncing:导入中。SyncedSucceed:导入成功。SyncedFailed:导入失败。
    statusMessage string
    导入状态信息,取值:ConnectionFailed:Nacos集群无法连接。AuthenticationFailed:认证失败。PermissionFailed:Nacos集群无法连接。
    updatedTime string
    更新时间。
    upstreamSourceId string
    Upstream来源ID。
    watchNamespaces string[]
    指定命名空间。
    comments str
    备注,长度限制为0~253个字符。
    created_time str
    创建时间。
    gateway_id str
    网关实例ID。
    id str
    Uniquely identifies the resource.
    ingress_settings GetUpstreamSourceIngressSettings
    路由同步。开启后,API网关会自动监听Ingress资源的变化,并将Ingress资源转义为服务,域名,Upstream等资源合并至当前网关。由Ingress转义的资源不支持在控制台操作。仅支持容器集群来源类型。
    source_spec GetUpstreamSourceSourceSpec
    Upstream来源配置。
    source_type str
    Upstream来源类型,取值:K8S:容器集群。Nacos:注册中心。
    status str
    导入状态,取值:Syncing:导入中。SyncedSucceed:导入成功。SyncedFailed:导入失败。
    status_message str
    导入状态信息,取值:ConnectionFailed:Nacos集群无法连接。AuthenticationFailed:认证失败。PermissionFailed:Nacos集群无法连接。
    updated_time str
    更新时间。
    upstream_source_id str
    Upstream来源ID。
    watch_namespaces Sequence[str]
    指定命名空间。
    comments String
    备注,长度限制为0~253个字符。
    createdTime String
    创建时间。
    gatewayId String
    网关实例ID。
    id String
    Uniquely identifies the resource.
    ingressSettings Property Map
    路由同步。开启后,API网关会自动监听Ingress资源的变化,并将Ingress资源转义为服务,域名,Upstream等资源合并至当前网关。由Ingress转义的资源不支持在控制台操作。仅支持容器集群来源类型。
    sourceSpec Property Map
    Upstream来源配置。
    sourceType String
    Upstream来源类型,取值:K8S:容器集群。Nacos:注册中心。
    status String
    导入状态,取值:Syncing:导入中。SyncedSucceed:导入成功。SyncedFailed:导入失败。
    statusMessage String
    导入状态信息,取值:ConnectionFailed:Nacos集群无法连接。AuthenticationFailed:认证失败。PermissionFailed:Nacos集群无法连接。
    updatedTime String
    更新时间。
    upstreamSourceId String
    Upstream来源ID。
    watchNamespaces List<String>
    指定命名空间。

    Supporting Types

    GetUpstreamSourceIngressSettings

    EnableAllIngressClasses bool
    是否启用所有Ingress类。
    EnableAllNamespaces bool
    是否全部命名空间。
    EnableIngress bool
    是否开启。
    EnableIngressWithoutIngressClass bool
    是否监听IngressClass为空的资源。
    IngressClasses List<string>
    指定IngressClass。
    UpdateStatus bool
    流量入口切换。开启后,当前集群Ingress中Status的IP地址会被修改为当前网关的IP地址。
    WatchNamespaces List<string>
    指定命名空间。
    EnableAllIngressClasses bool
    是否启用所有Ingress类。
    EnableAllNamespaces bool
    是否全部命名空间。
    EnableIngress bool
    是否开启。
    EnableIngressWithoutIngressClass bool
    是否监听IngressClass为空的资源。
    IngressClasses []string
    指定IngressClass。
    UpdateStatus bool
    流量入口切换。开启后,当前集群Ingress中Status的IP地址会被修改为当前网关的IP地址。
    WatchNamespaces []string
    指定命名空间。
    enableAllIngressClasses Boolean
    是否启用所有Ingress类。
    enableAllNamespaces Boolean
    是否全部命名空间。
    enableIngress Boolean
    是否开启。
    enableIngressWithoutIngressClass Boolean
    是否监听IngressClass为空的资源。
    ingressClasses List<String>
    指定IngressClass。
    updateStatus Boolean
    流量入口切换。开启后,当前集群Ingress中Status的IP地址会被修改为当前网关的IP地址。
    watchNamespaces List<String>
    指定命名空间。
    enableAllIngressClasses boolean
    是否启用所有Ingress类。
    enableAllNamespaces boolean
    是否全部命名空间。
    enableIngress boolean
    是否开启。
    enableIngressWithoutIngressClass boolean
    是否监听IngressClass为空的资源。
    ingressClasses string[]
    指定IngressClass。
    updateStatus boolean
    流量入口切换。开启后,当前集群Ingress中Status的IP地址会被修改为当前网关的IP地址。
    watchNamespaces string[]
    指定命名空间。
    enable_all_ingress_classes bool
    是否启用所有Ingress类。
    enable_all_namespaces bool
    是否全部命名空间。
    enable_ingress bool
    是否开启。
    enable_ingress_without_ingress_class bool
    是否监听IngressClass为空的资源。
    ingress_classes Sequence[str]
    指定IngressClass。
    update_status bool
    流量入口切换。开启后,当前集群Ingress中Status的IP地址会被修改为当前网关的IP地址。
    watch_namespaces Sequence[str]
    指定命名空间。
    enableAllIngressClasses Boolean
    是否启用所有Ingress类。
    enableAllNamespaces Boolean
    是否全部命名空间。
    enableIngress Boolean
    是否开启。
    enableIngressWithoutIngressClass Boolean
    是否监听IngressClass为空的资源。
    ingressClasses List<String>
    指定IngressClass。
    updateStatus Boolean
    流量入口切换。开启后,当前集群Ingress中Status的IP地址会被修改为当前网关的IP地址。
    watchNamespaces List<String>
    指定命名空间。

    GetUpstreamSourceSourceSpec

    k8SSource Property Map
    容器集群来源。
    nacosSource Property Map
    注册中心来源。

    GetUpstreamSourceSourceSpecK8SSource

    ClusterId string
    集群ID。
    ClusterType string
    集群类型。
    ClusterId string
    集群ID。
    ClusterType string
    集群类型。
    clusterId String
    集群ID。
    clusterType String
    集群类型。
    clusterId string
    集群ID。
    clusterType string
    集群类型。
    cluster_id str
    集群ID。
    cluster_type str
    集群类型。
    clusterId String
    集群ID。
    clusterType String
    集群类型。

    GetUpstreamSourceSourceSpecNacosSource

    AuthConfig GetUpstreamSourceSourceSpecNacosSourceAuthConfig
    认证配置。
    NacosId string
    Nacos ID。
    NacosName string
    Nacos名称。
    authConfig GetUpstreamSourceSourceSpecNacosSourceAuthConfig
    认证配置。
    nacosId String
    Nacos ID。
    nacosName String
    Nacos名称。
    authConfig GetUpstreamSourceSourceSpecNacosSourceAuthConfig
    认证配置。
    nacosId string
    Nacos ID。
    nacosName string
    Nacos名称。
    authConfig Property Map
    认证配置。
    nacosId String
    Nacos ID。
    nacosName String
    Nacos名称。

    GetUpstreamSourceSourceSpecNacosSourceAuthConfig

    basic Property Map
    Basic认证。

    GetUpstreamSourceSourceSpecNacosSourceAuthConfigBasic

    Password string
    密码。
    Username string
    用户名。
    Password string
    密码。
    Username string
    用户名。
    password String
    密码。
    username String
    用户名。
    password string
    密码。
    username string
    用户名。
    password str
    密码。
    username str
    用户名。
    password String
    密码。
    username String
    用户名。

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine
      Meet Neo: Your AI Platform Teammate