全部产品
Search

搜索本产品

    ：ListIngresses - 获取ingress列表

    文档中心

    ：ListIngresses - 获取ingress列表

    更新时间：Nov 01, 2024

    调用ListIngresses接口获取Ingress列表。

    调试

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

    授权信息

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

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

    请求语法

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

    请求参数

    名称类型必填描述示例值
    NamespaceIdstring是

    命名空间 ID。

    		cn-beijing
    AppIdstring否

    应用 ID。

    		bbf3a590-6d13-46fe-8ca9-c947a20b****

    返回参数

    名称类型描述示例值
    object

    返回数据。

    RequestIdstring

    请求 ID。

    		91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
    Messagestring

    附加信息。取值说明如下：

    • 请求正常，返回 success。
    • 请求异常，返回具体异常错误码。
    		success
    TraceIdstring

    调用链 ID，用于精确查询调用信息。

    		0a98a02315955564772843261e****
    Dataobject

    返回结果。

    IngressListarray<object>

    路由规则列表。

    Ingressobject

    路由规则信息。

    SlbIdstring

    SLB ID。

    		lb-uf62****6d13tq2u5
    NamespaceIdstring

    命名空间 ID。

    		cn-shanghai
    Descriptionstring

    路由规则名称。

    		test
    ListenerPortstring

    SLB 监听端口。

    		80
    SlbTypestring

    SLB 类型。取值说明如下：

    • internet：公网。
    • intranet：私网。
    		internet
    CertIdstring

    CLB 证书 ID。

    		13624*****73809_16f8e549a20_1175189789_12****3210
    CertIdsstring

    ALB 多证书 ID。

    		87***35-cn-hangzhou,812***3-cn-hangzhou
    Namestring

    路由规则名称。

    		lb-uf6jt0nu4z6ior943****-80-f5****
    Idlong

    路由规则 ID。

    		18
    LoadBalanceTypestring

    负载均衡 SLB 的类型。取值说明如下：

    • clb：传统型负载均衡 CLB（原 SLB）。
    • alb：应用型负载均衡 ALB。
    		clb
    ListenerProtocolstring

    负载均衡 SLB 支持的请求转发协议。取值说明如下：

    • HTTP：适用于需要对数据内容进行识别的应用。
    • HTTPS：适用于需要加密传输的应用。

    在 CreateIngress 和 UpadateIngress 中，该参数非必填项，如果创建或更新网关路由规则时未填写该参数，则调用该 API 时不返回。

    		HTTP
    MseGatewayIdstring

    MSE 云原生网关实例 ID。

    		gw-d5df01a1bae748f1a7c4e325d2fd****
    MseGatewayPortstring

    服务对应的端口。

    		80
    MseGatewayProtocolstring

    MSE 云原生网关支持的请求转发协议。取值说明如下：

    • HTTP：适用于需要对数据内容进行识别的应用。
    • HTTPS：适用于需要加密传输的应用。
    		HTTP
    ErrorCodestring

    错误码。取值说明如下：

    • 请求成功：不返回 ErrorCode 字段。
    • 请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码列表。
    		空
    Codestring

    接口状态或 POP 错误码。取值说明如下：

    • 2xx：成功。
    • 3xx：重定向。
    • 4xx：请求错误。
    • 5xx：服务器错误。
    		200
    Successboolean

    获取 Ingress 列表是否成功。取值说明如下：

    • true：获取成功。
    • false：获取失败。
    		true

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "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"
      }
    ]
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2023-09-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情