ListIngresses - - Alibaba Cloud Documentation Center

Use ListIngress API call to query Ingress list

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sae:ListIngresses	get	All Resources ``	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	Yes	The returned data.	cn-beijing
AppId	string	No	The list of routing rules.	bbf3a590-6d13-46fe-8ca9-c947a20b****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the SLB instance.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The ID of the namespace.	success
TraceId	string	The name of the routing rule.	0a98a02315955564772843261e****
Data	object	The port specified for the SLB listener.
IngressList	array<object>	The type of the SLB instance based on the IP address. Valid values: internet: the Internet-facing SLB instance. intranet: the internal-facing SLB instance.
Ingress	object
SlbId	string	The ID of the certificate.	lb-uf62****6d13tq2u5
NamespaceId	string	The name of the routing rule.	cn-shanghai
Description	string	The ID of the routing rule.	test
ListenerPort	string	The type of the SLB instance based on the processing capabilities. Valid values: clb: the Classic Load Balancer (CLB) instance. alb: the Application Load Balancer (ALB) instance.	80
SlbType	string	The protocol used to forward requests. Valid values: HTTP: used when the application needs to identify the transmitted data. HTTPS: used when the application requires encrypted data transmission.	internet
CertId	string	The error code. The ErrorCode parameter is not returned when the request succeeds. The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.	13624***73809_16f8e549a20_1175189789_12**3210
Name	string	The HTTP status code. Valid values: 2xx: indicates that the request was successful. 3xx: indicates that the request was redirected. 4xx: indicates that the request was invalid. 5xx: indicates that a server error occurred.	lb-uf6jt0nu4z6ior943**-80-f5**
Id	long	Indicates whether the list of routing rules was obtained. Valid values: true: indicates that the list was obtained. false: indicates that the list could not be obtained.	18

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "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"
      }
    ]
  },
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-25	The Error code has changed. The response structure of the API has changed	View Change Details