全部产品
Search

搜索本产品

    ：DescribeIngress - 查询ingress配置详情

    文档中心

    ：DescribeIngress - 查询ingress配置详情

    更新时间：Nov 06, 2024

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

    调试

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

    授权信息

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

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

    请求语法

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

    请求参数

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

    需要查询的路由规则 ID。

    		87

    返回参数

    名称类型描述示例值
    object

    返回数据。

    RequestIdstring

    请求 ID。

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

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

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

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

    		0a981dd515966966104121683d****
    Dataobject

    返回结果。

    SlbIdstring

    SLB ID。

    		lb-uf62****6d13tq2u5
    NamespaceIdstring

    命名空间 ID。

    		cn-beijing:sae-test
    Descriptionstring

    路由规则名称。

    		ingress-sae-test
    ListenerPortinteger

    SLB 监听端口。

    		443
    SlbTypestring

    SLB 类型。取值说明如下：

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

    CLB 证书 ID。

    		13623****809_16cad216b32_845_-419427029
    Namestring

    路由规则名称。

    		lb-uf6jt0nu4z6ior943****-80-f5****
    DefaultRuleobject

    默认规则。

    ContainerPortinteger

    默认规则应用的后端端口。

    		8080
    AppNamestring

    默认规则的应用名称。

    		app1
    AppIdstring

    默认规则的应用。

    		395b60e4-0550-458d-9c54-a265d036****
    BackendProtocolstring

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

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

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

    		http
    Rulesarray<object>

    转发规则。

    Ruleobject

    转发规则。

    AppNamestring

    目标应用名称。

    		app1
    ContainerPortinteger

    应用后端端口。

    		8080
    Domainstring

    应用域名。

    		edas.site
    AppIdstring

    目标应用 ID。

    		395b60e4-0550-458d-9c54-a265d036****
    Pathstring

    URL 路径。

    		/path1
    BackendProtocolstring

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

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

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

    		http
    RewritePathstring

    重写路径。

    		/${1}
    Idlong

    路由规则 ID。

    		87
    LoadBalanceTypestring

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

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

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

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

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

    		HTTP
    CertIdsstring

    ALB 多证书 ID。

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

    安全策略实例 ID

    		sp-n0kn923****
    RequestTimeoutinteger

    指定请求超时时间。单位：秒。

    取值：1~180。

    默认值：60。

    如果在超时时间内后端服务器一直没有响应，负载均衡将放弃等待，并给客户端返回 HTTP 504 错误码。

    		60
    IdleTimeoutinteger

    指定连接空闲超时时间。单位：秒。

    取值范围：1~60。

    默认值：15。

    如果在超时时间内一直没有访问请求，负载均衡会暂时中断当前连接，直到一下次请求来临时重新建立新的连接。

    		3
    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": "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}",
        "RuleActions": [
          {
            "ActionType": "",
            "ActionConfig": ""
          }
        ]
      }
    ],
    "Id": 87,
    "LoadBalanceType": "clb",
    "ListenerProtocol": "HTTP",
    "CertIds": "87***35-cn-hangzhou,812***3-cn-hangzhou",
    "SecurityPolicyId": "sp-n0kn923****",
    "RequestTimeout": 60,
    "IdleTimeout": 3,
    "EnableXForwardedFor": true,
    "EnableXForwardedForClientSrcPort": true,
    "EnableXForwardedForProto": true,
    "EnableXForwardedForSlbId": true,
    "EnableXForwardedForSlbPort": true
  },
  "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。

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

    变更历史

    变更时间变更内容概要操作
    2024-10-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2024-09-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2024-08-21OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-05-08OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情