Queries ingresses.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see the topic about common request parameters.

Request syntax

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

Request parameters

Parameter Type Position Required Example Description
ClusterId String Query Yes 5b2b4ab4-efbc-4a81-9c45-xxxxxxxxxxxxx

The ID of the Kubernetes cluster.

RegionId String Query Yes cn-hangzhou

The ID of the region where the cluster resides.

Namespace String Query No default

The Kubernetes namespace of the cluster.

Condition Json Query No {"field":"Name", "pattern":"my-"}

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":"secret-"} indicates that the specified filter conditions match the routing rules whose names start with secret-.

Response parameters

Parameter Type Example Description
Code Integer 200

The HTTP status code.

Data Array of Data N/A

The returned data.

ClusterId String 5b2b4ab4-efbc-4a81-9c45-a5942881****

The ID of the Kubernetes cluster.

ClusterName String my-dev-cluster

The name of the Kubernetes cluster.

IngressConfs Array of IngressConfs N/A

The list of ingresses.

CreationTime String 2021-04-27 20:16:52

The time when the ingress was created.

DashboardUrl String http://grafana.console.aliyun.com/d/10xxxx/ingress

The monitoring URL of the ingress.

Endpoint String 47.11x.xx.xx

The IP address of the ingress.

Name String my-ingress

The name of the ingress.

Namespace String default

The Kubernetes namespace to which the ingress belongs.

Rules Array of Rules N/A

The list of routing rules.

Host String abc.com

The domain name to be accessed.

Paths Array of Paths N/A

The list of paths to be accessed.

AppId String 43d30ba5-c568-460c-8080-d447ed1a****

The ID of the Enterprise Distributed Application Service (EDAS) application.

AppName String my-app

The name of the EDAS application.

Backend Struct N/A

The configuration of the backend service.

ServiceName String http-service

The name of the backend service.

ServicePort String 8080

The port of the backend service.

Path String /foo/bar

The path to be accessed.

Status String Normal

The status of the ingress. Valid values:

  • Normal: The ingress works properly.
  • 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 has occurred.
SecretName String my-secret

The name of the secret that stores the information about the Transport Layer Security (TLS) certificate.

RegionId String cn-hangzhou

The ID of the region where the cluster resides.

Message String success

The returned message.

RequestId String 5C1C9DE7-88FF-4B56-A47B-3DBBCEB23256

The ID of the request.

Examples

Sample requests

GET /pop/v5/k8s/acs/k8s_ingress HTTP/1.1
Common request headers
{
"ClusterId": "5b2b4ab4-efbc-4a81-9c45-xxxxxxxxxxxxx",
"RegionId": "cn-hangzhou"
}

Sample success responses

XML format

<RequestId>5C1C9DE7-88FF-4B56-A47B-3DBBCEB23256</RequestId>
<Message>success</Message>
<Data>
    <ClusterId>5b2b4ab4-efbc-4a81-9c45-a5942881a4c2</ClusterId>
    <ClusterName>my-dev-cluster</ClusterName>
    <RegionId>cn-hangzhou</RegionId>
    <IngressConfs>
        <Endpoint>47.11x.xx.xx</Endpoint>
        <CreationTime>2021-04-27 20:16:52</CreationTime>
        <Namespace>default</Namespace>
        <DashboardUrl>http://grafana.console.aliyun.com/d/10xxxx/ingress</DashboardUrl>
        <Name>my-ingress</Name>
        <Rules>
            <SecretName>my-secret</SecretName>
            <Host>abc.com</Host>
            <Paths>
                <Status>Normal</Status>
                <Path>/foo/bar</Path>
                <AppId>43d30ba5-c568-460c-8080-d447ed1ab3f4</AppId>
                <AppName>my-app</AppName>
                <Backend>
                    <ServicePort/>
                    <ServiceName/>
                </Backend>
            </Paths>
        </Rules>
    </IngressConfs>
</Data>
<Code>200</Code>

JSON format

{
    "RequestId": "5C1C9DE7-88FF-4B56-A47B-3DBBCEB23256",
    "Message": "success",
    "Data": {
        "ClusterId": "5b2b4ab4-efbc-4a81-9c45-a5942881a4c2",
        "ClusterName": "my-dev-cluster",
        "RegionId": "cn-hangzhou",
        "IngressConfs": {
            "Endpoint": "47.11x.xx.xx",
            "CreationTime": "2021-04-27 20:16:52",
            "Namespace": "default",
            "DashboardUrl": "http://grafana.console.aliyun.com/d/10xxxx/ingress",
            "Name": "my-ingress",
            "Rules": {
                "SecretName": "my-secret",
                "Host": "abc.com",
                "Paths": {
                    "Status": "Normal",
                    "Path": "/foo/bar",
                    "AppId": "43d30ba5-c568-460c-8080-d447ed1ab3f4",
                    "AppName": "my-app",
                    "Backend": {
                        "ServicePort": "",
                        "ServiceName": ""
                    }
                }
            }
        }
    },
    "Code": 200
}

Error codes

HTTP status code Error code Error message Description
500 Edas.errorcode.PermissionDenied.message You are not authorized to perform the operation. The error message returned because you are not authorized to perform the operation.

For a list of error codes, visit the API Error Center.