UpdateIngress - Serverless App Engine - Alibaba Cloud Documentation Center

Update the configuration of an Ingress instance.

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

sae:UpdateIngress

update

*All Resource

*

None

Request syntax

PUT /pop/v1/sam/ingress/Ingress HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
IngressId	integer	Yes	Routing rule ID.	87
CertId	string	No	CLB certificate ID. Details are as follows: If LoadBalanceType is clb, use this field to configure the HTTPS listener certificate. For more information about using SSL certificate IDs with CLB, see Manage Certificates (CLB).	188077086902**_176993d_181437_108724**
CertIds	string	No	ALB multiple certificate IDs. Details are as follows: If LoadBalanceType is alb, use this field to configure multiple HTTPS listener certificates. Separate multiple certificate IDs with commas. Obtain the SSL certificate ID used by ALB from the digital certificate product. For example, configure `756*-cn-hangzhou`, where `756*` is the certificate ID obtained from the product page, and `-cn-hangzhou` is a fixed suffix. For more information, see Manage Certificates (ALB).	87*35-cn-hangzhou,812*3-cn-hangzhou
Description	string	No	Routing rule name.	ingress-sae-test
ListenerPort	string	No	SLB listening port. This port must not be occupied.	443
DefaultRule	string	No	Default forwarding rule. Forward traffic to the specified application by IP address through the specified port. Parameter description: appId: Application ID. containerPort: Application instance port. Note All requests that do not match or satisfy the Rules forwarding rule are forwarded to this specified application.	{"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080}
Rules	string	No	Forwarding rules. Forward traffic to the specified application by domain name and URI of the request through the specified port. Parameter description: appId: Application ID. containerPort: Application instance port. domain: Domain name. path: URI of the request.	[{"appId":"395b60e4-0550-458d-9c54-a265d036**","containerPort":8080,"domain":"www.sae.site","path":"/path1"},{"appId":"666403ce-d25b-47cf-87fe-497565d2**","containerPort":8080,"domain":"sae.site","path":"/path2"}]
LoadBalanceType	string	No	Deprecated parameter. Updates are no longer supported.	clb
ListenerProtocol	string	No	Forwarding Protocol. Details are as follows: HTTP: Applies to applications that need to identify data content. HTTPS: Applies to applications that need encrypted transmission.	HTTP
RequestTimeout	integer	No	Request timeout, in seconds (s).	60
SecurityPolicyId	string	No	Security policy instance ID.	tls_cipher_policy_1_2_strict_with_1_3
IdleTimeout	integer	No	Idle connection timeout, in seconds (s). Note A value of 0 indicates that the default idle timeout is used.	15
EnableXForwardedFor	boolean	No	Enable or disable obtaining the client IP address of the visitor through the X-Forwarded-For header field.	true
EnableXForwardedForClientSrcPort	boolean	No	Obtain the listening port of the SLB instance through the X-Forwarded-Port header field.	true
EnableXForwardedForProto	boolean	No	Specifies whether to determine the listener protocol of the SLB instance from the X-Forwarded-Proto header field.	true
EnableXForwardedForSlbId	boolean	No	Obtain the SLB instance ID through the SLB-ID header field.	true
EnableXForwardedForSlbPort	boolean	No	Whether to obtain the listening port of the Server Load Balancer instance from the X-Forwarded-Port header field.	true
CorsConfig	string	No	Cross-domain configuration.	{\"Enable\":\"true\"}
EnableGzip	boolean	No	Enable or disable data compression.	true

Response elements

Element	Type	Description	Example
	object	Returns data.
RequestId	string	Request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	Additional information. Details are as follows: If the request is normal, success is returned. If the request is abnormal, a specific abnormal error code is returned.	success
TraceId	string	Call chain ID.	0a98a02315955564772843261e****
Data	object	Returned result.
IngressId	integer	Routing rule ID.	87
ErrorCode	string	Error code. Details are as follows: If the request is successful, the ErrorCode field is not returned. If the request failed, the ErrorCode field is returned. For more information, see the Error Codes list in this topic.	空
Code	string	API status or POP error code. Details are as follows: 2xx: Success. 3xx: Redirection. 4xx: Request error. 5xx: Server error.	200
Success	boolean	Indicates whether the Ingress instance configuration was successfully updated. Details are as follows: true: The update was successful. false: The update failed.	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "IngressId": 87
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
400	Exceed.IngressRule	The number of Ingress related rules must be less than or equal to 40.
400	SlbListenerPort.NotAvailable	The SLB listening port is unavailable: slbId [%s], port [%s]
400	SSLCert.NotFound	The specified SSL certificate cannot be found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.