volcenginecc.apig.getUpstreamSource

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

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: Remarks, length limit: 0–253 characters
CreatedTime string: Creation time
GatewayId string: Gateway instance ID
Id string: Uniquely identifies the resource.
IngressSettings Volcengine.GetUpstreamSourceIngressSettings: Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
SourceSpec Volcengine.GetUpstreamSourceSourceSpec: Upstream source configuration
SourceType string: Upstream source type. Options: K8S: Container cluster. Nacos: Registry
Status string: Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
StatusMessage string: Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
UpdatedTime string: Update time
UpstreamSourceId string: Upstream source ID
WatchNamespaces List<string>: Specify namespace

Comments string: Remarks, length limit: 0–253 characters
CreatedTime string: Creation time
GatewayId string: Gateway instance ID
Id string: Uniquely identifies the resource.
IngressSettings GetUpstreamSourceIngressSettings: Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
SourceSpec GetUpstreamSourceSourceSpec: Upstream source configuration
SourceType string: Upstream source type. Options: K8S: Container cluster. Nacos: Registry
Status string: Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
StatusMessage string: Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
UpdatedTime string: Update time
UpstreamSourceId string: Upstream source ID
WatchNamespaces []string: Specify namespace

comments String: Remarks, length limit: 0–253 characters
createdTime String: Creation time
gatewayId String: Gateway instance ID
id String: Uniquely identifies the resource.
ingressSettings GetUpstreamSourceIngressSettings: Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
sourceSpec GetUpstreamSourceSourceSpec: Upstream source configuration
sourceType String: Upstream source type. Options: K8S: Container cluster. Nacos: Registry
status String: Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
statusMessage String: Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
updatedTime String: Update time
upstreamSourceId String: Upstream source ID
watchNamespaces List<String>: Specify namespace

comments string: Remarks, length limit: 0–253 characters
createdTime string: Creation time
gatewayId string: Gateway instance ID
id string: Uniquely identifies the resource.
ingressSettings GetUpstreamSourceIngressSettings: Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
sourceSpec GetUpstreamSourceSourceSpec: Upstream source configuration
sourceType string: Upstream source type. Options: K8S: Container cluster. Nacos: Registry
status string: Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
statusMessage string: Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
updatedTime string: Update time
upstreamSourceId string: Upstream source ID
watchNamespaces string[]: Specify namespace

comments str: Remarks, length limit: 0–253 characters
created_time str: Creation time
gateway_id str: Gateway instance ID
id str: Uniquely identifies the resource.
ingress_settings GetUpstreamSourceIngressSettings: Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
source_spec GetUpstreamSourceSourceSpec: Upstream source configuration
source_type str: Upstream source type. Options: K8S: Container cluster. Nacos: Registry
status str: Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
status_message str: Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
updated_time str: Update time
upstream_source_id str: Upstream source ID
watch_namespaces Sequence[str]: Specify namespace

comments String: Remarks, length limit: 0–253 characters
createdTime String: Creation time
gatewayId String: Gateway instance ID
id String: Uniquely identifies the resource.
ingressSettings Property Map: Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
sourceSpec Property Map: Upstream source configuration
sourceType String: Upstream source type. Options: K8S: Container cluster. Nacos: Registry
status String: Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
statusMessage String: Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
updatedTime String: Update time
upstreamSourceId String: Upstream source ID
watchNamespaces List<String>: Specify namespace

Supporting Types

GetUpstreamSourceIngressSettings

EnableAllIngressClasses bool: Whether to enable all Ingress classes
EnableAllNamespaces bool: Whether all namespaces
EnableIngress bool: Whether enabled
EnableIngressWithoutIngressClass bool: Whether to monitor resources with empty IngressClass
IngressClasses List<string>: Specify IngressClass
UpdateStatus bool: Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address
WatchNamespaces List<string>: Specify namespace

EnableAllIngressClasses bool: Whether to enable all Ingress classes
EnableAllNamespaces bool: Whether all namespaces
EnableIngress bool: Whether enabled
EnableIngressWithoutIngressClass bool: Whether to monitor resources with empty IngressClass
IngressClasses []string: Specify IngressClass
UpdateStatus bool: Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address
WatchNamespaces []string: Specify namespace

enableAllIngressClasses Boolean: Whether to enable all Ingress classes
enableAllNamespaces Boolean: Whether all namespaces
enableIngress Boolean: Whether enabled
enableIngressWithoutIngressClass Boolean: Whether to monitor resources with empty IngressClass
ingressClasses List<String>: Specify IngressClass
updateStatus Boolean: Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address
watchNamespaces List<String>: Specify namespace

enableAllIngressClasses boolean: Whether to enable all Ingress classes
enableAllNamespaces boolean: Whether all namespaces
enableIngress boolean: Whether enabled
enableIngressWithoutIngressClass boolean: Whether to monitor resources with empty IngressClass
ingressClasses string[]: Specify IngressClass
updateStatus boolean: Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address
watchNamespaces string[]: Specify namespace

enable_all_ingress_classes bool: Whether to enable all Ingress classes
enable_all_namespaces bool: Whether all namespaces
enable_ingress bool: Whether enabled
enable_ingress_without_ingress_class bool: Whether to monitor resources with empty IngressClass
ingress_classes Sequence[str]: Specify IngressClass
update_status bool: Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address
watch_namespaces Sequence[str]: Specify namespace

enableAllIngressClasses Boolean: Whether to enable all Ingress classes
enableAllNamespaces Boolean: Whether all namespaces
enableIngress Boolean: Whether enabled
enableIngressWithoutIngressClass Boolean: Whether to monitor resources with empty IngressClass
ingressClasses List<String>: Specify IngressClass
updateStatus Boolean: Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address
watchNamespaces List<String>: Specify namespace