查询 Upstream 配置详情。 ## 请求说明 API 网关已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 [服务地址](https://docs.volcengine.com/docs/6569/2603628?lang=zh&TagIDs=2%2C286) 文档，根据业务所在地域，选择最合适的接入点。 * 请求方式：POST * 请求地址：https://apig.cn\-beijing.volcengineapi.com?Action=GetUpstream&Version=2021\-03\-03 ## 调试 [去调试](https://api.volcengine.com/api-explorer/debug?action=GetUpstream&serviceCode=apig&version=2021-03-03&groupName=) ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |GetUpstream |接口名称。当前 API 的名称为 `GetUpstream`。 | |Version |String |是 |2021\-03\-03 |接口版本。当前 API 的版本为 `2021-03-03`。 | |Id |String |是 |ud8t\*\*\*\* |Upstream ID。您可以通过 [ListUpstreams](https://www.volcengine.com/docs/6569/1628108?lang=zh) 查询 Upstream ID。 | ## 请求示例 ```json POST https://apig.cn-beijing.volcengineapi.com?Action=GetUpstream&Version=2021-03-03 Content-Type: application/json { "Id": "ud8t****" } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Upstream |Object of [UpstreamResponse](https://docs.volcengine.com/docs/6569/1628107#upstreamresponse) |\- |Upstream 配置。 | ### UpstreamResponse |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Id |String |ud8t\*\*\*\* |Upstream ID。 | |Name |String |example |Upstream 名称。 | |GatewayId |String |gd8\*\*\*\* |网关实例 ID。 | |Comments |String |example |Upstream 的备注信息。 | |SourceType |String |VeFaas |Upstream 来源类型，取值：

* **VeFaas**：函数服务。

* **ECS**：云服务器。

* **K8S**：容器服务。

* **Nacos**：注册中心。

* **Domain**：固定域名。

* **FixedIP**：固定 IP。

* **AIProvider**：AI 模型代理。 | |UpstreamSpec |Object of [UpstreamSpec](https://docs.volcengine.com/docs/6569/1628107#upstreamspec) |\- |Upstream 配置。 | |LoadBalancerSettings |Object of [LoadBalancerSettings](https://docs.volcengine.com/docs/6569/1628107#loadbalancersettings) |\- |负载均衡配置。 | |CircuitBreakingSettings |Object of [CircuitBreakingSettings](https://docs.volcengine.com/docs/6569/1628107#circuitbreakingsettings) |\- |服务熔断配置。 | |ConnectionPoolSettings |Object of [ConnectionPoolSettings](https://docs.volcengine.com/docs/6569/1628107#connectionpoolsettings) |\- |连接池配置。 | |VersionDetails |Array of [UpstreamVersion](https://docs.volcengine.com/docs/6569/1628107#upstreamversion) |\- |Upstream 版本。仅当 Upstream 来源类型为容器服务时有效。 | |CreateTime |String |2025\-01\-01T00:00:00+08:00 |Upstream 创建时间。

标准 [RFC3339](https://tools.ietf.org/html/rfc3339) 格式的 UTC+0 时间。 | |UpdateTime |String |2025\-01\-01T00:00:00+08:00 |Upstream 配置更新时间。

标准 [RFC3339](https://tools.ietf.org/html/rfc3339) 格式的 UTC+0 时间。 | |Protocol |String |HTTP |协议，取值：

* **HTTP**

* **HTTP2**

* **GRPC** | |TlsSettings |Object of [TlsSettings](https://docs.volcengine.com/docs/6569/1628107#tlssettings) |\- |TLS 配置。 | ### UpstreamSpec |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |VeFaas |Object of [VeFaas](https://docs.volcengine.com/docs/6569/1628107#vefaas) |\- |函数服务。

说明

当SourceType取值为VeFaas时有返回值。

说明

当SourceType取值为K8S时有返回值。

说明

当SourceType取值为ECS时有返回值。

说明

当SourceType取值为FixedIP时有返回值。

说明

当SourceType取值为Domain时有返回值。

说明

当SourceType取值为Nacos时有返回值。

说明

当SourceType取值为AIProvider时有返回值。

| ### LoadBalancerSettings |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |LbPolicy |String |SimpleLB |负载均衡策略，取值：

* **SimpleLB**：简单负载均衡。

* **ConsistentHashLB**：一致性哈希负载均衡。 | |SimpleLB |String |ROUND_ROBIN |简单负载均衡，取值：

* **ROUND_ROBIN**：轮询。

* **LEAST_CONN**：最小连接数。

* **RANDOM**：随机。 | |ConsistentHashLB |Object of [ConsistentHashLB](https://docs.volcengine.com/docs/6569/1628107#consistenthashlb) |\- |一致性哈希负载均衡。

说明

当LoadBalancerSettings.LbPolicy取值为ConsistentHashLB时有返回值。

说明

当LoadBalancerSettings.SimpleLB取值为ROUND_ROBIN和LEAST_CONN时有返回值。

| ### CircuitBreakingSettings |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Enable |Boolean |true |是否开启服务熔断。取值：

* **true**：开启。

* **false**：不开启。 | |ConsecutiveErrors |Long |5 |连续失败次数。 | |Interval |Long |10000 |计算周期，单位为毫秒。 | |BaseEjectionTime |Long |30000 |最小弹出时间，单位为毫秒。 | |MaxEjectionPercent |Integer |20 |最大熔断比例。 | |MinHealthPercent |Integer |60 |最小可用比例。 | ### ConnectionPoolSettings |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Enable |Boolean |true |是否开启后端连接池。取值：

* **true**：开启。

* **false**：不开启。 | |MaxConnections |Integer |1000 |TCP 最大连接数。 | |Http1MaxPendingRequests |Integer |1000 |HTTP/1 最大等待请求数。 | |IdleTimeout |Integer |1000 |空闲超时时间，单位为秒。 | ### UpstreamVersion |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Name |String |example |Upstream 版本名称。 | |Labels |Array of [Label](https://docs.volcengine.com/docs/6569/1628107#label) |\- |当前版本在后端类型对应的标签。 | |UpdateTime |String |2025\-01\-01T00:00:00+08:00 |Upstream 版本更新时间。

标准 [RFC3339](https://tools.ietf.org/html/rfc3339) 格式的 UTC+0 时间。 | ### TlsSettings |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |TlsMode |String |DISABLE |TLS 模式，取值：

* **DISABLE**：关闭 TLS。

* **SIMPLE**：单向 TLS。 | |Sni |String |example.com |服务器名称指示用于描述请求的目标域名。取值为空时会将访问网关的域名透传到 Upstream。 | ### VeFaas |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |FunctionId |String |35v\*\*\*\* |函数 ID。您可以通过 [ListFunctions](https://www.volcengine.com/docs/6662/1288709?lang=zh) 查询函数 ID。 | ### K8SService |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Namespace |String |default |Kubernetes Service 所在的命名空间。 | |Name |String |example |Kubernetes Service 名称。 | |Port |Integer |80 |Kubernetes Service 开放的端口。 | ### Ecs |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |EcsId |String |i\-3tig\*\*\*\*\*\* |云服务器 ID。您可以通过 [DescribeInstances](https://www.volcengine.com/docs/6396/70466?lang=zh) 查询云服务器 ID。 | |IP |String |10.0.0.1 |云服务器 IP 地址。 | |Port |Integer |80 |为 ECS 实例配置访问端口。API 网关只能通过配置的端口访问对应的 ECS。 | ### FixedIP |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |IP |String |10.0.0.1 |后端 IP 地址。 | |Port |Integer |80 |后端 IP 的端口号。 | ### Domain |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |DomainList |Array of [DomainEndpoint](https://docs.volcengine.com/docs/6569/1628107#domainendpoint) |\- |域名列表。 | ### NacosService |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |UpstreamSourceId |String |ncn24\*\*\*\* |MSE Nacos 实例 ID。 | |Namespace |String |default |MSE 已有的命名空间名称。 | |Group |String |default |MSE 已有的配置分组。 | |Service |String |example |MSE 已有的服务名称。 | |NamespaceId |String |b04b9767\-70\*\*\*\* |MSE 已有的命名空间 ID。 | ### AIProvider |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Name |String |OpenAI |模型服务商名称。 | |Token |String |ark\-6bb\*\*\*\* |模型 API key。 | |BaseUrl |String |https://api.openai.com/v1 |模型地址。 | |CustomModelService |Object of [K8SService](https://docs.volcengine.com/docs/6569/1628107#k8sservice) |\- |火山引擎自部署模型服务。 | |CustomHeaderParams |JSON Map |{"example\-key":"example\-value"} |请求头。 | |CustomBodyParams |JSON Map |{"example\-key":"example\-value"} |请求体字段。 | ### ConsistentHashLB |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |HashKey |String |UseSourceIp |一致性哈希方式，取值：

* **UseSourceIp**：基于源 IP 地址。

* **HttpQueryParameterName**：基于参数。

* **HttpHeaderName**：基于头。

* **HTTPCookie**：基于 Cookie。 | |UseSourceIp |String |10.0.0.1 |源 IP 地址。

说明

当ConsistentHashLB.HashKey取值为UseSourceIp时有返回值。

说明

当ConsistentHashLB.HashKey取值为HttpQueryParameterName时有返回值。

说明

当ConsistentHashLB.HashKey取值为HttpHeaderName时有返回值。

说明

当ConsistentHashLB.HashKey取值为HTTPCookie时有返回值。

| |HashBalanceFactor |Integer |120 |过载保护。 | ### Label |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Key |String |example\-key |标签键。 | |Value |String |example\-value |标签值。 | ### DomainEndpoint |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Domain |String |example.com |对接后端的固定域名地址。 | |Port |Integer |80 |对接后端域名的端口号。

* 协议类型为 HTTP 时，默认值为 80。

* 协议类型为 HTTPS 时，默认值为 443。 | ### CustomHeaderParams |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |key |String |example\-key |请求头的键。 | |value |String |example\-value |请求头的值。 | ### CustomBodyParams |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |key |String |example\-key |请求体的键。 | |value |String |example\-value |请求体的值。 | ### HTTPCookie |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Name |String |example |Cookie 名称。 | |Path |String |/ |Cookie 路径。 | |Ttl |Long |360 |Cookie 有效期，单位为秒。 | ## 返回示例 ```json Content-Type: application/json { "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetUpstream", "Version": "2021-03-03", "Service": "apig", "Region": "cn-beijing" }, "Result": { "Upstream": { "Id": "ud8t****", "Name": "example", "Comments": "example", "Protocol": "HTTP", "GatewayId": "gd8****", "CreateTime": "2025-01-01T00:00:00+08:00", "SourceType": "VeFaas", "UpdateTime": "2025-01-01T00:00:00+08:00", "TlsSettings": { "Sni": "example.com", "TlsMode": "DISABLE" }, "UpstreamSpec": { "Domain": { "DomainList": [ { "Port": 80, "Domain": "example.com" } ] }, "VeFaas": { "FunctionId": "35v****" }, "EcsList": [ { "IP": "10.0.0.1", "Port": 80, "EcsId": "i-3tig******" } ], "AIProvider": { "Name": "OpenAI", "Token": "ark-6bb****", "BaseUrl": "https://api.openai.com/v1", "CustomBodyParams": { "example-key": "example-value" }, "CustomHeaderParams": { "example-key": "example-value" }, "CustomModelService": { "Name": "example", "Port": 80, "Namespace": "default" } }, "K8SService": { "Name": "example", "Port": 80, "Namespace": "default" }, "FixedIPList": [ { "IP": "10.0.0.1", "Port": 80 } ], "NacosService": { "Group": "default", "Service": "example", "Namespace": "default", "NamespaceId": "b04b9767-70****", "UpstreamSourceId": "ncn24****" } }, "VersionDetails": [ { "Name": "example", "Labels": [ { "Key": "example-key", "Value": "example-value" } ], "UpdateTime": "2025-01-01T00:00:00+08:00" } ], "LoadBalancerSettings": { "LbPolicy": "SimpleLB", "SimpleLB": "ROUND_ROBIN", "WarmupDuration": 5, "ConsistentHashLB": { "HashKey": "UseSourceIp", "HTTPCookie": { "Ttl": 360, "Name": "example", "Path": "/" }, "UseSourceIp": "10.0.0.1", "HttpHeaderName": "example", "HashBalanceFactor": 120, "HttpQueryParameterName": "example" } }, "ConnectionPoolSettings": { "Enable": true, "IdleTimeout": 1000, "MaxConnections": 1000, "Http1MaxPendingRequests": 1000 }, "CircuitBreakingSettings": { "Enable": true, "Interval": 10000, "BaseEjectionTime": 30000, "MinHealthPercent": 60, "ConsecutiveErrors": 5, "MaxEjectionPercent": 20 } } } } ``` ## 错误码本接口无特有的错误码。更多信息请参见 [公共错误码](https://www.volcengine.com/docs/6569/1337089)。