调用GetGatewayOption查询网关选项_微服务引擎(MSE)-阿里云帮助中心

获取网关全局参数。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
mse:GetGatewayOption	get	*Gateway `acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}`	无	无

请求参数

名称	类型	必填	描述	示例值
GatewayId	long	否	网关 ID。	429
GatewayUniqueId	string	是	网关唯一 ID。	gw-c9bc5afd61014165bd58f621b491*****
AcceptLanguage	string	否	返回信息的语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	数据结构。
RequestId	string	请求 ID。	C92F4A4D-A2FD-593E-839E-F3D4DFD2****
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	返回信息。当请求成功时，返回成功信息。当请求失败时，返回失败原因，例如：TaskId not found。	请求处理成功
Code	integer	状态码。说明：200 表示成功。	200
Success	boolean	请求结果，取值如下： `true`：请求成功。 `false`：请求失败。	true
Data	GatewayOption	网关操作详情。 TraceDetails：XTrace 采样描述。内容：TraceEnabled 为是否开通 XTrace，Sample 为 XTrace 的采样率。 LogConfigDetails：日志投递服务描述。内容：LogEnabled 为是否开启日志投递 SLS 服务，ProjectName 为日志投递的目的，LogStoreName 为日志存储名称。 EnableHardwareAcceleration：是否开启硬件加速。 DisableHttp2Alpn：是否关闭 HTTP 2.0 协议。 EnableWaf：是否开启 waf。	{'LogConfigDetails': {'LogEnabled': False}, 'TraceDetails': {'TraceEnabled': False}}

示例

正常返回示例

JSON格式

{
  "RequestId": "C92F4A4D-A2FD-593E-839E-F3D4DFD2****",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "Code": 200,
  "Success": true,
  "Data": {
    "TraceDetails": {
      "TraceEnabled": true,
      "Sample": 10,
      "TraceType": "XTRACE",
      "ServiceId": 10458,
      "ServicePort": "80"
    },
    "LogConfigDetails": {
      "LogEnabled": true,
      "ProjectName": "project",
      "LogStoreName": "name"
    },
    "EnableHardwareAcceleration": true,
    "DisableHttp2Alpn": true,
    "EnableWaf": true
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s

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