tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Web Application Firewall
    Documentation
    Download PDF

    ModifyObject

    Last updated: 2024-09-25 10:12:24
    Download PDF

    1. API Description

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

    Modify protection object

    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: ModifyObject.
    Version Yes String Common Params. The value used for this API: 2018-01-25.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo.
    ObjectId Yes String Modifies the object identifier
    OpType Yes String Action type. Status: change enabling status; InstanceId: bind to an instance; Proxy: set the proxy status.
    Status No Integer New WAF switch status, considered successful if identical to existing status
    InstanceId No String New instance ID: considered a successful modification if identical to an already bound instance
    Proxy No Integer Whether to enable proxy. 0: do not enable; 1: use the first IP address in XFF as the client IP address; 2: use remote_addr as the client IP address; 3: obtain the client IP address from the specified header field that is given in IpHeaders. (This value is effective when OpType is set to Status or Proxy.)
    IpHeaders.N No Array of String This parameter indicates a custom header and is required when IsCdn is set to 3. (The value is effective when OpType is set to Status or Proxy.)

    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 Modifying the Instance ID

    Input Example

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



{
    "ObjectId": "abc",
    "Status": 0,
    "InstanceId": "abc",
    "OpType": "abc",
    "Proxy": 1,
    "IpHeaders": [
        "abc"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

    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.
    FailedOperation Operation failed.
    InternalError.DBErr DBErr
    LimitExceeded The quota limit is exceeded.
    ResourceNotFound Resources do not exist.
    Contact Us

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

    Contact Us
    Technical Support

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

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy