All Products
Search
Document Center

Enterprise Distributed Application Service:ListK8sIngressRules

Last Updated:Sep 08, 2025

Queries ingresses.

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
edas:ReadClusterget
*All Resources
*
    none
none

Request syntax

GET /pop/v5/k8s/acs/k8s_ingress HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the cluster resides.

cn-hangzhou
ClusterIdstringNo

The cluster ID.

5b2b4ab4-efbc-4a81-9c45-xxxxxxxxxxxxx
NamespacestringNo

The namespace of the Kubernetes cluster.

default
ConditionstringNo

The filter conditions. Set the value to a JSON string in the format of {"field":"Name", "pattern":"my-"}, where:

  • field: the parameter to be matched. Valid values: Name and ClusterName.
  • pattern: the content to be matched.

For example, a value of {"field":"Name", "pattern":"my-"} indicates that the specified filter conditions match the routing rules whose names start with my-.

{"field":"Name", "pattern":"my-"}

Response parameters

ParameterTypeDescriptionExample
object

The response object.

Codeinteger

The HTTP status code that is returned.

200
Messagestring

The message that is returned.

success
RequestIdstring

The ID of the request.

5C1C9DE7-88FF-4B56-A47B-3DBBCEB******
Dataarray<object>

The response data.

Dataobject

The object of the data that is returned.

ClusterNamestring

The cluster name.

my-dev-cluster
ClusterIdstring

The cluster ID.

5b2b4ab4-efbc-4a81-9c45-a5942881****
RegionIdstring

The ID of the Alibaba Cloud region.

cn-hangzhou
IngressConfsarray<object>

The Ingresses.

IngressConfsobject

The information about Ingresses.

CreationTimestring

The time when the Ingress was created.

2021-04-27 20:16:52
SslRedirectboolean

Indicates whether SSL redirection is enabled. Valid values:

  • true
  • false
true
Endpointstring

The IP address of the Ingress.

47.11x.xx.xx
Namespacestring

The Kubernetes namespace to which the Ingress belongs.

default
Namestring

The Ingress name.

my-ingress
DashboardUrlstring

The monitoring URL of the Ingress.

http://grafana.console.aliyun.com/d/10xxxx/ingress
Rulesarray<object>

The routing rules.

Rulesobject

The object of the routing rules.

SecretNamestring

The name of the Secret that stores the Transport Layer Security (TLS) certificate.

my-secret
Hoststring

The domain name to be accessed.

example.com
Pathsarray<object>

The paths to be accessed.

Pathsobject

The object of paths to be accessed.

Statusstring

The state of the Ingress. Valid values:

  • Normal: The Ingress works as expected.
  • ServiceNotFound: The backend Service does not exist.
  • InvalidServicePort: The Service port is invalid.
  • NotManagedService: The Service is not managed by EDAS.
  • Unknown: An unknown error occurred.
Normal
Pathstring

The path to be accessed.

/foo/bar
AppNamestring

The name of the EDAS application.

my-app
AppIdstring

The ID of the EDAS application.

43d30ba5-c568-460c-8080-d447ed1a****
Backendobject

The configurations of the backend Service.

ServiceNamestring

The name of the backend Service.

http-service
ServicePortstring

The port of the backend Service.

8080
CollectRateinteger

The collection rate that is set based on the trace query feature. You can add a trace ID to a gateway to use the trace query feature of EDAS.

100
PathTypestring

The path type that determines how a path is matched.

  • ImplementationSpecific (default)
  • Exact
  • Prefix
ImplementationSpecific
EnableTlsboolean

Indicates whether TLS is enabled. Valid values:

  • true
  • false
false
AlbIdstring

The ID of the ALB instance.

alb-5sde0tq62r********
IngressTypestring

The Ingress type. Valid values:

  • NginxIngress: NGINX Ingress controller
  • AlbIngress: ALB Ingress controller

Default value: NginxIngress.

NginxIngress
OfficalBasicUrlstring

The URL used for basic monitoring of the open source version.

https://gnew.console.alibabacloud.com/d/xxxxxx/nginx-ingress-dashboard-official
OfficalRequestUrlstring

The URL used for request performance monitoring of the open source version.

https://gnew.console.alibabacloud.com/d/xxxxxx/request-handling-performance-official
MseGatewayIdstring

The ID of the MSE gateway.

gw-xxxxxxxx
MseGatewayNamestring

The name of the MSE gateway.

gw-test-name
Annotationsstring

The annotations.

{"test-annotation":"test-annotation-value"}
Labelsstring

The tags.

{"test-label": "test-labels"}

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "RequestId": "5C1C9DE7-88FF-4B56-A47B-3DBBCEB******",
  "Data": [
    {
      "ClusterName": "my-dev-cluster",
      "ClusterId": "5b2b4ab4-efbc-4a81-9c45-a5942881****",
      "RegionId": "cn-hangzhou",
      "IngressConfs": [
        {
          "CreationTime": "2021-04-27 20:16:52",
          "SslRedirect": true,
          "Endpoint": "47.11x.xx.xx",
          "Namespace": "default",
          "Name": "my-ingress",
          "DashboardUrl": "http://grafana.console.aliyun.com/d/10xxxx/ingress",
          "Rules": [
            {
              "SecretName": "my-secret",
              "Host": "example.com",
              "Paths": [
                {
                  "Status": "Normal",
                  "Path": "/foo/bar",
                  "AppName": "my-app",
                  "AppId": "43d30ba5-c568-460c-8080-d447ed1a****",
                  "Backend": {
                    "ServiceName": "http-service",
                    "ServicePort": 8080
                  },
                  "CollectRate": 100,
                  "PathType": "ImplementationSpecific"
                }
              ],
              "EnableTls": false
            }
          ],
          "AlbId": "alb-5sde0tq62r********",
          "IngressType": "NginxIngress",
          "OfficalBasicUrl": "https://gnew.console.alibabacloud.com/d/xxxxxx/nginx-ingress-dashboard-official",
          "OfficalRequestUrl": "https://gnew.console.alibabacloud.com/d/xxxxxx/request-handling-performance-official",
          "MseGatewayId": "gw-xxxxxxxx",
          "MseGatewayName": "gw-test-name",
          "Annotations": {
            "test-annotation": "test-annotation-value"
          },
          "Labels": {
            "test-label": "test-labels"
          }
        }
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
500Edas.errorcode.PermissionDenied.messageYou are not authorized to perform the operation.No permissions

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

Change history

Change timeSummary of changesOperation
2023-05-17The Error code has changed. The response structure of the API has changedView Change Details