Tencent Cloud Elastic Microservice
- Release Notes and Announcements
- Announcements
- Purchase Guide
- Getting Started
- Step 1. Get the Access Permission
- Step 4. Deploy the Application
- Operation Guide
- Environment Management
- Application Management
- Permission Management
- Practical Tutorial
- API Documentation
- Making API Requests
- Application Version APIs
- Environment APIs
- Resource APIs
- RollingUpdateApplicationByVersion
- Service APIs
- Workload APIs
- Access Policy APIs
- Configuration file APIs
- Log collecting APIs
- Scaling Rule APIs
- Other APIs
DescribeIngresses
Last updated: 2023-12-04 16:38:17
1. API Description
Domain name for API request: tem.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.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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
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. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No