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.
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. |
| OriginACLFamily | No | String | The 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: |
| 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. |
Assign the IP range with control domain gaz to the selected site where ZoneId is 'zone-3ey0mmcs899o' for origin retrieval.
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"
}
{
"Response": {
"RequestId": "285f505b-ed21-4efb-86e6-5f05cd6c299c"
}
}
The site closure disables specific IP range back-to-origin for the L4 proxy instance 'sid-19389e5dwwxfs' in ZoneId 'zone-276zs184g93m'.
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"
]
}
]
}
{
"Response": {
"RequestId": "7517b2b9-4edd-4f79-baa8-c6938e7f3399"
}
}
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.
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"
]
}
]
}
{
"Response": {
"RequestId": "764fcb13-30a1-4b7c-92a2-f3fa93d5ae3e"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| InvalidParameter.ShieldNotSupportHostOriginWhitelist | The domain name does not support enabling EdgeOne Shield and origin protection simultaneously. |
| OperationDenied | Operation denied. |
| OperationDenied.UnsupportedPlan | The package is not supported. |
| OperationDenied.UpdateIPWhitelistFirst | Please first update the IP allowlist. |
文档反馈