tencent cloud

Feedback

ManualRewrite

Last updated: 2024-09-05 19:28:11

    1. API Description

    Domain name for API request: clb.tencentcloudapi.com.

    After the original access address and the address to be redirected are configured manually, the system will automatically redirect requests made to the original access address to the target address of the corresponding path. Multiple paths can be configured as a redirection policy under one domain name to achieve automatic redirection between HTTP and HTTPS. A redirection policy should meet the following rules: if A has already been redirected to B, then it cannot be redirected to C (unless the original redirection relationship is deleted and a new one is created), and B cannot be redirected to any other addresses.

    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: ManualRewrite.
    Version Yes String Common Params. The value used for this API: 2018-03-17.
    Region No String Common Params. This parameter is not required for this API.
    LoadBalancerId Yes String CLB instance ID
    SourceListenerId Yes String Source listener ID
    TargetListenerId Yes String Target listener ID
    RewriteInfos.N Yes Array of RewriteLocationMap Redirection relationship between forwarding rules

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Manually adding a redirection relationship

    Input Example

    https://clb.tencentcloudapi.com/?Action=ManualRewrite
    &LoadBalancerId=lb-r6nx1iby
    &SourceListenerId=lbl-cy6akv52
    &TargetListenerId=lbl-cy6ak123
    &RewriteInfos.0.SourceLocationId=loc-2jkimjn0
    &RewriteInfos.0.TargetLocationId=loc-eu15yo84
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "RequestId": "fc0ed756-c311-41c8-a22d-64f88a346951"
        }
    }
    

    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 Operation failed.
    FailedOperation.InvalidLBStatus Exceptional CLB instance status
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.FormatError Wrong parameter format.
    InvalidParameter.LBIdNotFound Wrong CLB instance ID.
    InvalidParameter.ListenerIdNotFound Wrong listener ID.
    InvalidParameter.LocationNotFound Unable to find eligible forwarding rules.
    InvalidParameter.ProtocolCheckFailed Listener protocol checks failed because the protocol used is incompatible with the corresponding operation.
    InvalidParameter.RewriteAlreadyExist The forwarding rule has already been bound to a redirection relationship.
    InvalidParameter.SomeRewriteNotFound Some redirection rules do not exist.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Length Wrong parameter length.
    LimitExceeded Quota exceeded.
    ResourceInsufficient Insufficient resources.
    UnauthorizedOperation Unauthorized operation.