帮你快速理解、总结文档立即下载
文档中心>弹性微服务

查询 Ingress 规则列表

最近更新时间:2021-06-04 08:00:30
我的收藏

1. 接口描述

接口请求域名: tem.tencentcloudapi.com 。

查询 Ingress 规则列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeIngresses。
Version 是 String 公共参数,本接口取值:2020-12-21。
Region 是 String 公共参数,详见产品支持的 地域列表。
NamespaceId 否 String namespace id
EksNamespace 否 String namespace
SourceChannel 否 Integer 来源渠道
Names.N 否 Array of String ingress 规则名列表

3. 输出参数

参数名称 类型 描述
Result Array of IngressInfo ingress 数组
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 Ingress 列表

Ingress 列表

输入示例

POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIngresses
<公共请求参数>

{
    "NamespaceId": "env-xxx",
    "EksNamespace": "default",
    "Names": [
        "test-ingress-1"
    ]
}

输出示例

{
  "Response": {
    "RequestId": "81f74023-563c-437d-abf7-8139449ef178",
    "Result": [
      {
        "ClusterId": "cls-9lxt9ic2",
        "NamespaceId": null,
        "EksNamespace": "default",
        "AddressIPVersion": "IPV4",
        "ClbId": "clb-xxxx",
        "Vip": "10.10.10.10",
        "Name": "test-ingress-1",
        "Rules": [
          {
            "Host": "",
            "Http": {
              "Paths": [
                {
                  "Path": "/",
                  "Backend": {
                    "ServiceName": "kubernetes",
                    "ServicePort": 443
                  }
                }
              ]
            }
          }
        ],
        "Tls": [
          {
            "Hosts": [
              "xxx.com"
            ],
            "SecretName": "xxx"
          }
        ]
      }
    ]
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。