调用ListK8sIngressRules接口获取应用路由列表_企业级分布式应用服务(EDAS)-阿里云帮助中心

获取应用路由列表。

调试

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

调试

授权信息

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

请求语法

GET /pop/v5/k8s/acs/k8s_ingress

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	阿里云地域 ID。	cn-hangzhou
ClusterId	string	否	集群 ID。	5b2b4ab4-efbc-4a81-9c45-xxxxxxxxxxxxx
Namespace	string	否	K8s 集群命名空间。	default
Condition	string	否	过滤条件，JSON 类型，格式为{"field":"Name", "pattern":"my-"}，其中： field：需要匹配的字段，支持 Name 和 ClusterName。 pattern：匹配内容。以{"field":"Name", "pattern":"my-"}这条过滤条件为例，该条过滤规则会匹配名称为“my-”开头的路由规则。	{"field":"Name", "pattern":"my-"}

返回参数

名称	类型	描述	示例值
	object	接口响应。
Code	integer	接口状态码。	200
Message	string	返回信息。	success
RequestId	string	请求 ID。	5C1C9DE7-88FF-4B56-A47B-3DBBCEB******
Data	object []	接口响应数据。
ClusterName	string	集群名称。	my-dev-cluster
ClusterId	string	集群 ID。	5b2b4ab4-efbc-4a81-9c45-a5942881****
RegionId	string	阿里云地域 ID。	cn-hangzhou
IngressConfs	object []	应用路由列表。
CreationTime	string	应用路由创建时间。	2021-04-27 20:16:52
SslRedirect	boolean	是否启用 SSL 重定向： true：启用。 false：关闭。	true
Endpoint	string	应用路由入口 IP 地址。	47.11x.xx.xx
Namespace	string	应用路由所属 K8s 命名空间。	default
Name	string	应用路由名称。	my-ingress
DashboardUrl	string	应用路由监控 URL。	http://grafana.console.aliyun.com/d/10xxxx/ingress
Rules	object []	应用路由规则列表。
SecretName	string	保存 TLS 证书的 Secret 名称。	my-secret
Host	string	应用路由域名。	example.com
Paths	object []	应用路由匹配路径列表。
Status	string	应用路由状态，支持以下状态： Normal：状态正常。 ServiceNotFound：后端 Service 不存在。 InvalidServicePort：无效服务端口。 NotManagedService：非 EDAS 管控 Service。 Unknown：未知错误。	Normal
Path	string	匹配路径。	/foo/bar
AppName	string	EDAS 应用名称。	my-app
AppId	string	EDAS 应用 ID。	43d30ba5-c568-460c-8080-d447ed1a****
Backend	object	后端服务配置。
ServiceName	string	后端服务名称。	http-service
ServicePort	string	后端服务端口。	8080
CollectRate	integer	基于 EDAS 为网关注入 TraceId 支持调用链路查询能力，设置匹配该条规则流量的采样率。	100
PathType	string	路径匹配类型： ImplementationSpecific：默认。 Exact：完整匹配。 Prefix：前缀匹配。	ImplementationSpecific
EnableTls	boolean	是否启用 TLS： true：启用。 false：不启用。	false
AlbId	string	应用型负载均衡 ALB 实例 ID。	alb-5sde0tq62r********
IngressType	string	应用路由类型： NginxIngress：使用 nginx 应用路由控制器。 AlbIngress：使用 ALB 应用路由控制器。默认使用 NginxIngress。	NginxIngress
OfficalBasicUrl	string	社区版本基础监控地址。	https://g.console.aliyun.com/d/xxxxxx/nginx-ingress-dashboard-official
OfficalRequestUrl	string	社区版本请求性能监控地址。	https://g.console.aliyun.com/d/xxxxxx/request-handling-performance-official
MseGatewayId	string	MSE 网关实例 ID。	gw-xxxxxxxx
MseGatewayName	string	MSE 网关实例名称。	gw-test-name
Annotations	string	注解。	{"test-annotation":"test-annotation-value"}
Labels	string	标签。	{"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,
                  "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\"}"
        }
      ]
    }
  ]
}

错误码

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

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

变更历史

变更时间

变更内容概要

操作

2023-05-17

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：500
出参	OpenAPI 返回结构发生变更。