阿里云首页 企业级分布式应用服务 EDAS 相关技术圈

ListK8sIngressRules - 获取应用路由列表

调用ListK8sIngressRules接口获取应用路由列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

阿里云地域ID。

cn-hangzhou
ClusterIdstring

集群ID。

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

K8s集群命名空间。

default
Conditionstring

过滤条件,JSON类型,格式为{"field":"Name", "pattern":"my-"},其中:

  • field:需要匹配的字段,支持Name和ClusterName。

  • pattern:匹配内容。

以{"field":"Name", "pattern":"my-"}这条过滤条件为例,该条过滤规则会匹配名称为“my-”开头的路由规则。

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

返回参数

名称类型描述示例值
object
Codeinteger

接口状态码。

200
Messagestring

返回信息。

success
RequestIdstring

请求ID。

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

接口响应数据。

object
ClusterNamestring

集群名称。

my-dev-cluster
ClusterIdstring

集群ID。

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

阿里云地域ID。

cn-hangzhou
IngressConfsarray

应用路由列表。

object
CreationTimestring

应用路由创建时间。

2021-04-27 20:16:52
SslRedirectboolean

是否启用ssl重定向,true - 启用,false - 关闭。

true
Endpointstring

应用路由入口IP地址。

47.11x.xx.xx
Namespacestring

应用路由所属K8s命名空间。

default
Namestring

应用路由名称。

my-ingress
DashboardUrlstring

应用路由监控URL。

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

应用路由规则列表。

object
SecretNamestring

保存TLS证书的Secret名称。

my-secret
Hoststring

应用路由域名。

example.com
Pathsarray

应用路由匹配路径列表。

object
Statusstring

应用路由状态,支持以下状态:

  • Normal:状态正常。

  • ServiceNotFound:后端Service不存在。

  • InvalidServicePort:无效服务端口。

  • NotManagedService:非EDAS管控Service。

  • Unknown:未知错误。

Normal
Pathstring

匹配路径。

/foo/bar
AppNamestring

EDAS应用名称。

my-app
AppIdstring

EDAS应用ID。

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

后端服务配置。

ServiceNamestring

后端服务名称。

http-service
ServicePortstring

后端服务端口。

8080
EnableTlsboolean
AlbIdstring
IngressTypestring

示例

请求示例

GET /pop/v5/k8s/acs/k8s_ingress HTTP/1.1
公共请求头
{
"ClusterId": "5b2b4ab4-efbc-4a81-9c45-xxxxxxxxxxxxx",
"RegionId": "cn-hangzhou"
}

正常返回示例

JSON格式

{
    "RequestId": "5C1C9DE7-88FF-4B56-A47B-3DBBCEB23256",
    "Message": "success",
    "Data": {
        "ClusterId": "5b2b4ab4-efbc-4a81-9c45-a5942881****",
        "ClusterName": "my-dev-cluster",
        "RegionId": "cn-hangzhou",
        "IngressConfs": {
            "SslRedirect": "",
            "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": {
                    "Path": "/foo/bar",
                    "Status": "Normal",
                    "AppId": "43d30ba5-c568-460c-8080-d447ed1a****",
                    "AppName": "my-app",
                    "Backend": {
                        "ServicePort": 8080,
                        "ServiceName": "http-service"
                    }
                }
            }
        }
    },
    "Code": 200
}

XML格式

<RequestId>5C1C9DE7-88FF-4B56-A47B-3DBBCEB23256</RequestId>
<Message>success</Message>
<Data>
    <ClusterId>5b2b4ab4-efbc-4a81-9c45-a5942881****</ClusterId>
    <ClusterName>my-dev-cluster</ClusterName>
    <RegionId>cn-hangzhou</RegionId>
    <IngressConfs>
        <SslRedirect/>
        <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>
                <Path>/foo/bar</Path>
                <Status>Normal</Status>
                <AppId>43d30ba5-c568-460c-8080-d447ed1a****</AppId>
                <AppName>my-app</AppName>
                <Backend>
                    <ServicePort>8080</ServicePort>
                    <ServiceName>http-service</ServiceName>
                </Backend>
            </Paths>
        </Rules>
    </IngressConfs>
</Data>
<Code>200</Code>

错误码

HttpCode错误码错误信息描述
500Edas.errorcode.PermissionDenied.messageYou are not authorized to perform the operation.无权限操作

访问错误中心查看更多错误码。

首页 企业级分布式应用服务 EDAS API参考 API目录 应用路由 ListK8sIngressRules - 获取应用路由列表