调用DescribeIngress接口查询Ingress配置详情。

调试

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

请求头

该接口使用公共请求头，无特殊请求头。更多信息，请参见公共请求和返回头。

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
IngressId Long Query 是 87

需要查询的路由规则ID。

返回数据

名称 类型 示例值 描述
RequestId String 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

请求ID。
Message String success

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

  • 请求正常，返回success。
  • 请求异常，返回具体异常错误码。
TraceId String 0a981dd515966966104121683d****

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

返回结果。
SlbId String lb-uf62****6d13tq2u5

SLB ID。
NamespaceId String cn-beijing:sae-test

命名空间ID。
Description String ingress-sae-test

路由规则名称。
ListenerPort Integer 443

SLB监听端口。
SlbType String internet

SLB类型。取值说明如下：

  • internet：公网。
  • intranet：私网。
CertId String 13623****809_16cad216b32_845_-419427029

CLB证书ID。
Name String lb-uf6jt0nu4z6ior943****-80-f5****

路由规则名称。
DefaultRule Object

默认规则。
ContainerPort Integer 8080

默认规则应用的后端端口。
AppName String app1

默认规则的应用名称。
AppId String 395b60e4-0550-458d-9c54-a265d036****

默认规则的应用。
BackendProtocol String http

后端协议。取值说明如下：

  • http：适用于需要对数据内容进行识别的应用。
  • https：适用于需要加密传输的应用。
  • grpc：适用于.net等多语言用户gRPC的负载均衡场景。

该参数仅在参数LoadBalanceType取值为ALB，且参数ListenerProtocol取值为HTTPS时返回。
Rules Array of Rule

转发规则。
AppName String app1

目标应用名称。
ContainerPort Integer 8080

应用后端端口。
Domain String edas.site

应用域名。
AppId String 395b60e4-0550-458d-9c54-a265d036****

目标应用ID。
Path String /path1

URL路径。
BackendProtocol String http

后端协议。取值说明如下：

  • http：适用于需要对数据内容进行识别的应用。
  • https：适用于需要加密传输的应用。
  • grpc：适用于.net等多语言用户gRPC的负载均衡场景。

该参数仅在参数LoadBalanceType取值为ALB，且参数ListenerProtocol取值为HTTPS时返回。
RewritePath String /${1}

重写路径。
Id Long 87

路由规则ID。
LoadBalanceType String clb

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

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

请求转发协议。取值说明如下：

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

在CreateIngress和UpadateIngress中，该参数非必填项，如果创建或更新网关路由规则时未填写该参数，则调用该API时不返回。
CertIds String 87***35-cn-hangzhou,812***3-cn-hangzhou

ALB多证书ID。
ErrorCode String 空

错误码。取值说明如下：

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

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

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

查询Ingress详情是否成功。取值说明如下：

  • true：查询成功。
  • false：查询失败。

示例

请求示例

GET /pop/v1/sam/ingress/Ingress?IngressId=87 HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeIngressResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>0a981dd515966966104121683d****</TraceId>
    <Data>
        <SlbId>lb-uf62****6d13tq2u5</SlbId>
        <NamespaceId>cn-beijing:sae-test</NamespaceId>
        <Description>ingress-sae-test</Description>
        <ListenerPort>443</ListenerPort>
        <SlbType>internet</SlbType>
        <CertId>13623****809_16cad216b32_845_-419427029</CertId>
        <Name>lb-uf6jt0nu4z6ior943****-80-f5****</Name>
        <DefaultRule>
            <ContainerPort>8080</ContainerPort>
            <AppName>app1</AppName>
            <AppId>395b60e4-0550-458d-9c54-a265d036****</AppId>
            <BackendProtocol>http</BackendProtocol>
        </DefaultRule>
        <Rules>
            <AppName>app1</AppName>
            <ContainerPort>8080</ContainerPort>
            <Domain>edas.site</Domain>
            <AppId>395b60e4-0550-458d-9c54-a265d036****</AppId>
            <Path>/path1</Path>
            <BackendProtocol>http</BackendProtocol>
            <RewritePath>/${1}</RewritePath>
        </Rules>
        <Id>87</Id>
        <LoadBalanceType>clb</LoadBalanceType>
        <ListenerProtocol>HTTP</ListenerProtocol>
        <CertIds>87***35-cn-hangzhou,812***3-cn-hangzhou</CertIds>
    </Data>
    <ErrorCode>空</ErrorCode>
    <Code>200</Code>
    <Success>true</Success>
</DescribeIngressResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message" : "success",
  "TraceId" : "0a981dd515966966104121683d****",
  "Data" : {
    "SlbId" : "lb-uf62****6d13tq2u5",
    "NamespaceId" : "cn-beijing:sae-test",
    "Description" : "ingress-sae-test",
    "ListenerPort" : 443,
    "SlbType" : "internet",
    "CertId" : "13623****809_16cad216b32_845_-419427029",
    "Name" : "lb-uf6jt0nu4z6ior943****-80-f5****",
    "DefaultRule" : {
      "ContainerPort" : 8080,
      "AppName" : "app1",
      "AppId" : "395b60e4-0550-458d-9c54-a265d036****",
      "BackendProtocol" : "http"
    },
    "Rules" : [ {
      "AppName" : "app1",
      "ContainerPort" : 8080,
      "Domain" : "edas.site",
      "AppId" : "395b60e4-0550-458d-9c54-a265d036****",
      "Path" : "/path1",
      "BackendProtocol" : "http",
      "RewritePath" : "/${1}"
    } ],
    "Id" : 87,
    "LoadBalanceType" : "clb",
    "ListenerProtocol" : "HTTP",
    "CertIds" : "87***35-cn-hangzhou,812***3-cn-hangzhou"
  },
  "ErrorCode" : "空",
  "Code" : "200",
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
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。

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