Upstream

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

Upstream is an abstraction of the backend for API gateway instances. You can group backend applications with the same functionality into an upstream, which decouples routing from backend applications and provides flexible support for scenarios such as canary releases and multi-version management. This article introduces the concept and purpose of upstream

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  aPIGUpstreamAIProviderDemo:
    type: volcenginecc:apig:Upstream
    name: APIGUpstreamAIProviderDemo
    properties:
      circuitBreakingSettings:
        base_ejection_time: 30
        consecutive_errors: 5
        enable: true
        interval: 10
        max_ejection_percent: 20
        min_health_percent: 60
      comments: this is a test
      connectionPoolSettings:
        enable: true
        http_1_max_pending_requests: 1000
        idle_timeout: 1000
        max_connections: 1000
      gatewayId: gd6hagxxxxxkh7is70
      loadBalancerSettings:
        lb_policy: SimpleLB
        simple_lb: LEAST_CONN
        warmup_duration: 5
      name: test-7
      protocol: HTTP
      tlsSettings:
        sni: ""
        tls_mode: DISABLE
      sourceType: Domain
      upstreamSpec:
        domain:
          domainList:
            - domain: www.test7.com
              port: 5566

Create Upstream Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Upstream(name: string, args: UpstreamArgs, opts?: CustomResourceOptions);

@overload
def Upstream(resource_name: str,
             args: UpstreamArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Upstream(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             gateway_id: Optional[str] = None,
             name: Optional[str] = None,
             source_type: Optional[str] = None,
             upstream_spec: Optional[UpstreamUpstreamSpecArgs] = None,
             circuit_breaking_settings: Optional[UpstreamCircuitBreakingSettingsArgs] = None,
             comments: Optional[str] = None,
             connection_pool_settings: Optional[UpstreamConnectionPoolSettingsArgs] = None,
             load_balancer_settings: Optional[UpstreamLoadBalancerSettingsArgs] = None,
             protocol: Optional[str] = None,
             tls_settings: Optional[UpstreamTlsSettingsArgs] = None)

func NewUpstream(ctx *Context, name string, args UpstreamArgs, opts ...ResourceOption) (*Upstream, error)

public Upstream(string name, UpstreamArgs args, CustomResourceOptions? opts = null)

public Upstream(String name, UpstreamArgs args)
public Upstream(String name, UpstreamArgs args, CustomResourceOptions options)

type: volcenginecc:apig:Upstream
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args UpstreamArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args UpstreamArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args UpstreamArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UpstreamArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args UpstreamArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Upstream Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Upstream resource accepts the following input properties:

GatewayId string: Gateway Instance ID
Name string: Upstream name
SourceType string: Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy
UpstreamSpec Volcengine.UpstreamUpstreamSpec: Upstream Configuration
CircuitBreakingSettings Volcengine.UpstreamCircuitBreakingSettings: Service circuit breaking configuration
Comments string: Remarks
ConnectionPoolSettings Volcengine.UpstreamConnectionPoolSettings: Connection Pool Configuration
LoadBalancerSettings Volcengine.UpstreamLoadBalancerSettings: Load Balancing Configuration
Protocol string: Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC
TlsSettings Volcengine.UpstreamTlsSettings: TLS Configuration

GatewayId string: Gateway Instance ID
Name string: Upstream name
SourceType string: Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy
UpstreamSpec UpstreamUpstreamSpecArgs: Upstream Configuration
CircuitBreakingSettings UpstreamCircuitBreakingSettingsArgs: Service circuit breaking configuration
Comments string: Remarks
ConnectionPoolSettings UpstreamConnectionPoolSettingsArgs: Connection Pool Configuration
LoadBalancerSettings UpstreamLoadBalancerSettingsArgs: Load Balancing Configuration
Protocol string: Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC
TlsSettings UpstreamTlsSettingsArgs: TLS Configuration

gatewayId String: Gateway Instance ID
name String: Upstream name
sourceType String: Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy
upstreamSpec UpstreamUpstreamSpec: Upstream Configuration
circuitBreakingSettings UpstreamCircuitBreakingSettings: Service circuit breaking configuration
comments String: Remarks
connectionPoolSettings UpstreamConnectionPoolSettings: Connection Pool Configuration
loadBalancerSettings UpstreamLoadBalancerSettings: Load Balancing Configuration
protocol String: Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC
tlsSettings UpstreamTlsSettings: TLS Configuration

gatewayId string: Gateway Instance ID
name string: Upstream name
sourceType string: Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy
upstreamSpec UpstreamUpstreamSpec: Upstream Configuration
circuitBreakingSettings UpstreamCircuitBreakingSettings: Service circuit breaking configuration
comments string: Remarks
connectionPoolSettings UpstreamConnectionPoolSettings: Connection Pool Configuration
loadBalancerSettings UpstreamLoadBalancerSettings: Load Balancing Configuration
protocol string: Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC
tlsSettings UpstreamTlsSettings: TLS Configuration

gateway_id str: Gateway Instance ID
name str: Upstream name
source_type str: Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy
upstream_spec UpstreamUpstreamSpecArgs: Upstream Configuration
circuit_breaking_settings UpstreamCircuitBreakingSettingsArgs: Service circuit breaking configuration
comments str: Remarks
connection_pool_settings UpstreamConnectionPoolSettingsArgs: Connection Pool Configuration
load_balancer_settings UpstreamLoadBalancerSettingsArgs: Load Balancing Configuration
protocol str: Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC
tls_settings UpstreamTlsSettingsArgs: TLS Configuration

gatewayId String: Gateway Instance ID
name String: Upstream name
sourceType String: Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy
upstreamSpec Property Map: Upstream Configuration
circuitBreakingSettings Property Map: Service circuit breaking configuration
comments String: Remarks
connectionPoolSettings Property Map: Connection Pool Configuration
loadBalancerSettings Property Map: Load Balancing Configuration
protocol String: Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC
tlsSettings Property Map: TLS Configuration

Outputs

All input properties are implicitly available as output properties. Additionally, the Upstream resource produces the following output properties:

BackendTargets List<Volcengine.UpstreamBackendTarget>
CreatedTime string: Upstream creation time
Id string: The provider-assigned unique ID for this managed resource.
UpdatedTime string: Upstream update time
UpstreamId string: Upstream ID。
VersionDetails List<Volcengine.UpstreamVersionDetail>

BackendTargets []UpstreamBackendTarget
CreatedTime string: Upstream creation time
Id string: The provider-assigned unique ID for this managed resource.
UpdatedTime string: Upstream update time
UpstreamId string: Upstream ID。
VersionDetails []UpstreamVersionDetail

backendTargets List<UpstreamBackendTarget>
createdTime String: Upstream creation time
id String: The provider-assigned unique ID for this managed resource.
updatedTime String: Upstream update time
upstreamId String: Upstream ID。
versionDetails List<UpstreamVersionDetail>

backendTargets UpstreamBackendTarget[]
createdTime string: Upstream creation time
id string: The provider-assigned unique ID for this managed resource.
updatedTime string: Upstream update time
upstreamId string: Upstream ID。
versionDetails UpstreamVersionDetail[]

backend_targets Sequence[UpstreamBackendTarget]
created_time str: Upstream creation time
id str: The provider-assigned unique ID for this managed resource.
updated_time str: Upstream update time
upstream_id str: Upstream ID。
version_details Sequence[UpstreamVersionDetail]

backendTargets List<Property Map>
createdTime String: Upstream creation time
id String: The provider-assigned unique ID for this managed resource.
updatedTime String: Upstream update time
upstreamId String: Upstream ID。
versionDetails List<Property Map>

Look up Existing Upstream Resource

Get an existing Upstream resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UpstreamState, opts?: CustomResourceOptions): Upstream

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backend_targets: Optional[Sequence[UpstreamBackendTargetArgs]] = None,
        circuit_breaking_settings: Optional[UpstreamCircuitBreakingSettingsArgs] = None,
        comments: Optional[str] = None,
        connection_pool_settings: Optional[UpstreamConnectionPoolSettingsArgs] = None,
        created_time: Optional[str] = None,
        gateway_id: Optional[str] = None,
        load_balancer_settings: Optional[UpstreamLoadBalancerSettingsArgs] = None,
        name: Optional[str] = None,
        protocol: Optional[str] = None,
        source_type: Optional[str] = None,
        tls_settings: Optional[UpstreamTlsSettingsArgs] = None,
        updated_time: Optional[str] = None,
        upstream_id: Optional[str] = None,
        upstream_spec: Optional[UpstreamUpstreamSpecArgs] = None,
        version_details: Optional[Sequence[UpstreamVersionDetailArgs]] = None) -> Upstream

func GetUpstream(ctx *Context, name string, id IDInput, state *UpstreamState, opts ...ResourceOption) (*Upstream, error)

public static Upstream Get(string name, Input<string> id, UpstreamState? state, CustomResourceOptions? opts = null)

public static Upstream get(String name, Output<String> id, UpstreamState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:apig:Upstream    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

BackendTargets List<Volcengine.UpstreamBackendTarget>
CircuitBreakingSettings Volcengine.UpstreamCircuitBreakingSettings: Service circuit breaking configuration
Comments string: Remarks
ConnectionPoolSettings Volcengine.UpstreamConnectionPoolSettings: Connection Pool Configuration
CreatedTime string: Upstream creation time
GatewayId string: Gateway Instance ID
LoadBalancerSettings Volcengine.UpstreamLoadBalancerSettings: Load Balancing Configuration
Name string: Upstream name
Protocol string: Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC
SourceType string: Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy
TlsSettings Volcengine.UpstreamTlsSettings: TLS Configuration
UpdatedTime string: Upstream update time
UpstreamId string: Upstream ID。
UpstreamSpec Volcengine.UpstreamUpstreamSpec: Upstream Configuration
VersionDetails List<Volcengine.UpstreamVersionDetail>

BackendTargets []UpstreamBackendTargetArgs
CircuitBreakingSettings UpstreamCircuitBreakingSettingsArgs: Service circuit breaking configuration
Comments string: Remarks
ConnectionPoolSettings UpstreamConnectionPoolSettingsArgs: Connection Pool Configuration
CreatedTime string: Upstream creation time
GatewayId string: Gateway Instance ID
LoadBalancerSettings UpstreamLoadBalancerSettingsArgs: Load Balancing Configuration
Name string: Upstream name
Protocol string: Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC
SourceType string: Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy
TlsSettings UpstreamTlsSettingsArgs: TLS Configuration
UpdatedTime string: Upstream update time
UpstreamId string: Upstream ID。
UpstreamSpec UpstreamUpstreamSpecArgs: Upstream Configuration
VersionDetails []UpstreamVersionDetailArgs

backendTargets List<UpstreamBackendTarget>
circuitBreakingSettings UpstreamCircuitBreakingSettings: Service circuit breaking configuration
comments String: Remarks
connectionPoolSettings UpstreamConnectionPoolSettings: Connection Pool Configuration
createdTime String: Upstream creation time
gatewayId String: Gateway Instance ID
loadBalancerSettings UpstreamLoadBalancerSettings: Load Balancing Configuration
name String: Upstream name
protocol String: Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC
sourceType String: Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy
tlsSettings UpstreamTlsSettings: TLS Configuration
updatedTime String: Upstream update time
upstreamId String: Upstream ID。
upstreamSpec UpstreamUpstreamSpec: Upstream Configuration
versionDetails List<UpstreamVersionDetail>

backendTargets UpstreamBackendTarget[]
circuitBreakingSettings UpstreamCircuitBreakingSettings: Service circuit breaking configuration
comments string: Remarks
connectionPoolSettings UpstreamConnectionPoolSettings: Connection Pool Configuration
createdTime string: Upstream creation time
gatewayId string: Gateway Instance ID
loadBalancerSettings UpstreamLoadBalancerSettings: Load Balancing Configuration
name string: Upstream name
protocol string: Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC
sourceType string: Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy
tlsSettings UpstreamTlsSettings: TLS Configuration
updatedTime string: Upstream update time
upstreamId string: Upstream ID。
upstreamSpec UpstreamUpstreamSpec: Upstream Configuration
versionDetails UpstreamVersionDetail[]

backend_targets Sequence[UpstreamBackendTargetArgs]
circuit_breaking_settings UpstreamCircuitBreakingSettingsArgs: Service circuit breaking configuration
comments str: Remarks
connection_pool_settings UpstreamConnectionPoolSettingsArgs: Connection Pool Configuration
created_time str: Upstream creation time
gateway_id str: Gateway Instance ID
load_balancer_settings UpstreamLoadBalancerSettingsArgs: Load Balancing Configuration
name str: Upstream name
protocol str: Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC
source_type str: Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy
tls_settings UpstreamTlsSettingsArgs: TLS Configuration
updated_time str: Upstream update time
upstream_id str: Upstream ID。
upstream_spec UpstreamUpstreamSpecArgs: Upstream Configuration
version_details Sequence[UpstreamVersionDetailArgs]

backendTargets List<Property Map>
circuitBreakingSettings Property Map: Service circuit breaking configuration
comments String: Remarks
connectionPoolSettings Property Map: Connection Pool Configuration
createdTime String: Upstream creation time
gatewayId String: Gateway Instance ID
loadBalancerSettings Property Map: Load Balancing Configuration
name String: Upstream name
protocol String: Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC
sourceType String: Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy
tlsSettings Property Map: TLS Configuration
updatedTime String: Upstream update time
upstreamId String: Upstream ID。
upstreamSpec Property Map: Upstream Configuration
versionDetails List<Property Map>

Supporting Types

UpstreamBackendTarget, UpstreamBackendTargetArgs

HealthStatus string: Health Check Status
Ip string: Backend node IP
Port int: Backend node port

HealthStatus string: Health Check Status
Ip string: Backend node IP
Port int: Backend node port

healthStatus String: Health Check Status
ip String: Backend node IP
port Integer: Backend node port

healthStatus string: Health Check Status
ip string: Backend node IP
port number: Backend node port

health_status str: Health Check Status
ip str: Backend node IP
port int: Backend node port

healthStatus String: Health Check Status
ip String: Backend node IP
port Number: Backend node port

UpstreamCircuitBreakingSettings, UpstreamCircuitBreakingSettingsArgs

BaseEjectionTime int: Minimum pop time, in milliseconds. Value range: 1–86400000. Default: 30 seconds
ConsecutiveErrors int: Consecutive failure count. Value range: 1~100. Default: 5
Enable bool: Enable
Interval int: Calculation cycle, in milliseconds. Value range: 1–86400000. Default: 10 seconds
MaxEjectionPercent int: Maximum circuit breaking ratio. Value range: 1~100. Default: 20%
MinHealthPercent int: Minimum health ratio. Value range: 0~100. Default: 60%

BaseEjectionTime int: Minimum pop time, in milliseconds. Value range: 1–86400000. Default: 30 seconds
ConsecutiveErrors int: Consecutive failure count. Value range: 1~100. Default: 5
Enable bool: Enable
Interval int: Calculation cycle, in milliseconds. Value range: 1–86400000. Default: 10 seconds
MaxEjectionPercent int: Maximum circuit breaking ratio. Value range: 1~100. Default: 20%
MinHealthPercent int: Minimum health ratio. Value range: 0~100. Default: 60%

baseEjectionTime Integer: Minimum pop time, in milliseconds. Value range: 1–86400000. Default: 30 seconds
consecutiveErrors Integer: Consecutive failure count. Value range: 1~100. Default: 5
enable Boolean: Enable
interval Integer: Calculation cycle, in milliseconds. Value range: 1–86400000. Default: 10 seconds
maxEjectionPercent Integer: Maximum circuit breaking ratio. Value range: 1~100. Default: 20%
minHealthPercent Integer: Minimum health ratio. Value range: 0~100. Default: 60%

baseEjectionTime number: Minimum pop time, in milliseconds. Value range: 1–86400000. Default: 30 seconds
consecutiveErrors number: Consecutive failure count. Value range: 1~100. Default: 5
enable boolean: Enable
interval number: Calculation cycle, in milliseconds. Value range: 1–86400000. Default: 10 seconds
maxEjectionPercent number: Maximum circuit breaking ratio. Value range: 1~100. Default: 20%
minHealthPercent number: Minimum health ratio. Value range: 0~100. Default: 60%

base_ejection_time int: Minimum pop time, in milliseconds. Value range: 1–86400000. Default: 30 seconds
consecutive_errors int: Consecutive failure count. Value range: 1~100. Default: 5
enable bool: Enable
interval int: Calculation cycle, in milliseconds. Value range: 1–86400000. Default: 10 seconds
max_ejection_percent int: Maximum circuit breaking ratio. Value range: 1~100. Default: 20%
min_health_percent int: Minimum health ratio. Value range: 0~100. Default: 60%

baseEjectionTime Number: Minimum pop time, in milliseconds. Value range: 1–86400000. Default: 30 seconds
consecutiveErrors Number: Consecutive failure count. Value range: 1~100. Default: 5
enable Boolean: Enable
interval Number: Calculation cycle, in milliseconds. Value range: 1–86400000. Default: 10 seconds
maxEjectionPercent Number: Maximum circuit breaking ratio. Value range: 1~100. Default: 20%
minHealthPercent Number: Minimum health ratio. Value range: 0~100. Default: 60%

UpstreamConnectionPoolSettings, UpstreamConnectionPoolSettingsArgs

Enable bool: Enable
Http1MaxPendingRequests int: Maximum HTTP/1 pending requests. Value range: 0~2^31-1. 0 means unlimited
IdleTimeout int: Idle timeout, in seconds. Value range: 0–2^31-1. 0 means no limit
MaxConnections int: Maximum TCP connections. Value range: 0~2^31-1. 0 means unlimited

Enable bool: Enable
Http1MaxPendingRequests int: Maximum HTTP/1 pending requests. Value range: 0~2^31-1. 0 means unlimited
IdleTimeout int: Idle timeout, in seconds. Value range: 0–2^31-1. 0 means no limit
MaxConnections int: Maximum TCP connections. Value range: 0~2^31-1. 0 means unlimited

enable Boolean: Enable
http1MaxPendingRequests Integer: Maximum HTTP/1 pending requests. Value range: 0~2^31-1. 0 means unlimited
idleTimeout Integer: Idle timeout, in seconds. Value range: 0–2^31-1. 0 means no limit
maxConnections Integer: Maximum TCP connections. Value range: 0~2^31-1. 0 means unlimited

enable boolean: Enable
http1MaxPendingRequests number: Maximum HTTP/1 pending requests. Value range: 0~2^31-1. 0 means unlimited
idleTimeout number: Idle timeout, in seconds. Value range: 0–2^31-1. 0 means no limit
maxConnections number: Maximum TCP connections. Value range: 0~2^31-1. 0 means unlimited

enable bool: Enable
http1_max_pending_requests int: Maximum HTTP/1 pending requests. Value range: 0~2^31-1. 0 means unlimited
idle_timeout int: Idle timeout, in seconds. Value range: 0–2^31-1. 0 means no limit
max_connections int: Maximum TCP connections. Value range: 0~2^31-1. 0 means unlimited

enable Boolean: Enable
http1MaxPendingRequests Number: Maximum HTTP/1 pending requests. Value range: 0~2^31-1. 0 means unlimited
idleTimeout Number: Idle timeout, in seconds. Value range: 0–2^31-1. 0 means no limit
maxConnections Number: Maximum TCP connections. Value range: 0~2^31-1. 0 means unlimited

UpstreamLoadBalancerSettings, UpstreamLoadBalancerSettingsArgs

ConsistentHashLb Volcengine.UpstreamLoadBalancerSettingsConsistentHashLb: Consistent Hash Load Balancing
LbPolicy string: Load balancing policy. Options: SimpleLB: simple load balancing. ConsistentHashLB: consistent hash load balancing
SimpleLb string: Simple load balancing. Options: ROUNDROBIN: round robin. LEASTCONN: least connections. RANDOM: random
WarmupDuration int: Warm-up time (seconds)

ConsistentHashLb UpstreamLoadBalancerSettingsConsistentHashLb: Consistent Hash Load Balancing
LbPolicy string: Load balancing policy. Options: SimpleLB: simple load balancing. ConsistentHashLB: consistent hash load balancing
SimpleLb string: Simple load balancing. Options: ROUNDROBIN: round robin. LEASTCONN: least connections. RANDOM: random
WarmupDuration int: Warm-up time (seconds)

consistentHashLb UpstreamLoadBalancerSettingsConsistentHashLb: Consistent Hash Load Balancing
lbPolicy String: Load balancing policy. Options: SimpleLB: simple load balancing. ConsistentHashLB: consistent hash load balancing
simpleLb String: Simple load balancing. Options: ROUNDROBIN: round robin. LEASTCONN: least connections. RANDOM: random
warmupDuration Integer: Warm-up time (seconds)

consistentHashLb UpstreamLoadBalancerSettingsConsistentHashLb: Consistent Hash Load Balancing
lbPolicy string: Load balancing policy. Options: SimpleLB: simple load balancing. ConsistentHashLB: consistent hash load balancing
simpleLb string: Simple load balancing. Options: ROUNDROBIN: round robin. LEASTCONN: least connections. RANDOM: random
warmupDuration number: Warm-up time (seconds)

consistent_hash_lb UpstreamLoadBalancerSettingsConsistentHashLb: Consistent Hash Load Balancing
lb_policy str: Load balancing policy. Options: SimpleLB: simple load balancing. ConsistentHashLB: consistent hash load balancing
simple_lb str: Simple load balancing. Options: ROUNDROBIN: round robin. LEASTCONN: least connections. RANDOM: random
warmup_duration int: Warm-up time (seconds)

consistentHashLb Property Map: Consistent Hash Load Balancing
lbPolicy String: Load balancing policy. Options: SimpleLB: simple load balancing. ConsistentHashLB: consistent hash load balancing
simpleLb String: Simple load balancing. Options: ROUNDROBIN: round robin. LEASTCONN: least connections. RANDOM: random
warmupDuration Number: Warm-up time (seconds)

UpstreamLoadBalancerSettingsConsistentHashLb, UpstreamLoadBalancerSettingsConsistentHashLbArgs

HashBalanceFactor int: Overload protection parameter. Value range: 100–200. When set to 120, overload protection is triggered if the current active request count of an upstream node exceeds 120% of the average active request count. When overload protection is triggered, even if the request hash matches a specific upstream node, the load balancer will randomly select an upstream node
HashKey string: Consistent hash method. Options: UseSourceIp: based on source IP address. HttpQueryParameterName: based on parameter. HttpHeaderName: based on header. HTTPCookie: based on cookie
HttpCookie Volcengine.UpstreamLoadBalancerSettingsConsistentHashLbHttpCookie: Cookie。
HttpHeaderName string: Parameter. Supports printable ASCII characters, length: 1–256 characters
HttpQueryParameterName string: Parameter. Supports printable ASCII characters, length: 1–256 characters
UseSourceIp string: Source IP address

HashBalanceFactor int: Overload protection parameter. Value range: 100–200. When set to 120, overload protection is triggered if the current active request count of an upstream node exceeds 120% of the average active request count. When overload protection is triggered, even if the request hash matches a specific upstream node, the load balancer will randomly select an upstream node
HashKey string: Consistent hash method. Options: UseSourceIp: based on source IP address. HttpQueryParameterName: based on parameter. HttpHeaderName: based on header. HTTPCookie: based on cookie
HttpCookie UpstreamLoadBalancerSettingsConsistentHashLbHttpCookie: Cookie。
HttpHeaderName string: Parameter. Supports printable ASCII characters, length: 1–256 characters
HttpQueryParameterName string: Parameter. Supports printable ASCII characters, length: 1–256 characters
UseSourceIp string: Source IP address

hashBalanceFactor Integer: Overload protection parameter. Value range: 100–200. When set to 120, overload protection is triggered if the current active request count of an upstream node exceeds 120% of the average active request count. When overload protection is triggered, even if the request hash matches a specific upstream node, the load balancer will randomly select an upstream node
hashKey String: Consistent hash method. Options: UseSourceIp: based on source IP address. HttpQueryParameterName: based on parameter. HttpHeaderName: based on header. HTTPCookie: based on cookie
httpCookie UpstreamLoadBalancerSettingsConsistentHashLbHttpCookie: Cookie。
httpHeaderName String: Parameter. Supports printable ASCII characters, length: 1–256 characters
httpQueryParameterName String: Parameter. Supports printable ASCII characters, length: 1–256 characters
useSourceIp String: Source IP address

hashBalanceFactor number: Overload protection parameter. Value range: 100–200. When set to 120, overload protection is triggered if the current active request count of an upstream node exceeds 120% of the average active request count. When overload protection is triggered, even if the request hash matches a specific upstream node, the load balancer will randomly select an upstream node
hashKey string: Consistent hash method. Options: UseSourceIp: based on source IP address. HttpQueryParameterName: based on parameter. HttpHeaderName: based on header. HTTPCookie: based on cookie
httpCookie UpstreamLoadBalancerSettingsConsistentHashLbHttpCookie: Cookie。
httpHeaderName string: Parameter. Supports printable ASCII characters, length: 1–256 characters
httpQueryParameterName string: Parameter. Supports printable ASCII characters, length: 1–256 characters
useSourceIp string: Source IP address

hash_balance_factor int: Overload protection parameter. Value range: 100–200. When set to 120, overload protection is triggered if the current active request count of an upstream node exceeds 120% of the average active request count. When overload protection is triggered, even if the request hash matches a specific upstream node, the load balancer will randomly select an upstream node
hash_key str: Consistent hash method. Options: UseSourceIp: based on source IP address. HttpQueryParameterName: based on parameter. HttpHeaderName: based on header. HTTPCookie: based on cookie
http_cookie UpstreamLoadBalancerSettingsConsistentHashLbHttpCookie: Cookie。
http_header_name str: Parameter. Supports printable ASCII characters, length: 1–256 characters
http_query_parameter_name str: Parameter. Supports printable ASCII characters, length: 1–256 characters
use_source_ip str: Source IP address

hashBalanceFactor Number: Overload protection parameter. Value range: 100–200. When set to 120, overload protection is triggered if the current active request count of an upstream node exceeds 120% of the average active request count. When overload protection is triggered, even if the request hash matches a specific upstream node, the load balancer will randomly select an upstream node
hashKey String: Consistent hash method. Options: UseSourceIp: based on source IP address. HttpQueryParameterName: based on parameter. HttpHeaderName: based on header. HTTPCookie: based on cookie
httpCookie Property Map: Cookie。
httpHeaderName String: Parameter. Supports printable ASCII characters, length: 1–256 characters
httpQueryParameterName String: Parameter. Supports printable ASCII characters, length: 1–256 characters
useSourceIp String: Source IP address

UpstreamLoadBalancerSettingsConsistentHashLbHttpCookie, UpstreamLoadBalancerSettingsConsistentHashLbHttpCookieArgs

Name string: Name. Supports printable ASCII characters. Length: 0~256 characters
Path string: Path. Supports printable ASCII characters. Length: 1~256 characters
Ttl int: Validity period, in seconds

Name string: Name. Supports printable ASCII characters. Length: 0~256 characters
Path string: Path. Supports printable ASCII characters. Length: 1~256 characters
Ttl int: Validity period, in seconds

name String: Name. Supports printable ASCII characters. Length: 0~256 characters
path String: Path. Supports printable ASCII characters. Length: 1~256 characters
ttl Integer: Validity period, in seconds

name string: Name. Supports printable ASCII characters. Length: 0~256 characters
path string: Path. Supports printable ASCII characters. Length: 1~256 characters
ttl number: Validity period, in seconds

name str: Name. Supports printable ASCII characters. Length: 0~256 characters
path str: Path. Supports printable ASCII characters. Length: 1~256 characters
ttl int: Validity period, in seconds

name String: Name. Supports printable ASCII characters. Length: 0~256 characters
path String: Path. Supports printable ASCII characters. Length: 1~256 characters
ttl Number: Validity period, in seconds

UpstreamTlsSettings, UpstreamTlsSettingsArgs

Sni string: SNI. If left blank, the domain name accessed by the gateway will be passed through to the upstream
TlsMode string: TLS mode. Options: DISABLE: disable TLS. SIMPLE: one-way TLS

Sni string: SNI. If left blank, the domain name accessed by the gateway will be passed through to the upstream
TlsMode string: TLS mode. Options: DISABLE: disable TLS. SIMPLE: one-way TLS

sni String: SNI. If left blank, the domain name accessed by the gateway will be passed through to the upstream
tlsMode String: TLS mode. Options: DISABLE: disable TLS. SIMPLE: one-way TLS

sni string: SNI. If left blank, the domain name accessed by the gateway will be passed through to the upstream
tlsMode string: TLS mode. Options: DISABLE: disable TLS. SIMPLE: one-way TLS

sni str: SNI. If left blank, the domain name accessed by the gateway will be passed through to the upstream
tls_mode str: TLS mode. Options: DISABLE: disable TLS. SIMPLE: one-way TLS

sni String: SNI. If left blank, the domain name accessed by the gateway will be passed through to the upstream
tlsMode String: TLS mode. Options: DISABLE: disable TLS. SIMPLE: one-way TLS

UpstreamUpstreamSpec, UpstreamUpstreamSpecArgs

AiProvider Volcengine.UpstreamUpstreamSpecAiProvider: AI model proxy
Domain Volcengine.UpstreamUpstreamSpecDomain: Fixed domain name
EcsInstances List<Volcengine.UpstreamUpstreamSpecEcsInstance>
K8SService Volcengine.UpstreamUpstreamSpecK8SService: Container Service
NacosService Volcengine.UpstreamUpstreamSpecNacosService: Registry Center
VeFaas Volcengine.UpstreamUpstreamSpecVeFaas: Function service

AiProvider UpstreamUpstreamSpecAiProvider: AI model proxy
Domain UpstreamUpstreamSpecDomain: Fixed domain name
EcsInstances []UpstreamUpstreamSpecEcsInstance
K8SService UpstreamUpstreamSpecK8SService: Container Service
NacosService UpstreamUpstreamSpecNacosService: Registry Center
VeFaas UpstreamUpstreamSpecVeFaas: Function service

aiProvider UpstreamUpstreamSpecAiProvider: AI model proxy
domain UpstreamUpstreamSpecDomain: Fixed domain name
ecsInstances List<UpstreamUpstreamSpecEcsInstance>
k8SService UpstreamUpstreamSpecK8SService: Container Service
nacosService UpstreamUpstreamSpecNacosService: Registry Center
veFaas UpstreamUpstreamSpecVeFaas: Function service

aiProvider UpstreamUpstreamSpecAiProvider: AI model proxy
domain UpstreamUpstreamSpecDomain: Fixed domain name
ecsInstances UpstreamUpstreamSpecEcsInstance[]
k8SService UpstreamUpstreamSpecK8SService: Container Service
nacosService UpstreamUpstreamSpecNacosService: Registry Center
veFaas UpstreamUpstreamSpecVeFaas: Function service

ai_provider UpstreamUpstreamSpecAiProvider: AI model proxy
domain UpstreamUpstreamSpecDomain: Fixed domain name
ecs_instances Sequence[UpstreamUpstreamSpecEcsInstance]
k8_s_service UpstreamUpstreamSpecK8SService: Container Service
nacos_service UpstreamUpstreamSpecNacosService: Registry Center
ve_faas UpstreamUpstreamSpecVeFaas: Function service

aiProvider Property Map: AI model proxy
domain Property Map: Fixed domain name
ecsInstances List<Property Map>
k8SService Property Map: Container Service
nacosService Property Map: Registry Center
veFaas Property Map: Function service

UpstreamUpstreamSpecAiProvider, UpstreamUpstreamSpecAiProviderArgs

BaseUrl string: Model address
CustomModelService Volcengine.UpstreamUpstreamSpecAiProviderCustomModelService: Volcano Engine self-hosted model service
Name string: Model Service Provider Name
Token string: Model API key

BaseUrl string: Model address
CustomModelService UpstreamUpstreamSpecAiProviderCustomModelService: Volcano Engine self-hosted model service
Name string: Model Service Provider Name
Token string: Model API key

baseUrl String: Model address
customModelService UpstreamUpstreamSpecAiProviderCustomModelService: Volcano Engine self-hosted model service
name String: Model Service Provider Name
token String: Model API key

baseUrl string: Model address
customModelService UpstreamUpstreamSpecAiProviderCustomModelService: Volcano Engine self-hosted model service
name string: Model Service Provider Name
token string: Model API key

base_url str: Model address
custom_model_service UpstreamUpstreamSpecAiProviderCustomModelService: Volcano Engine self-hosted model service
name str: Model Service Provider Name
token str: Model API key

baseUrl String: Model address
customModelService Property Map: Volcano Engine self-hosted model service
name String: Model Service Provider Name
token String: Model API key

UpstreamUpstreamSpecAiProviderCustomModelService, UpstreamUpstreamSpecAiProviderCustomModelServiceArgs

Name string: Model Service Name
Namespace string: Namespace
Port int: Port

Name string: Model Service Name
Namespace string: Namespace
Port int: Port

name String: Model Service Name
namespace String: Namespace
port Integer: Port

name string: Model Service Name
namespace string: Namespace
port number: Port

name str: Model Service Name
namespace str: Namespace
port int: Port

name String: Model Service Name
namespace String: Namespace
port Number: Port

UpstreamUpstreamSpecDomain, UpstreamUpstreamSpecDomainArgs

DomainLists List<Volcengine.UpstreamUpstreamSpecDomainDomainList>

DomainLists []UpstreamUpstreamSpecDomainDomainList

domainLists List<UpstreamUpstreamSpecDomainDomainList>

domainLists UpstreamUpstreamSpecDomainDomainList[]

domain_lists Sequence[UpstreamUpstreamSpecDomainDomainList]

domainLists List<Property Map>

UpstreamUpstreamSpecDomainDomainList, UpstreamUpstreamSpecDomainDomainListArgs

Domain string: Domain name
Port int: Port. Default: 80 for HTTP, 443 for HTTPS

Domain string: Domain name
Port int: Port. Default: 80 for HTTP, 443 for HTTPS

domain String: Domain name
port Integer: Port. Default: 80 for HTTP, 443 for HTTPS

domain string: Domain name
port number: Port. Default: 80 for HTTP, 443 for HTTPS

domain str: Domain name
port int: Port. Default: 80 for HTTP, 443 for HTTPS

domain String: Domain name
port Number: Port. Default: 80 for HTTP, 443 for HTTPS

UpstreamUpstreamSpecEcsInstance, UpstreamUpstreamSpecEcsInstanceArgs

EcsId string: Cloud server ID
Ip string: IP address
Port int: Port

EcsId string: Cloud server ID
Ip string: IP address
Port int: Port

ecsId String: Cloud server ID
ip String: IP address
port Integer: Port

ecsId string: Cloud server ID
ip string: IP address
port number: Port

ecs_id str: Cloud server ID
ip str: IP address
port int: Port

ecsId String: Cloud server ID
ip String: IP address
port Number: Port

UpstreamUpstreamSpecK8SService, UpstreamUpstreamSpecK8SServiceArgs

Name string: Container Service Name. Length: 2–63 characters
Namespace string: Namespace. Length: 2~63 characters
Port int: Port

Name string: Container Service Name. Length: 2–63 characters
Namespace string: Namespace. Length: 2~63 characters
Port int: Port

name String: Container Service Name. Length: 2–63 characters
namespace String: Namespace. Length: 2~63 characters
port Integer: Port

name string: Container Service Name. Length: 2–63 characters
namespace string: Namespace. Length: 2~63 characters
port number: Port

name str: Container Service Name. Length: 2–63 characters
namespace str: Namespace. Length: 2~63 characters
port int: Port

name String: Container Service Name. Length: 2–63 characters
namespace String: Namespace. Length: 2~63 characters
port Number: Port

UpstreamUpstreamSpecNacosService, UpstreamUpstreamSpecNacosServiceArgs

Group string: Group
Namespace string: Namespace
NamespaceId string: Namespace ID
Service string: Service
UpstreamSourceId string: Upstream source ID

Group string: Group
Namespace string: Namespace
NamespaceId string: Namespace ID
Service string: Service
UpstreamSourceId string: Upstream source ID

group String: Group
namespace String: Namespace
namespaceId String: Namespace ID
service String: Service
upstreamSourceId String: Upstream source ID

group string: Group
namespace string: Namespace
namespaceId string: Namespace ID
service string: Service
upstreamSourceId string: Upstream source ID

group str: Group
namespace str: Namespace
namespace_id str: Namespace ID
service str: Service
upstream_source_id str: Upstream source ID

group String: Group
namespace String: Namespace
namespaceId String: Namespace ID
service String: Service
upstreamSourceId String: Upstream source ID

UpstreamUpstreamSpecVeFaas, UpstreamUpstreamSpecVeFaasArgs

FunctionId string: Function ID

FunctionId string: Function ID

functionId String: Function ID

functionId string: Function ID

function_id str: Function ID

functionId String: Function ID

UpstreamVersionDetail, UpstreamVersionDetailArgs

Labels List<Volcengine.UpstreamVersionDetailLabel>
Name string: Version name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length: 2~63 characters. Cannot start with a hyphen (-)
UpdateTime string: Update time

Labels []UpstreamVersionDetailLabel
Name string: Version name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length: 2~63 characters. Cannot start with a hyphen (-)
UpdateTime string: Update time

labels List<UpstreamVersionDetailLabel>
name String: Version name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length: 2~63 characters. Cannot start with a hyphen (-)
updateTime String: Update time

labels UpstreamVersionDetailLabel[]
name string: Version name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length: 2~63 characters. Cannot start with a hyphen (-)
updateTime string: Update time

labels Sequence[UpstreamVersionDetailLabel]
name str: Version name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length: 2~63 characters. Cannot start with a hyphen (-)
update_time str: Update time

labels List<Property Map>
name String: Version name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length: 2~63 characters. Cannot start with a hyphen (-)
updateTime String: Update time

UpstreamVersionDetailLabel, UpstreamVersionDetailLabelArgs

Key string: Key
Value string: Value

Key string: Key
Value string: Value

key String: Key
value String: Value

key string: Key
value string: Value

key str: Key
value str: Value

key String: Key
value String: Value

Import

$ pulumi import volcenginecc:apig/upstream:Upstream example "upstream_id"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

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

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.apig.Upstream

On this page

On this page

Example Usage

Create Upstream Resource

Constructor syntax

Parameters

Upstream Resource Properties

Inputs

Outputs

Look up Existing Upstream Resource

Supporting Types

UpstreamBackendTarget, UpstreamBackendTargetArgs

UpstreamCircuitBreakingSettings, UpstreamCircuitBreakingSettingsArgs

UpstreamConnectionPoolSettings, UpstreamConnectionPoolSettingsArgs

UpstreamLoadBalancerSettings, UpstreamLoadBalancerSettingsArgs

UpstreamLoadBalancerSettingsConsistentHashLb, UpstreamLoadBalancerSettingsConsistentHashLbArgs

UpstreamLoadBalancerSettingsConsistentHashLbHttpCookie, UpstreamLoadBalancerSettingsConsistentHashLbHttpCookieArgs

UpstreamTlsSettings, UpstreamTlsSettingsArgs

UpstreamUpstreamSpec, UpstreamUpstreamSpecArgs

UpstreamUpstreamSpecAiProvider, UpstreamUpstreamSpecAiProviderArgs

UpstreamUpstreamSpecAiProviderCustomModelService, UpstreamUpstreamSpecAiProviderCustomModelServiceArgs

UpstreamUpstreamSpecDomain, UpstreamUpstreamSpecDomainArgs

UpstreamUpstreamSpecDomainDomainList, UpstreamUpstreamSpecDomainDomainListArgs

UpstreamUpstreamSpecEcsInstance, UpstreamUpstreamSpecEcsInstanceArgs

UpstreamUpstreamSpecK8SService, UpstreamUpstreamSpecK8SServiceArgs

UpstreamUpstreamSpecNacosService, UpstreamUpstreamSpecNacosServiceArgs

UpstreamUpstreamSpecVeFaas, UpstreamUpstreamSpecVeFaasArgs

UpstreamVersionDetail, UpstreamVersionDetailArgs

UpstreamVersionDetailLabel, UpstreamVersionDetailLabelArgs

Import

Package Details

On this page

On this page