全部产品
Search
文档中心

微服务引擎MSE:UpdateGatewayService - 编辑网关服务

更新时间:Dec 23, 2024

编辑网关服务(仅适用于 固定地址服务 / DNS域名服务)

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:UpdateGatewayServiceupdate
*Gateway
acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

请求参数

名称类型必填描述示例值
Idstring

服务 ID。

322
GatewayIdlong

网关 ID。

501
Namestring

服务名称(已废弃,不支持修改,调用时需要和当前服务名称保持一致)。

test
IpListarray

服务地址列表(固定地址服务)/ 域名列表(DNS 域名服务)

string

服务地址(固定地址服务)/ 域名(DNS 域名服务)

192.168.1.1:80
ServicePortstring

服务端口(DNS 域名服务填写)。

80
ServiceProtocolstring

服务协议。

  • HTTP

  • HTTPS

  • HTTP2

  • GRPC

  • DUBBO

HTTP
GatewayUniqueIdstring

网关唯一标识 ID。

gw-c9bc5afd61014165bd58f621b491*****
TlsSettingstring

TLS 设定。

  • TLS 模式:mode

  • 证书 ID:certId

  • CA 证书 ID:caCertId

  • CA 证书公钥:caCertContent

  • 服务名称标识:sni

{ "mode": "MUTUAL", "certId": "1*****-cn-hangzhou", "caCertContent": "123", "sni": "ceshi" }
DnsServerListarray

DNS 服务器列表(仅供 DNS 域名服务使用)

string

DNS 服务器地址(IP+端口)

1.1.1.1:80
AcceptLanguagestring

返回结果显示的语言。取值:zh(默认值):中文,en:英文

zh

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

AF21683A-29C7-4853-AC0F-B5ADEE4****
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

返回信息。

OK
Codeinteger

响应码。

200
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Datalong

服务 ID。

322

示例

正常返回示例

JSON格式

{
  "RequestId": "AF21683A-29C7-4853-AC0F-B5ADEE4****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": 322
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-12-03OpenAPI 入参发生变更查看变更详情