開啟Proxy協議。如果網關入口流量使用NLB接入,如果不開啟則無法獲取客戶端的真實IP,開啟后對于非Proxy協議請求沒有影響。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
mse:EnableProxyProtocol | update | *Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
GatewayUniqueId | string | 是 | 網關唯一 ID | gw-c9bc5afd61014165bd58f621b491***** |
EnableProxyProtocol | boolean | 是 | 是否使用 ProxyProtocol 方式開啟保持客戶端源 IP 功能,取值:
| true |
AcceptLanguage | string | 否 | 返回結果顯示的語言。取值:zh(默認值):中文,en:英文 | zh |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
"Success": true,
"Code": 200,
"ErrorCode": "Success",
"HttpStatusCode": 200,
"Message": "OK",
"DynamicCode": "code",
"DynamicMessage": "The specified parameter is invalid.",
"Data": 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 |
訪問錯誤中心查看更多錯誤碼。