You need to enable JavaScript to run this app.
文档中心
API 网关

API 网关

复制全文
下载 pdf
路由管理
UpdateGatewayService - 更新服务
复制全文
下载 pdf
UpdateGatewayService - 更新服务
更新服务配置信息。​
请求说明​
API 网关已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地域,选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apig.cn-beijing.volcengineapi.com?Action=UpdateGatewayService&Version=2021-03-03​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
UpdateGatewayService​
接口名称。当前 API 的名称为 UpdateGatewayService。​
Version​
String​
是​
2021-03-03​
接口版本。当前 API 的版本为 2021-03-03。​
Id​
String​
是​
sd84****​
服务 ID。​
Protocol​
Array of String​
是​
["HTTP","HTTPS"]​
协议类型,取值:​
  • HTTP。​
  • HTTPS。​
AuthSpec​
Object of AuthSpec​
否​
-​
认证配置。建议使用插件中心中的认证鉴权插件进行服务认证。​
Comments​
String​
否​
example​
服务的备注信息。字符串形式,长度限制为 0~253 个字符。​
DomainSpec​
Object of DomainSpec​
否​
-​
域名详情。​
ServiceNetworkSpec​
Object of ServiceNetworkSpec​
否​
-​
服务默认域名网络配置。​
​
AuthSpec​
​
参数​
类型​
是否必选​
示例值​
描述​
Enable​
Boolean​
是​
true​
是否开启认证配置。取值:​
  • true:开启。​
  • false:不开启。​
​
DomainSpec​
​
参数​
类型​
是否必选​
示例值​
描述​
EnablePublicResolution​
Boolean​
否​
true​
是否开启私网域名公网解析。取值:​
  • true:开启。​
  • false:不开启。​
​
ServiceNetworkSpec​
​
参数​
类型​
是否必选​
示例值​
描述​
EnablePublicNetwork​
Boolean​
否​
true​
是否开启公网。取值:​
  • true:开启。​
  • false:不开启。​
EnablePrivateNetwork​
Boolean​
否​
true​
是否开启私网。取值:​
  • true:开启。​
  • false:不开启。​
PrivateNetworkIP​
Array of String​
否​
["10.0.0.1"]​
私网域名解析的目标 IP。​
说明​
当ServiceNetworkSpec.EnablePrivateNetwork取值为 true 时,需要配置本参数。​
PublicNetworkIP​
Array of String​
否​
["1.1.1.1"]​
公网域名解析的目标 IP。​
说明​
当ServiceNetworkSpec.EnablePublicNetwork取值为 true 时,需要配置本参数。​
​
请求示例​
​
POST https://apig.cn-beijing.volcengineapi.com?Action=UpdateGatewayService&Version=2021-03-03​
Content-Type: application/json​
{​
"Id": "sd84****",​
"Protocol": [​
"HTTP",​
"HTTPS"​
],​
"AuthSpec": {​
"Enable": true​
},​
"Comments": "example",​
"DomainSpec": {​
"EnablePublicResolution": true​
},​
"ServiceNetworkSpec": {​
"PublicNetworkIP": [​
"1.1.1.1"​
],​
"PrivateNetworkIP": [​
"10.0.0.1"​
],​
"EnablePublicNetwork": true,​
"EnablePrivateNetwork": true​
}​
}​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Id​
String​
sd84****​
服务 ID。​
​
返回示例​
​
Content-Type: application/json​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "UpdateGatewayService",​
"Version": "2021-03-03",​
"Service": "apig",​
"Region": "cn-beijing"​
},​
"Result": {​
"Id": "sd84****"​
}​
}​
​
错误码​
本接口无特有的错误码。更多信息请参见 公共错误码。​
最近更新时间:2026.07.29 10:20:02
这个页面对您有帮助吗?
有用
有用
无用
无用