DescribeIngress API Reference for Ingress Routing Rules - Serverless App Engine - Alibaba Cloud - Serverless App Engine

Queries the details of an Ingress.

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:DescribeIngress

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
IngressId	integer	Yes	The ID of the routing rule. Call the ListIngresses operation to obtain this ID.	16263

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. If the request is successful, success is returned. If the request fails, a specific error code is returned.	success
TraceId	string	The trace ID used to query the details of a call.	0a981dd515966966104121683d****
Data	object	The returned data.
SlbId	string	The ID of the Server Load Balancer (SLB) instance.	lb-uf62****6d13tq2u5
NamespaceId	string	The namespace ID.	cn-beijing:sae-test
Description	string	The description of the Ingress.	ingress-sae-test
ListenerPort	integer	The listener port of the SLB instance.	443
SlbType	string	The type of the SLB instance. Valid values: internet: An internet-facing instance. intranet: An internal-facing instance.	internet
CertId	string	The ID of the Classic Load Balancer (CLB) certificate.	13623****809_16cad216b32_845_-419427029
Name	string	The name of the Ingress.	lb-uf6jt0nu4z6ior943**-80-f5**
DefaultRule	object	The default rule.
ContainerPort	integer	The backend port for the default rule.	8080
AppName	string	The name of the application for the default rule.	app1
AppId	string	The ID of the application for the default rule.	395b60e4-0550-458d-9c54-a265d036****
BackendProtocol	string	The backend protocol. Valid values: http: Suitable for applications that need to identify data content. https: Suitable for applications that require encrypted transmission. grpc: Suitable for load balancing gRPC services developed in multiple languages, such as .NET. This parameter is valid only when the `LoadBalanceType` parameter is set to `alb` and the `ListenerProtocol` parameter is set to `HTTPS`.	http
Rules	array<object>	The forwarding rules.
	array<object>	A forwarding rule.
AppName	string	The name of the destination application.	app1
ContainerPort	integer	The backend port of the application.	8080
Domain	string	The domain name of the application.	edas.site
AppId	string	The ID of the destination application.	395b60e4-0550-458d-9c54-a265d036****
Path	string	The URL path.	/path1
BackendProtocol	string	The backend protocol. Valid values: http: Suitable for applications that need to identify data content. https: Suitable for applications that require encrypted transmission. grpc: Suitable for load balancing gRPC services developed in multiple languages, such as .NET. This parameter is valid only when the `LoadBalanceType` parameter is set to `alb` and the `ListenerProtocol` parameter is set to `HTTPS`.	http
RewritePath	string	The rewritten path.	/${1}
RuleActions	array<object>	The actions of the forwarding rule.
	object	An action of the rule.
ActionType	string	The type of the action. Valid values: rewrite: a rewrite policy redirect: a redirection policy	rewrite
ActionConfig	string	The configuration of the action.	{\"host\":\"www.example.com\",\"path\":\"/example/text\",\"query\":\"x=1\"}
Id	integer	The ID of the Ingress.	87
LoadBalanceType	string	The type of the Server Load Balancer (SLB) instance. Valid values: clb: Classic Load Balancer (CLB), formerly known as SLB. alb: Application Load Balancer (ALB).	clb
ListenerProtocol	string	The request forwarding protocol. Valid values: HTTP: Suitable for applications that need to identify data content. HTTPS: Suitable for applications that require encrypted transmission. This parameter is optional for the `CreateIngress` and `UpdateIngress` operations. It is not returned if it was not specified when the Ingress was created or updated.	HTTP
CertIds	string	The comma-separated IDs of the Application Load Balancer (ALB) certificates.	87*35-cn-hangzhou,812*3-cn-hangzhou
SecurityPolicyId	string	The ID of the security policy instance.	sp-n0kn923****
RequestTimeout	integer	The request timeout, in seconds. Valid values: 1 to 180. Default value: 60. If a backend server does not respond within the specified timeout period, the load balancer terminates the request and returns an HTTP 504 error to the client.	60
IdleTimeout	integer	The connection idle timeout, in seconds. Valid values: 1 to 60. Default value: 15. If no request is received within the timeout period, the load balancer closes the connection. A new connection is established when the next request is received.	3
EnableXForwardedFor	boolean	Specifies whether to use the `X-Forwarded-For` header to retrieve client IP addresses.	true
EnableXForwardedForClientSrcPort	boolean	Specifies whether to use a header to retrieve the source port of the client.	true
EnableXForwardedForProto	boolean	Specifies whether to use the `X-Forwarded-Proto` header to retrieve the listener protocol of the SLB instance.	true
EnableXForwardedForSlbId	boolean	Specifies whether to use the `SLB-ID` header to retrieve the ID of the SLB instance.	true
EnableXForwardedForSlbPort	boolean	Specifies whether to use the `X-Forwarded-Port` header to retrieve the listener port of the SLB instance.	true
CreatedBySae	boolean	Indicates whether the Application Load Balancer (ALB) instance was provisioned by SAE.	true
CorsConfig	object	The configurations for Cross-Origin Resource Sharing (CORS). Valid HTTP methods: GET POST PUT DELETE HEAD OPTIONS PATCH
Enable	string	Specifies whether to enable CORS.	false
ExposeHeaders	string	The headers that are exposed to clients.	test_123
AllowHeaders	string	The headers that are allowed in cross-origin requests.	test_123
AllowMethods	string	The HTTP methods that are allowed for cross-origin requests.	GET
AllowOrigin	string	The origins that are allowed to access the resource. You can specify a single asterisk (``) or one or more specific origins. A specific origin must start with `http://` or `https://` and be a valid domain name or a first-level wildcard domain name. Example: `http://.test.abc.example.com`. You can optionally specify a port. The valid port range is 1 to 65535.	*
AllowCredentials	string	Specifies whether to allow credentials in cross-origin requests. Valid values: on: yes off: no	on
MaxAge	string	The maximum cache duration of preflight requests in the browser, in seconds. Valid values: -1 to 172800.	1000
EnableGzip	boolean	Specifies whether to enable Gzip compression.
ErrorCode	string	The error code. This parameter is returned only if the request fails. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code returned for the request. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: A client error occurred. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request succeeded. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a981dd515966966104121683d****",
  "Data": {
    "SlbId": "lb-uf62****6d13tq2u5",
    "NamespaceId": "cn-beijing:sae-test",
    "Description": "ingress-sae-test",
    "ListenerPort": 443,
    "SlbType": "internet",
    "CertId": "13623****809_16cad216b32_845_-419427029",
    "Name": "lb-uf6jt0nu4z6ior943****-80-f5****",
    "DefaultRule": {
      "ContainerPort": 8080,
      "AppName": "app1",
      "AppId": "395b60e4-0550-458d-9c54-a265d036****",
      "BackendProtocol": "http"
    },
    "Rules": [
      {
        "AppName": "app1",
        "ContainerPort": 8080,
        "Domain": "edas.site",
        "AppId": "395b60e4-0550-458d-9c54-a265d036****",
        "Path": "/path1",
        "BackendProtocol": "http",
        "RewritePath": "/${1}",
        "RuleActions": [
          {
            "ActionType": "rewrite",
            "ActionConfig": "{\\\"host\\\":\\\"www.example.com\\\",\\\"path\\\":\\\"/example/text\\\",\\\"query\\\":\\\"x=1\\\"}"
          }
        ]
      }
    ],
    "Id": 87,
    "LoadBalanceType": "clb",
    "ListenerProtocol": "HTTP",
    "CertIds": "87***35-cn-hangzhou,812***3-cn-hangzhou",
    "SecurityPolicyId": "sp-n0kn923****",
    "RequestTimeout": 60,
    "IdleTimeout": 3,
    "EnableXForwardedFor": true,
    "EnableXForwardedForClientSrcPort": true,
    "EnableXForwardedForProto": true,
    "EnableXForwardedForSlbId": true,
    "EnableXForwardedForSlbPort": true,
    "CreatedBySae": true,
    "CorsConfig": {
      "Enable": "false",
      "ExposeHeaders": "test_123",
      "AllowHeaders": "test_123",
      "AllowMethods": "GET",
      "AllowOrigin": "*",
      "AllowCredentials": "on",
      "MaxAge": "1000"
    },
    "EnableGzip": false
  },
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.