Domain name for API request: tem.tencentcloudapi.com.
This API is used to create or update an ingress rule.
A maximum of 20 requests can be initiated per second for this API.
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: ModifyIngress. |
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. |
Ingress | Yes | IngressInfo | Ingress rule configuration |
SourceChannel | No | Integer | Source channel |
Parameter Name | Type | Description |
---|---|---|
Result | Boolean | Created successfully. 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. |
This example shows you how to create or update an ingress rule.
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyIngress
<Common request parameters>
{
"SourceChannel": 0,
"Ingress": {
"Tls": [
{
"CertificateId": "xx",
"Hosts": [
"xxx.com"
],
"SecretName": "xx"
}
],
"EnvironmentId": "xx",
"ClusterNamespace": "xx",
"Rules": [
{
"Protocol": "xx",
"Host": "xx",
"Http": {
"Paths": [
{
"Path": "xx",
"Backend": {
"ServiceName": "xx",
"ServicePort": 443
}
}
]
}
}
],
"ClbId": "xx",
"ClusterId": "xx",
"IngressName": "xx",
"Vip": "xx",
"Mixed": true,
"AddressIPVersion": "xx",
"CreateTime": "xx"
}
}
{
"Response": {
"RequestId": "81f74023-563c-437d-abf7-8139449ef178",
"Result": true
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.UpdateIngressError | Failed to update the ingress |
InternalError.UpdateIngressError | Failed to update the ingress |
InvalidParameterValue.IngressRewriteRequiredHttpsEnable | To enable access configuration redirection, you need to enable HTTPS. |
InvalidParameterValue.NamespaceNotBelongToAppid | The namespace does not belong to the current account. |
InvalidParameterValue.TemIdInvalid | The TEM ID is incorrect. |
UnauthorizedOperation.UnauthorizedOperation | Not authorized |
Was this page helpful?