获取网关参数配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
mse:GetGatewayConfig | get | *Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
GatewayUniqueId | string | 是 | 网关唯一 ID | gw-61f465fa2dd044069e2208c4912***** |
AcceptLanguage | string | 否 | 返回结果显示的语言。取值:zh(默认值):中文,en:英文 | zh |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "F6092602-C357-4750-89D9-E572FBEA****",
"Success": true,
"Code": 200,
"ErrorCode": "Success",
"HttpStatusCode": 200,
"Message": "OK",
"DynamicCode": "code",
"DynamicMessage": "The specified parameter is invalid.",
"Data": {
"GatewayUniqueId": "gw-61f465fa2dd044069e2208c4912*****",
"EnableGenerateRequestId": true,
"EnableGzip": false,
"EnableSlashMerge": true,
"DownstreamIdleTime": 180,
"PreserveHeaderFormat": true,
"DownstreamConnectionBufferLimits": 32768,
"EnableHardwareAccelerate": true,
"XffTrustedNum": 0,
"EnableHttp2": false,
"DownstreamHttp2MaxConcurrentStream": 100,
"InitialStreamWindowSize": 65535,
"InitialConnectionWindowSize": 1048576,
"XtraceDetails": {
"TraceOn": true,
"Id": 255,
"Sample": 100,
"GatewayId": 500,
"GatewayUniqueId": "gw-61f465fa2dd044069e2208c4912*****",
"GmtCreate": "2024-08-12T09:39:07.000+0000",
"GmtModified": "2024-08-12T09:39:07.000+0000",
"TraceType": "OPENTELEMETRY",
"ServiceId": 333,
"ServicePort": "8888"
},
"SlsConfigDetails": {
"LogOn": true,
"Id": 0,
"ProjectName": "test",
"LogStoreName": "mse_gw_access_log",
"GatewayUniqueId": "gw-61f465fa2dd044069e2208c4912*****\n",
"GatewayId": 500,
"GmtCreate": "\"\"",
"GmtModified": " \"\"",
"NginxCompatible": false
},
"SupportWaf": true,
"EnableWaf": true,
"AccessLogHeader": "{\"requestMetadata\":[],\"responseHeaders\":[],\"requestHeaders\":[\"x-test\"],\"responseMetadata\":[]}",
"EnableHttp3": false,
"UpstreamIdleTimeout": 30,
"ZipAlgorithm": "[\"gzip\"]",
"PathWithEscapedSlashes": "KEEP_UNCHANGED",
"NoSupportedConfigList": "\"EnableProxyProtocol,EnableCustomAuthConfigPush\"",
"LogFilterConfig": " \"\"",
"EnableProxyProtocol": true,
"EnableCustomAuthConfigPush": "false",
"KeepaliveHeaderTimeout": 0,
"WebsocketTermGracePeriod": 30
}
}
错误码
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 |
访问错误中心查看更多错误码。