创建 Upstream 来源。

请求说明

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

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateUpstreamSource	接口名称。当前 API 的名称为 CreateUpstreamSource。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 2021-03-03。
GatewayId	String	是	gd8****	网关实例 ID。您可以通过 ListGateways 查询网关实例 ID。
SourceType	String	是	K8S	Upstream 来源类型，取值： K8S：容器集群。 Nacos：注册中心。
Comments	String	否	example	Upstream 来源备注信息。字符串形式，长度限制为 0~253 个字符。不填默认为空。
SourceSpec	Object of SourceSpec	是	-	Upstream 来源配置。
IngressSettings	Object of IngressSettings	否	-	路由同步。说明当SourceType取值为K8S时，需要配置本参数。
WatchNamespaces	Array of String	否	["default"]	指定命名空间。说明当SourceType取值为K8S时，需要配置本参数。

SourceSpec

参数	类型	是否必选	示例值	描述
K8SSource	Object of K8SSource	否	-	容器集群来源。
NacosSource	Object of NacosSource	否	-	注册中心来源。

IngressSettings

参数	类型	是否必选	示例值	描述
EnableIngress	Boolean	否	true	是否开启路由同步。取值： true：开启。 false：不开启。说明开启后，API 网关会自动监听 Ingress 资源的变化，并将 Ingress 资源转义为服务，域名和 Upstream 等资源合并至当前网关。由 Ingress 转义的资源不支持在控制台操作。
EnableAllIngressClasses	Boolean	否	false	是否设置为全部 IngressClass。取值： true：是。 false：否。
IngressClasses	Array of String	否	["example"]	指定 IngressClass。单个名称支持输入 2~63 个字符。字符中只能包含大小写字母、数字、和中划线（-）。不能以中划线（-）开头。说明当IngressSettings.EnableAllIngressClasses取值为false时，需要配置本参数。
EnableIngressWithoutIngressClass	Boolean	否	false	是否开启监听 IngressClass 为空的资源。取值： true：开启。 false：不开启。说明当IngressSettings.EnableAllIngressClasses取值为false时，需要配置本参数。
EnableAllNamespaces	Boolean	否	false	是否设置为全部命名空间。取值： true：是。 false：否。
WatchNamespaces	Array of String	否	["default"]	指定命名空间。说明当IngressSettings.EnableAllNamespaces取值为false时，需要配置本参数。
UpdateStatus	Boolean	否	false	是否开启流量入口切换。取值： true：开启。 false：不开启。说明当IngressSettings.EnableAllNamespaces取值为false时，需要配置本参数。开启后，当前集群 Ingress 中 Status 的 IP 地址会被修改为当前网关的 IP 地址。

K8SSource

参数	类型	是否必选	示例值	描述
ClusterId	String	是	cc9q8p****	集群 ID。您可以通过 ListClusters 查询集群 ID。
ClusterType	String	否	vke	集群类型，取值：vke，代表容器服务集群

NacosSource

参数	类型	是否必选	示例值	描述
NacosId	String	否	ncn24****	Nacos 实例 ID。
AuthConfig	Object of AuthConfig	否	-	认证配置。
NacosName	String	否	example	Nacos 名称。

AuthConfig

参数	类型	是否必选	示例值	描述
Basic	Object of Basic	否	-	Nacos 登录认证。

Basic

参数	类型	是否必选	示例值	描述
Username	String	是	username	Nacos 登录用户名。
Password	String	是	password	Nacos 登录密码。

请求示例

返回参数

参数	类型	示例值	描述
Id	String	ust7****	Upstream 来源 ID。

返回示例

错误码

本接口无特有的错误码。更多信息请参见公共错误码。