更新服务配置信息。

请求说明

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

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：UpdateGatewayService

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

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

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

Id string 必选示例值：sd84****

服务 ID。

Protocol string[] 必选示例值：["HTTP","HTTPS"]

协议类型，取值：

HTTP。

HTTPS。

AuthSpec object 可选示例值：-

认证配置。建议使用插件中心中的认证鉴权插件进行服务认证。

Enable boolean 必选示例值：true

是否开启认证配置。取值：

true：开启。

false：不开启。

Comments string 可选示例值：example

服务的备注信息。字符串形式，长度限制为 0~253 个字符。

DomainSpec object 可选示例值：-

域名详情。

EnablePublicResolution boolean 可选示例值：true

是否开启私网域名公网解析。取值：

true：开启。

false：不开启。

ServiceNetworkSpec object 可选示例值：-

服务默认域名网络配置。

EnablePublicNetwork boolean 可选示例值：true

是否开启公网。取值：

true：开启。

false：不开启。

EnablePrivateNetwork boolean 可选示例值：true

是否开启私网。取值：

true：开启。

false：不开启。

PrivateNetworkIP string[] 可选示例值：["10.0.0.1"]

私网域名解析的目标 IP。

说明

当ServiceNetworkSpec.EnablePrivateNetwork取值为 true 时，需要配置本参数。

PublicNetworkIP string[] 可选示例值：["1.1.1.1"]

公网域名解析的目标 IP。

说明

当ServiceNetworkSpec.EnablePublicNetwork取值为 true 时，需要配置本参数。

返回参数

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

Id string 示例值：sd84****

服务 ID。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.	请求参数值不合法。请确认参数后重试。
400	MissingParameter	The required parameter %s is missing.	缺少必要的请求参数。请确认参数后重试。
403	OperationDenied	Operation is denied because %s.	操作不合法。请修改后重试。
404	ResourceNotFound	The specified resource %s %s cannot be found.	指定资源找不到。请确认参数后重试。
500	InternalError	The request has failed due to an unknown error.	未知错误。请稍后重试。如果多次尝试失败，请提交工单。