Release Notes and Announcements

Announcements

Release Notes

Product Introduction

Overview

Strengths

Scenarios

Purchase Guide

Billing Overview

Product Pricing

Overdue Policies

Getting Started

Step 1. Get the Access Permission

Step 2. Create an Environment

Step 3. Create an Application

Step 4. Deploy the Application

Operation Guide

Environment Management

Application Management

Permission Management

View Change Record

Practical Tutorial

Use of GitHub Actions in TEM

Hosting a Static Website

Public Network Access of TEM Applications

TEM Application Access to Public Network (Through API Gateway)

TEM Application Failure Troubleshooting Guide

Quick Access to TEM Application Through API Gateway

Java Application Fine-Tuning

Migration from Java 8 to Java 11

API Documentation

History

Introduction

API Category

Making API Requests

Environment APIs

ModifyIngress

Resource APIs

Application APIs

Service APIs

RollingUpdateApplicationByVersion

Access Policy APIs

Configuration file APIs

Log collecting APIs

Scaling Rule APIs

Application Version APIs

Other APIs

Workload APIs

Data Types

Error Codes

FAQs

TEM Configuration

Glossary

TEM Policy

Data Privacy and Security Agreement

DescribeIngresses

PDF

Focus Mode

Font Size

Last updated: 2025-11-13 21:13:07

1. API Description

Domain name for API request: tem.intl.tencentcloudapi.com.

This API is used to query the list of ingress rules.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeIngresses.
Version	Yes	String	Common Params. The value used for this API: 2021-07-01.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
EnvironmentId	No	String	Environment ID
ClusterNamespace	No	String	Environment namespace
SourceChannel	No	Integer	Source channel
IngressNames.N	No	Array of String	Ingress rule name list

3. Output Parameters

Parameter Name	Type	Description
Result	Array of IngressInfo	Ingress array Note: this field may return `null`, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the list of ingress rules

This example shows you how to get the list of ingress rules.

Input Example

POST / HTTP/1.1
Host: tem.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIngresses
<Common request parameters>

{
    "ClusterNamespace": "xx",
    "EnvironmentId": "xx",
    "IngressNames": [
        "xx"
    ],
    "SourceChannel": 0,
}

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.DescribeServiceListError	Failed to query the service list
InternalError.DescribeServiceListError	Failed to query the service list
InvalidParameterValue.TemIdInvalid	The TEM ID is incorrect.
MissingParameter.NamespaceIdNull	The environment ID can not be left empty.
ResourceNotFound.MicroserviceOffline	The target microservice is offline.
ResourceNotFound.VersionNamespaceNotFound	The environment corresponding to this version is not found.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Tencent Cloud Elastic Microservice