通过网关实例 ID 和 Upstream 配置信息检查 Upstream 后端服务是否存在。

请求说明

API 网关已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://apig.cn-beijing.volcengineapi.com?Action=CheckUpstreamSpecExist&Version=2021-03-03

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：CheckUpstreamSpecExist

要执行的操作，取值：CheckUpstreamSpecExist。

Version string 必选示例值：2021-03-03

API的版本，取值：2021-03-03。

GatewayId string 必选示例值：gd8****

网关实例 ID。您可以通过 ListGateways 查询网关实例 ID。

UpstreamSpec object 必选示例值：-

Upstream 配置。

VeFaas object 可选示例值：-

函数服务。

FunctionId string 必选示例值：35v****

函数 ID。您可以通过 ListFunctions 查询函数 ID。

K8SService object 可选示例值：-

容器服务。

Namespace string 必选示例值：default

Kubernetes Service 所在的命名空间。

Name string 必选示例值：example

Kubernetes Service 名称。

Port integer 必选示例值：80

Kubernetes Service 开放的端口。

EcsList object[] 可选示例值：-

云服务器。

EcsId string 必选示例值：i-3tig******

云服务器 ID。您可以通过 DescribeInstances 查询云服务器 ID。

IP string 必选示例值：10.0.0.1

云服务器 IP 地址。

Port integer 必选示例值：80

为 ECS 实例配置访问端口。API 网关只能通过配置的端口访问对应的 ECS。

FixedIPList object[] 可选示例值：-

固定 IP。

IP string 必选示例值：10.0.0.1

后端 IP 地址。

Port integer 必选示例值：80

后端 IP 的端口号。

Domain object 可选示例值：-

固定域名。

Protocol string 可选示例值：HTTP

协议类型（已弃用），取值：

HTTP：HTTP。

HTTPS：HTTPS。

DomainList object[] 必选示例值：-

域名列表。长度限制为 1 个。

Domain string 必选示例值：example.com

对接后端的固定域名地址。

Port integer 可选示例值：80

对接后端域名的端口号。

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

协议类型为 HTTPS 时，默认值为 443。

AIProvider object 可选示例值：-

AI 模型代理。

Name string 必选示例值：OpenAI

模型服务商名称。

Token string 可选示例值：ark-6bb****

模型 API key。详情请参见创建 API Key。

BaseUrl string 必选示例值：https://api.openai.com/v1

模型地址。

CustomModelService object 可选示例值：-

火山引擎自部署模型服务。

Namespace string 必选示例值：default

命名空间。长度限制为 2~63 个字符。

Name string 必选示例值：example

服务名称。长度限制为 2~63 个字符。

Port integer 必选示例值：80

端口。

CustomHeaderParams object 可选示例值：{"example-key":"example-value"}

请求头。

如果请求头已存在，将覆写已存在的请求头。

长度限制为 0~10 个。

CustomBodyParams object 可选示例值：{"example-key":"example-value"}

请求体字段。

仅支持 JSON 请求体的第 1 层字段。

如果请求体字段已存在，将覆写已存在的请求体字段。

长度限制为 0~10 个。

NacosService object 可选示例值：-

注册中心。

UpstreamSourceId string 必选示例值：ncn24\*\*\*\*

MSE Nacos 实例 ID。

Namespace string 必选示例值：default

MSE 已有的命名空间名称。

Group string 必选示例值：default

MSE 已有的配置分组。

Service string 必选示例值：example

MSE 已有的服务名称。

NamespaceId string 可选示例值：b04b9767-70****

MSE 已有的命名空间 ID。

ResourceType string 可选示例值：Console

资源类型，取值：

Console（默认值）：从控制台创建。

Ingress：同步自 Ingress。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Exist boolean 示例值：true

Upstream 是否存在。取值：

true：存在。

false：不存在。

Id string 示例值：ud8t****

Upstream ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.	请求参数值不合法。请确认参数后重试。
500	InternalError	The request has failed due to an unknown error.	未知错误。请稍后重试。如果多次尝试失败，请提交工单。