ListK8sIngressRules - Enterprise Distributed Application Service

Queries ingresses.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /pop/v5/k8s/acs/k8s_ingress

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the cluster resides.	cn-hangzhou
ClusterId	string	No	The cluster ID.	5b2b4ab4-efbc-4a81-9c45-xxxxxxxxxxxxx
Namespace	string	No	The namespace of the Kubernetes cluster.	default
Condition	string	No	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

Parameter	Type	Description	Example
	object	The response object.
Code	integer	The HTTP status code that is returned.	200
Message	string	The message that is returned.	success
RequestId	string	The ID of the request.	5C1C9DE7-88FF-4B56-A47B-3DBBCEB******
Data	object []	The response data.
ClusterName	string	The cluster name.	my-dev-cluster
ClusterId	string	The cluster ID.	5b2b4ab4-efbc-4a81-9c45-a5942881****
RegionId	string	The ID of the Alibaba Cloud region.	cn-hangzhou
IngressConfs	object []	The Ingresses.
CreationTime	string	The time when the Ingress was created.	2021-04-27 20:16:52
SslRedirect	boolean	Indicates whether SSL redirection is enabled. Valid values: true false	true
Endpoint	string	The IP address of the Ingress.	47.11x.xx.xx
Namespace	string	The Kubernetes namespace to which the Ingress belongs.	default
Name	string	The Ingress name.	my-ingress
DashboardUrl	string	The monitoring URL of the Ingress.	http://grafana.console.aliyun.com/d/10xxxx/ingress
Rules	object []	The routing rules.
SecretName	string	The name of the Secret that stores the Transport Layer Security (TLS) certificate.	my-secret
Host	string	The domain name to be accessed.	example.com
Paths	object []	The paths to be accessed.
Status	string	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
Path	string	The path to be accessed.	/foo/bar
AppName	string	The name of the EDAS application.	my-app
AppId	string	The ID of the EDAS application.	43d30ba5-c568-460c-8080-d447ed1a****
Backend	object	The configurations of the backend Service.
ServiceName	string	The name of the backend Service.	http-service
ServicePort	string	The port of the backend Service.	8080
CollectRate	integer	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
PathType	string	The path type that determines how a path is matched. ImplementationSpecific (default) Exact Prefix	ImplementationSpecific
EnableTls	boolean	Indicates whether TLS is enabled. Valid values: true false	false
AlbId	string	The ID of the ALB instance.	alb-5sde0tq62r********
IngressType	string	The Ingress type. Valid values: NginxIngress: NGINX Ingress controller AlbIngress: ALB Ingress controller Default value: NginxIngress.	NginxIngress
OfficalBasicUrl	string	The URL used for basic monitoring of the open source version.	https://g.console.aliyun.com/d/xxxxxx/nginx-ingress-dashboard-official
OfficalRequestUrl	string	The URL used for request performance monitoring of the open source version.	https://g.console.aliyun.com/d/xxxxxx/request-handling-performance-official
MseGatewayId	string	The ID of the MSE gateway.	gw-xxxxxxxx
MseGatewayName	string	The name of the MSE gateway.	gw-test-name
Annotations	string	The annotations.	{"test-annotation":"test-annotation-value"}
Labels	string	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://g.console.aliyun.com/d/xxxxxx/nginx-ingress-dashboard-official",
          "OfficalRequestUrl": "https://g.console.aliyun.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 code	Error code	Error message	Description
500	Edas.errorcode.PermissionDenied.message	You are not authorized to perform the operation.	No permissions

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

Change history

Change time

Summary of changes

Operation

2023-05-17

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.