全部产品
Search
文档中心

企业级分布式应用服务 EDAS:ListK8sIngressRules - 获取应用路由列表

更新时间:Nov 15, 2022

获取应用路由列表。

调试

您可以在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
CollectRateinteger

基于EDAS为网关注入TraceId支持调用链路查询能力,设置匹配该条规则流量的采样率。

100
EnableTlsboolean

是否启用TLS:

  • true:启用。
  • false:不启用。
false
AlbIdstring

应用型负载均衡ALB实例ID。

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

应用路由类型:

  • NginxIngress:使用nginx应用路由控制器。
  • AlbIngress:使用ALB应用路由控制器。

默认使用NginxIngress。

NginxIngress
OfficalBasicUrlstring

社区版本基础监控地址。

https://g.console.aliyun.com/d/xxxxxx/nginx-ingress-dashboard-official
OfficalRequestUrlstring

社区版本请求性能监控地址。

https://g.console.aliyun.com/d/xxxxxx/request-handling-performance-official
MseGatewayIdstring

MSE网关实例ID。

gw-xxxxxxxx
MseGatewayNamestring

MSE网关实例名称。

gw-test-name
Annotationsstring

注解。

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

标签。

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

示例

正常返回示例

JSON格式

{
  "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
                }
              ],
              "EnableTls": true
            }
          ],
          "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\"}"
        }
      ]
    }
  ]
}

错误码

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

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