Retrieve SAE Ingress Rules via ListIngresses API - Serverless App Engine

Call the ListIngresses operation to list Ingress resources.

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

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	Yes	The namespace ID.	cn-beijing
AppId	string	No	The application ID.	bbf3a590-6d13-46fe-8ca9-c947a20b****
CurrentPage	integer	No
PageSize	integer	No

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	Additional information. Valid values: success: The request succeeded. An error code: The request failed.	success
TraceId	string	The trace ID. Use it for term queries on call details.	0a98a02315955564772843261e****
Data	object	The response result.
CurrentPage	integer
TotalSize	integer
PageSize	integer
IngressList	array<object>	The list of routing rules.
	array<object>	Routing rule details.
SlbId	string	The Server Load Balancer (SLB) ID.	lb-uf62****6d13tq2u5
NamespaceId	string	The namespace ID.	cn-shanghai
Description	string	The name of the routing rule.	test
ListenerPort	string	The listening port of the SLB.	80
SlbType	string	The type of SLB. Valid values: internet: public network. intranet: private network.	internet
CertId	string	The certificate ID for Classic Load Balancer (CLB).	13624***73809_16f8e549a20_1175189789_12**3210
CertIds	string	The multi-certificate IDs for Application Load Balancer (ALB).	87*35-cn-hangzhou,812*3-cn-hangzhou
Name	string	The name of the routing rule.	lb-uf6jt0nu4z6ior943**-80-f5**
Id	integer	The ID of the routing rule.	18
LoadBalanceType	string	The type of Server Load Balancer (SLB). Valid values: clb: Classic Load Balancer (CLB), formerly SLB. alb: Application Load Balancer (ALB).	clb
ListenerProtocol	string	The forwarding protocol supported by the SLB. Valid values: HTTP: For applications that need to inspect request content. HTTPS: For applications that require encrypted transmission. This parameter is optional in CreateIngress and UpdateIngress. If you omit it when creating or updating a gateway routing rule, the API does not return this field.	HTTP
MseGatewayId	string	The instance ID of the MSE cloud-native gateway.	gw-d5df01a1bae748f1a7c4e325d2fd****
MseGatewayPort	string	The port of the service.	80
MseGatewayProtocol	string	The forwarding protocol supported by the MSE cloud-native gateway. Valid values: HTTP: For applications that need to inspect request content. HTTPS: For applications that require encrypted transmission.	HTTP
RequestTimeout	integer
IdleTimeout	integer
CreateTime	integer
DefaultRule	object
ContainerPort	integer
AppName	string
AppId	string
BackendProtocol	string
Rules	array<object>
	array<object>
AppName	string
ContainerPort	integer
Domain	string
AppId	string
Path	string
BackendProtocol	string
RewritePath	string
RuleActions	array<object>
	object
ActionType	string
ActionConfig	string
CorsConfig	object
Enable	string
ExposeHeaders	string
AllowHeaders	string
AllowMethods	string
AllowOrigin	string
AllowCredentials	string
MaxAge	string
ErrorCode	string	The error code. Valid values: Not returned if the request succeeds. Returned if the request fails. For more information, see the Error codes section in this topic.	空
Code	string	The API status or POP error code. Valid values: 2xx: Success. 3xx: Redirection. 4xx: Client error. 5xx: Server error.	200
Success	boolean	Indicates whether the Ingress list was retrieved successfully. Valid values: true: The list was retrieved successfully. false: The list failed to retrieve.	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 0,
    "TotalSize": 0,
    "PageSize": 0,
    "IngressList": [
      {
        "SlbId": "lb-uf62****6d13tq2u5",
        "NamespaceId": "cn-shanghai",
        "Description": "test",
        "ListenerPort": "80",
        "SlbType": "internet",
        "CertId": "13624*****73809_16f8e549a20_1175189789_12****3210",
        "CertIds": "87***35-cn-hangzhou,812***3-cn-hangzhou",
        "Name": "lb-uf6jt0nu4z6ior943****-80-f5****",
        "Id": 18,
        "LoadBalanceType": "clb",
        "ListenerProtocol": "HTTP",
        "MseGatewayId": "gw-d5df01a1bae748f1a7c4e325d2fd****",
        "MseGatewayPort": "80",
        "MseGatewayProtocol": "HTTP",
        "RequestTimeout": 0,
        "IdleTimeout": 0,
        "CreateTime": 0,
        "DefaultRule": {
          "ContainerPort": 0,
          "AppName": "",
          "AppId": "",
          "BackendProtocol": ""
        },
        "Rules": [
          {
            "AppName": "",
            "ContainerPort": 0,
            "Domain": "",
            "AppId": "",
            "Path": "",
            "BackendProtocol": "",
            "RewritePath": "",
            "RuleActions": [
              {
                "ActionType": "",
                "ActionConfig": ""
              }
            ]
          }
        ],
        "CorsConfig": {
          "Enable": "",
          "ExposeHeaders": "",
          "AllowHeaders": "",
          "AllowMethods": "",
          "AllowOrigin": "",
          "AllowCredentials": "",
          "MaxAge": ""
        }
      }
    ]
  },
  "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.