tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyRuleAttribute

Last updated: 2023-07-13 15:25:25

1. API Description

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

This API (ModifyRuleAttribute) is used to modify forwarding rule information, including health check configuration and forwarding policies.

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: ModifyRuleAttribute.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. This parameter is not required.
ListenerId Yes String Listener ID
RuleId Yes String Forwarding rule ID
Scheduler No String The strategy used by the listener to access the origin server. Values: rr (round-robin), wrr (weighted round-robin), lc (the least-connections strategy), lrtt (the least-response-time strategy).
HealthCheck No Integer Whether to enable the origin server health check:
1: enable;
0: disable.
CheckParams No RuleCheckParams Health check configuration parameters
Path No String Forwarding rule path
ForwardProtocol No String Protocol types of the forwarding from acceleration connection to origin server, which supports default, HTTP and HTTPS.
If ForwardProtocol=default, the ForwardProtocol of the listener will be used.
ForwardHost No String The forwarding host, which is carried in the request forwarded from the acceleration connection to the origin server.
If ForwardHost=default, the domain name configured with the forwarding rule will be used. For other cases, the value set in this field will be used.
ServerNameIndicationSwitch No String Specifies whether to enable Server Name Indication (SNI). Valid values: ON (enable) and OFF (disable).
ServerNameIndication No String Server Name Indication (SNI). This field is required when ServerNameIndicationSwitch is ON.
ForcedRedirect No String Enables HTTP-to-HTTPS force redirect for a forwarding rule. Enter a hostname and path of the current forwarding rule.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying forwarding rule information

Modify the forwarding rule information.

Input Example

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

{
    "RuleId": "rule-5g8dh58",
    "HealthCheck": "0",
    "ListenerId": "listener-8fueuc9",
    "CheckParams": {
        "Domain": "string",
        "ConnectTimeout": "12",
        "Path": "str",
        "Method": "string",
        "DelayLoop": "1",
        "StatusCode": [
            "1"
        ]
    },
    "Scheduler": "rr",
    "Path": "/"
}

Output Example

{
    "Response": {
        "RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
    }
}

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
AuthFailure CAM signature/authentication error.
AuthFailure.NotEnterpriseAuthorization Not an organizational customer.
AuthFailure.UnauthorizedOperation The sub-account is not authorized for this operation.
FailedOperation Operation failed.
FailedOperation.InstanceStatusNotInRuning Unable to operate: the connection is not running.
FailedOperation.ListenerHasTask The listener is in operation. Do not repeat the operation.
FailedOperation.NonStandardProxy This connection is non-standard and write operations are not allowed.
FailedOperation.RuleAlreadyExisted Rule already exists.
FailedOperation.UserNotConfirmProtocol Protocol not activated.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy