DescribeIngress - Serverless App Engine - Alibaba Cloud Documentation Center

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 to query. Call the ListIngresses operation to obtain the routing rule ID.	16263

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	An informational message. The following values are returned: success is returned if the request is successful. An error code is returned if the request fails.	success
TraceId	string	The trace ID that is used to query the details of the call.	0a981dd515966966104121683d****
Data	object	The returned result.
SlbId	string	The ID of the SLB instance.	lb-uf62****6d13tq2u5
NamespaceId	string	The namespace ID.	cn-beijing:sae-test
Description	string	The name of the routing rule.	ingress-sae-test
ListenerPort	integer	The listening port of the SLB instance.	443
SlbType	string	The type of the SLB instance. Valid values: internet: an Internet-facing SLB instance. intranet: an internal-facing SLB instance.	internet
CertId	string	The ID of the CLB certificate.	13623****809_16cad216b32_845_-419427029
Name	string	The name of the routing rule.	lb-uf6jt0nu4z6ior943**-80-f5**
DefaultRule	object	The default rule.
ContainerPort	integer	The backend port that is used by the default rule.	8080
AppName	string	The name of the application that is used by the default rule.	app1
AppId	string	The ID of the application that is used by the default rule.	395b60e4-0550-458d-9c54-a265d036****
BackendProtocol	string	The backend protocol. Valid values: http: This protocol is suitable for applications that need to identify data content. https: This protocol is suitable for applications that require encrypted data transmission. grpc: This protocol is suitable for load balancing gRPC services in multiple languages, such as .NET. This parameter is returned only when LoadBalanceType is set to ALB and ListenerProtocol 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: This protocol is suitable for applications that need to identify data content. https: This protocol is suitable for applications that require encrypted data transmission. grpc: This protocol is suitable for load balancing gRPC services in multiple languages, such as .NET. This parameter is returned only when LoadBalanceType is set to ALB and ListenerProtocol is set to HTTPS.	http
RewritePath	string	The rewritten path.	/${1}
RuleActions	array<object>	The list of forwarding rule actions.
	object	The list of rule actions.
ActionType	string	The type of the forwarding action. rewrite: a rewrite policy redirect: a redirection policy	rewrite
ActionConfig	string	The specific configuration of the forwarding action.	{\"host\":\"www.example.com\",\"path\":\"/example/text\",\"query\":\"x=1\"}
Id	integer	The ID of the routing rule.	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 protocol used to forward requests. Valid values: HTTP: This protocol is suitable for applications that need to identify data content. HTTPS: This protocol is suitable for applications that require encrypted data transmission. This parameter is optional in the CreateIngress and UpadateIngress operations. If you do not specify this parameter when you create or update a gateway routing rule, this parameter is not returned when you call this operation.	HTTP
CertIds	string	The IDs of multiple 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 period. Unit: seconds. Valid values: 1 to 180. Default value: 60. If a backend server does not respond within the timeout period, Server Load Balancer stops waiting and returns an HTTP 504 error to the client.	60
IdleTimeout	integer	The idle timeout period of a connection. Unit: seconds. Valid values: 1 to 60. Default value: 15. If no request is received within the timeout period, Server Load Balancer temporarily closes the connection. The connection is re-established when the next request is received.	3
EnableXForwardedFor	boolean	Indicates whether the `X-Forwarded-For` header is used to retrieve the IP address of the client.	true
EnableXForwardedForClientSrcPort	boolean	Specifies whether to retrieve the listening port of the SLB instance from the X-Forwarded-Port header field.	true
EnableXForwardedForProto	boolean	Indicates whether the `X-Forwarded-Proto` header is used to retrieve the listening protocol of the SLB instance.	true
EnableXForwardedForSlbId	boolean	Indicates whether the `SLB-ID` header is used to retrieve the ID of the SLB instance.	true
EnableXForwardedForSlbPort	boolean	Indicates whether the `X-Forwarded-Port` header is used to retrieve the listening port of the SLB instance.	true
CreatedBySae	boolean	Indicates whether the ALB instance is purchased by SAE.	true
CorsConfig	object	The allowed HTTP methods for cross-domain access are: GET POST PUT DELETE HEAD OPTIONS PATCH
Enable	string	Specifies whether cross-domain support is enabled.	false
ExposeHeaders	string	The list of headers to expose.	test_123
AllowHeaders	string	The list of headers that are allowed for cross-domain requests.	test_123
AllowMethods	string	The HTTP methods that are allowed for cross-domain access.	GET
AllowOrigin	string	The list of allowed origins. You can specify only one element ``, or one or more values. A value must start with `http://` or `https://` and be followed by a valid domain name or a first-level wildcard domain name. Example: `http://.test.abc.example.com`. You can specify a port or not. The port number must be within the range of 1 to 65535.	*
AllowCredentials	string	Indicates whether credentials can be carried. Valid values: on: yes. off: no.	on
MaxAge	string	The maximum cache duration of preflight requests in the browser. Unit: seconds. Valid values: -1 to 172800.	1000
EnableGzip	boolean
ErrorCode	string	The error code. The following rules apply: This parameter is not returned if the request is successful. This parameter is returned if the request fails. For more information, see the Error codes section in this topic.	空
Code	string	The HTTP status code or the POP error code. Valid values: 2xx: The request is successful. 3xx: The request is redirected. 4xx: The request is invalid. 5xx: A server error occurs.	200
Success	boolean	Indicates whether the details of the Ingress are queried. Valid values: true: The details are queried. false: The query fails.	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.