文档

GetGatewayOption - 查询网关选项

更新时间:

获取网关全局参数。

调试

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

授权信息

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

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

请求参数

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

网关 ID。

429
GatewayUniqueIdstring

网关唯一 ID。

gw-c9bc5afd61014165bd58f621b491*****
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

RequestIdstring

请求 ID。

C92F4A4D-A2FD-593E-839E-F3D4DFD2****
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

返回信息。

  • 当请求成功时,返回成功信息。
  • 当请求失败时,返回失败原因,例如:TaskId not found。
请求处理成功
Codeinteger

状态码。说明:200 表示成功。

200
Successboolean

请求结果,取值如下:

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

网关操作详情。

  • 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错误码错误信息描述
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

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

  • 本页导读 (1)
文档反馈