tencent cloud

Feedback

ModifyIngress

Last updated: 2023-12-04 16:38:16

    1. API Description

    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.

    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: 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

    3. Output Parameters

    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.

    4. Example

    Example1 Creating or updating ingress rule

    This example shows you how to create or update an ingress rule.

    Input Example

    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"
        }
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "81f74023-563c-437d-abf7-8139449ef178",
            "Result": true
        }
    }
    

    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

    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.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
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support