EnableProxyProtocol - Enable Proxy Protocol for Cloud Native Gateway - Microservices Engine

Enables the PROXY protocol. If the gateway ingress traffic is connected through NLB, the real IP address of the client cannot be obtained unless this feature is enabled. Enabling this feature does not affect non-PROXY protocol requests.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:EnableProxyProtocol

update

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-c9bc5afd61014165bd58f621b491*****
EnableProxyProtocol	boolean	Yes	Specifies whether to enable the feature of preserving the client source IP address by using the PROXY protocol. Valid values: true: enables the feature of preserving the client source IP address. false (default): disables the feature of preserving the client source IP address.	true
AcceptLanguage	string	No	The language of the returned results. Valid values: zh (default): Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object	RestResult<List>
RequestId	string	The request ID.	316F5F64-F73D-42DC-8632-01E308B6****
Success	boolean	The request result. Valid values: `true`: The request is successful. `false`: The request fails.	true
Code	integer	The code used only to synchronize with the success status.	200
ErrorCode	string	The error code.	Success
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The returned message.	OK
DynamicCode	string	The placeholder in the dynamic error message.	code
DynamicMessage	string	The dynamic error message, which is used to replace %s in the error message of the ErrMessage response parameter. Note If ErrMessage returns The Value of Input Parameter %s is not valid and DynamicMessage returns DtsJobId, it indicates that the passed request parameter DtsJobId is invalid.	The specified parameter is invalid.
Data	boolean	Indicates whether the operation is successful.	true

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.