Retrieve SAE Ingress Rules via ListIngresses API - Serverless App Engine - Alibaba Cloud - Serverless App Engine

Retrieves a list of Ingresses.

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	The current page number.
PageSize	integer	No	The page size.

Response elements

Element	Type	Description	Example
	object	The data that is returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The response message. success is returned if the call is successful. An error code is returned if the call fails.	success
TraceId	string	The trace ID. You can use it to query the details of a call.	0a98a02315955564772843261e****
Data	object	The result.
CurrentPage	integer	The current page.
TotalSize	integer	The total number of entries found.
PageSize	integer	The number of entries per page.
IngressList	array<object>	The list of routing rules.
	array<object>	The information about the routing rule.
SlbId	string	The ID of the Server Load Balancer (SLB) instance.	lb-uf62****6d13tq2u5
NamespaceId	string	The namespace ID.	cn-shanghai
Description	string	The name of the Ingress rule.	test
ListenerPort	string	The listening port of the SLB instance.	80
SlbType	string	The type of the SLB instance. Valid values: internet: public network. intranet: private network.	internet
CertId	string	The ID of the Classic Load Balancer (CLB) certificate.	13624***73809_16f8e549a20_1175189789_12**3210
CertIds	string	The IDs of the Application Load Balancer (ALB) certificates.	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 the SLB instance. Valid values: clb: Classic Load Balancer. alb: Application Load Balancer.	clb
ListenerProtocol	string	The forwarding protocol of the SLB instance. 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. If you do not set this parameter when you create or update a gateway routing rule, this parameter is not returned.	HTTP
MseGatewayId	string	The ID of the MSE cloud-native gateway instance.	gw-d5df01a1bae748f1a7c4e325d2fd****
MseGatewayPort	string	The port that corresponds to the service.	80
MseGatewayProtocol	string	The forwarding protocol supported by the MSE cloud-native gateway. Valid values: HTTP: suitable for applications that need to identify data content. HTTPS: suitable for applications that require encrypted transmission.	HTTP
RequestTimeout	integer	The request timeout period.
IdleTimeout	integer	The connection idle timeout period.
CreateTime	integer	The creation time.
DefaultRule	object	The default rule.
ContainerPort	integer	The container port.
AppName	string	The application name.
AppId	string	The application ID.
BackendProtocol	string	The backend protocol.
Rules	array<object>	The rules.
	array<object>
AppName	string	The application name.
ContainerPort	integer	The container port.
Domain	string	The domain name.
AppId	string	The application ID.
Path	string	The path.
BackendProtocol	string	The backend protocol.
RewritePath	string	The rewritten path.
RuleActions	array<object>	The list of rule actions.
	object	The rule action.
ActionType	string	The action type.
ActionConfig	string	The action configuration.
CorsConfig	object	The cross-domain configuration.
Enable	string	Indicates whether cross-domain access is enabled.
ExposeHeaders	string	The allowed exposed headers.
AllowHeaders	string	The allowed headers.
AllowMethods	string	The allowed methods.
AllowOrigin	string	The allowed origins.
AllowCredentials	string	Indicates whether credentials can be carried.
MaxAge	string	The time-to-live (TTL).
ErrorCode	string	The error code. 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 of this topic.
Code	string	The status of the API call or a POP error code. Valid values: 2xx: The call was successful. 3xx: The call was redirected. 4xx: A client error occurred. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	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.