UpdateGatewayOption - 更新网关参数

调用UpdateGatewayOption接口更新网关参数。

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
GatewayId long

网关ID。

421
GatewayOption GatewayOption

网关操作详情。

  • TraceDetails:XTrace采样描述。内容:TraceEnabled为是否开通XTrace,Sample为XTrace的采样率。

  • LogConfigDetails:日志投递服务描述。内容:LogEnabled为是否开启日志投递SLS服务,ProjectName为日志投递的目的,LogStoreName为日志存储名称。

  • EnableHardwareAcceleration:是否开启硬件加速。

  • DisableHttp2Alpn:是否关闭HTTP 2.0协议。

  • EnableWaf:是否开启waf。

GatewayUniqueId string

网关唯一标识ID。

gw-83b0ddb569434f82b9fe8e4c60c4****
AcceptLanguage string

返回信息的语言类型:

  • zh:中文

  • en:英文

zh

返回参数

名称 类型 描述 示例值
object

数据结构。

RequestId string

请求ID。

124D02EB-DBDD-534D-A701-B4A95D3D****
HttpStatusCode integer

HTTP状态码。

200
Message string

返回信息。

  • 当请求成功时,返回成功信息。
  • 当请求失败时,返回失败原因。
请求处理成功
Code integer

返回值。

200
Success boolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Data GatewayOption

返回数据。

{'LogConfigDetails': {'LogEnabled': True}, 'TraceDetails': {'Sample': 17, 'TraceEnabled': True}}

示例

正常返回示例

JSON格式

{
  "RequestId": "124D02EB-DBDD-534D-A701-B4A95D3D****",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "Code": 200,
  "Success": true,
  "Data": {
    "TraceDetails": {
      "TraceEnabled": true,
      "Sample": 10
    },
    "LogConfigDetails": {
      "LogEnabled": true,
      "ProjectName": "project",
      "LogStoreName": "name"
    },
    "EnableHardwareAcceleration": true,
    "DisableHttp2Alpn": true,
    "EnableWaf": true
  }
}

错误码

Http code 错误码 错误信息 描述
400 duplicatedClusterAliasName duplicated cluster alias name 实例名称已重复,请换一个
400 illegalRequest illegal request:%s 非法请求:%s
400 invalidParameter parameter error:%s 请求入参异常:%s
403 NoPermission You are not authorized to perform this operation. 没有权限使用此接口
404 clusterNotFound cluster not found 找不到此集群
500 systemError system error 系统开小差了,请稍后重试
500 regcenterError register center error:%s 注册配置中心请求错误:%s

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

阿里云首页 微服务引擎 相关技术圈