当前内容仅提供英语版本，中文版我们将尽快补充，感谢您的理解。
文档概览/
ModifyOriginACL/

ModifyOriginACL

1. API Description

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

This API is used to enable or disable specific origin IP ranges for L7 acceleration domains or L4 proxy instances. The maximum quantity for single submission is 200 L7 acceleration domains or 100 L4 proxy instances, with mixed submissions supported up to a total of 200 instances. If changes are needed for submissions exceeding 200 instances, please submit in batches via this interface. Meanwhile, allowlisted customers can switch to other available origin protection IP range versions such as the simplified edition, which can reduce origin IP ranges.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: ModifyOriginACL.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringSpecifies the site ID.
OriginACLEntities.NNoArray of OriginACLEntitySpecifies the instance that needs to configurate origin ACLs.
OriginACLFamilyNoStringThe origin protection back-to-origin ACL control domain remains unchanged by default if left blank. The domain information can be obtained through the DescribeAvailableOriginACLFamily API query.
Valid values are as follows:
  • gaz: Standard global availability zone control domain;
  • mlc: Standard Chinese mainland availability zone control domain;
  • emc: Standard global (exclude Chinese mainland) availability zone control domain;
  • plat-gaz: Simplify global availability zone control domain;
  • plat-mlc: Simplified Chinese mainland availability zone control domain;
  • plat-emc: Simplify the global (excluding Chinese mainland) availability zone control domain;

    • 3. Output Parameters

    Parameter NameTypeDescription
    RequestIdStringThe 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 origin IP range to specify the control domain

    Assign the IP range with control domain gaz to the selected site where ZoneId is 'zone-3ey0mmcs899o' for origin retrieval.

    Input Example

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

{
    "ZoneId": "zone-3ey0mmcs899o",
    "OriginACLFamily": "plat-emc"
}

    Output Example

    {
    "Response": {
        "RequestId": "285f505b-ed21-4efb-86e6-5f05cd6c299c"
    }
}

    Example2 Disabling specific IP range sourcing for L4 proxy instance

    The site closure disables specific IP range back-to-origin for the L4 proxy instance 'sid-19389e5dwwxfs' in ZoneId '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": "7517b2b9-4edd-4f79-baa8-c6938e7f3399"
    }
}

    Example3 Adding new L7 acceleration domain names using specific IP ranges for origin retrieval

    Add a new layer-7 acceleration domain name 'www.qq.com' for the selected site with ZoneId 'zone-276zs184g93m', using specific IP range for origin.

    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": "764fcb13-30a1-4b7c-92a2-f3fa93d5ae3e"
    }
}

    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 CodeDescription
    InternalErrorInternal error.
    InvalidParameterParameter error.
    InvalidParameter.InvalidDomainsThe domain name is illegal. check whether a non-existent domain name is passed in the input parameters.
    InvalidParameter.InvalidProxiesThe layer 4 proxy is illegal. check whether a non-existing proxy is passed in the input parameters.
    InvalidParameter.ShieldNotSupportHostOriginWhitelistThe domain name does not support enabling EdgeOne Shield and origin protection simultaneously.
    OperationDeniedOperation denied.
    OperationDenied.UnsupportedPlanThe package is not supported.
    OperationDenied.UpdateIPWhitelistFirstPlease first update the IP allowlist.