ModifyOriginACL

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

This API is used to enable or disable specific origin ACLs for L7 acceleration domain names or L4 proxy instances. A single submission supports up to 200 L7 acceleration domain names or 100 L4 proxy instances. Hybrid submissions of L7 acceleration domain names and L4 proxy instances are supported, with a maximum total number of instances of 200. If changes are needed for exceeding 200 instances, submit them in batches via this API.

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: ModifyOriginACL.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required.
ZoneId	Yes	String	Specifies the site ID.
OriginACLEntities.N	No	Array of OriginACLEntity	Specifies the instance that needs to configurate origin ACLs.

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 Add New L7 Acceleration Domains Enabling Origin ACLs

This example shows you how to add the L7 acceleration domain 'www.qq.com' under site 'zone-276zs184g93m' enabling origin ACLs.

Input Example

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

{
    "ZoneId": "zone-276zs184g93m",
    "OriginACLEntities": [
        {
            "OperationMode": "enable",
            "Type": "l7",
            "Instances": [
                "www.qq.com"
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "fe0a2b4f-df6d-4d2a-ac39-1706cbf8a868"
    }
}

Example2 Disable Origin ACLs for L4 Proxy Instances

This example shows you how to disable origin ACLs for the L4 proxy instance 'sid-19389e5dwwxfs' under site 'zone-276zs184g93m'.

Input Example

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

{
    "ZoneId": "zone-276zs184g93m",
    "OriginACLEntities": [
        {
            "OperationMode": "disable",
            "Type": "l4",
            "Instances": [
                "sid-19389e5dwwxfs"
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "fe0a2b4f-df6d-4d2a-ac39-1706cbf8a868"
    }
}

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

Tencent Cloud CLI 3.0

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
InternalError	Internal error.
InvalidParameter	Parameter error.
InvalidParameter.InvalidDomains	The domain name is illegal. check whether a non-existent domain name is passed in the input parameters.
InvalidParameter.InvalidProxies	The layer 4 proxy is illegal. check whether a non-existing proxy is passed in the input parameters.
OperationDenied	Operation denied.
OperationDenied.UnsupportedPlan	The package is not supported.
OperationDenied.UpdateIPWhitelistFirst	Please first update the IP allowlist.