调用ListIngresses获取Ingress路由规则列表-Serverless 应用引擎-阿里云-Serverless 应用引擎(SAE)-阿里云帮助中心

调用ListIngresses接口获取Ingress列表。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sae:ListIngresses

get

*全部资源

*

无

请求语法

GET /pop/v1/sam/ingress/IngressList HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
NamespaceId	string	是	命名空间 ID。	cn-beijing
AppId	string	否	应用 ID。	bbf3a590-6d13-46fe-8ca9-c947a20b****
CurrentPage	integer	否	当前页数。	1
PageSize	integer	否	分页大小。	20

返回参数

名称	类型	描述	示例值
	object	返回数据。
RequestId	string	请求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	附加信息。取值说明如下：请求正常，返回 success。请求异常，返回具体异常错误码。	success
TraceId	string	调用链 ID，用于精确查询调用信息。	0a98a02315955564772843261e****
Data	object	返回结果。
CurrentPage	integer	当前页。	1
TotalSize	integer	查询到的总数。	10
PageSize	integer	每页数据条数。	10
IngressList	array<object>	路由规则列表。
	array<object>	路由规则信息。
SlbId	string	SLB ID。	lb-uf62****6d13tq2u5
NamespaceId	string	命名空间 ID。	cn-shanghai
Description	string	路由规则名称。	test
ListenerPort	string	SLB 监听端口。	80
SlbType	string	SLB 类型。取值说明如下： internet：公网。 intranet：私网。	internet
CertId	string	CLB 证书 ID。	13624***73809_16f8e549a20_1175189789_12**3210
CertIds	string	ALB 多证书 ID。	87*35-cn-hangzhou,812*3-cn-hangzhou
Name	string	路由规则名称。	lb-uf6jt0nu4z6ior943**-80-f5**
Id	integer	路由规则 ID。	18
LoadBalanceType	string	负载均衡 SLB 的类型。取值说明如下： clb：传统型负载均衡 CLB（原 SLB）。 alb：应用型负载均衡 ALB。	clb
ListenerProtocol	string	负载均衡 SLB 支持的请求转发协议。取值说明如下： HTTP：适用于需要对数据内容进行识别的应用。 HTTPS：适用于需要加密传输的应用。在 CreateIngress 和 UpadateIngress 中，该参数非必填项，如果创建或更新网关路由规则时未填写该参数，则调用该 API 时不返回。	HTTP
MseGatewayId	string	MSE 云原生网关实例 ID。	gw-d5df01a1bae748f1a7c4e325d2fd****
MseGatewayPort	string	服务对应的端口。	80
MseGatewayProtocol	string	MSE 云原生网关支持的请求转发协议。取值说明如下： HTTP：适用于需要对数据内容进行识别的应用。 HTTPS：适用于需要加密传输的应用。	HTTP
RequestTimeout	integer	请求超时时间。	60
IdleTimeout	integer	连接空闲超时时间。	3
CreateTime	integer	创建时间。	1593746835111
DefaultRule	object	默认规则。
ContainerPort	integer	容器端口。	8080
AppName	string	应用名称。	demo-app
AppId	string	应用 ID。	7171a6ca-d1cd-4928-8642-7d5cfe69****
BackendProtocol	string	后端协议。	http
Rules	array<object>	规则。
	array<object>
AppName	string	应用名称。	demo-app
ContainerPort	integer	容器端口。	8080
Domain	string	域名。	edas.site
AppId	string	应用 ID。	7171a6ca-d1cd-4928-8642-7d5cfe69****
Path	string	路径。	/Path
BackendProtocol	string	后端协议。	http
RewritePath	string	重写路径。	/${1}
RuleActions	array<object>	规则动作列表。
	object	规则动作。
ActionType	string	动作类型。	rewrite
ActionConfig	string	动作配置。	{\"host\":\"www.example.com\",\"path\":\"/example/text\",\"query\":\"x=1\"}
CorsConfig	object	跨域配置。
Enable	string	是否开启。	false
ExposeHeaders	string	允许暴露的 Header。	test_123
AllowHeaders	string	允许的 Header。	test_123
AllowMethods	string	允许的方法。	GET
AllowOrigin	string	允许访问的来源。	*
AllowCredentials	string	允许的携带凭证。	on
MaxAge	string	过期时间。	1000
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码列表。	InvalidParameter.NotEmpty
Code	string	接口状态或 POP 错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	获取 Ingress 列表是否成功。取值说明如下： true：获取成功。 false：获取失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 10,
    "PageSize": 10,
    "IngressList": [
      {
        "SlbId": "lb-uf62****6d13tq2u5",
        "NamespaceId": "cn-shanghai",
        "Description": "test",
        "ListenerPort": "80",
        "SlbType": "internet",
        "CertId": "13624*****73809_16f8e549a20_1175189789_12****3210",
        "CertIds": "87***35-cn-hangzhou,812***3-cn-hangzhou",
        "Name": "lb-uf6jt0nu4z6ior943****-80-f5****",
        "Id": 18,
        "LoadBalanceType": "clb",
        "ListenerProtocol": "HTTP",
        "MseGatewayId": "gw-d5df01a1bae748f1a7c4e325d2fd****",
        "MseGatewayPort": "80",
        "MseGatewayProtocol": "HTTP",
        "RequestTimeout": 60,
        "IdleTimeout": 3,
        "CreateTime": 1593746835111,
        "DefaultRule": {
          "ContainerPort": 8080,
          "AppName": "demo-app",
          "AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
          "BackendProtocol": "http"
        },
        "Rules": [
          {
            "AppName": "demo-app",
            "ContainerPort": 8080,
            "Domain": "edas.site",
            "AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
            "Path": "/Path",
            "BackendProtocol": "http",
            "RewritePath": "/${1}",
            "RuleActions": [
              {
                "ActionType": "rewrite",
                "ActionConfig": "{\\\"host\\\":\\\"www.example.com\\\",\\\"path\\\":\\\"/example/text\\\",\\\"query\\\":\\\"x=1\\\"}"
              }
            ]
          }
        ],
        "CorsConfig": {
          "Enable": "false",
          "ExposeHeaders": "test_123",
          "AllowHeaders": "test_123",
          "AllowMethods": "GET",
          "AllowOrigin": "*",
          "AllowCredentials": "on",
          "MaxAge": "1000"
        }
      }
    ]
  },
  "ErrorCode": "InvalidParameter.NotEmpty",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	不合法的参数：%s不能为空。
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	不合法的参数{%s}。
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	不合法的参数{%s}：%s。

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

变更历史

更多信息，参考变更详情。