DescribeOriginProtection
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to query the origin protection configuration.
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: DescribeOriginProtection. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneIds.N | No | Array of String | Set of site IDs to be queried. This is a required parameter. |
| Filters.N | No | Array of Filter | Filter conditions. Each filter condition can have up to 20 entries. See below for details:need-update:Whether the intermediate IP update is needed for the site. Type: String Required: No Values: true: Update needed.false: Update not needed.plan-support:Whether origin protection is supported in the plan. Type: String Required: No Values: true: Origin protection supported.false: Origin protection not supported. |
| Offset | No | Integer | Offset for paginated queries. Default value: 0. |
| Limit | No | Integer | Limit on paginated queries. Default value: 20. Maximum value: 1000. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| OriginProtectionInfo | Array of OriginProtectionInfo | Origin protection configuration. Note: This field may return null, indicating that no valid values can be obtained. |
| 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 The following example shows you how to query the origin protection configuration.
The following example shows you how to query the origin protection configuration.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOriginProtection
<Common request parameters>
{
"ZoneIds": [
"zone-276zs184g93m"
],
"Filters": [
{
"Values": [
"true"
],
"Name": "need-update"
}
],
"Offset": 0,
"Limit": 20
}
Output Example
{
"Response": {
"RequestId": "de0a2b4f-df6d-4d2a-ac39-1706cbf8a797",
"OriginProtectionInfo": [
{
"ZoneId": "zone-276zs184g93m",
"Hosts": [
"www.qq.com"
],
"ProxyIds": [
"proxy-19389e5dwwxfs"
],
"CurrentIPWhitelist": {
"IPv4": [
"11.11.11.11/24"
],
"IPv6": [
"2001:980:7002:6::/64"
]
},
"NeedUpdate": true,
"Status": "online",
"PlanSupport": true,
"DiffIPWhitelist": {
"LatestIPWhitelist": {
"IPv4": [
"11.11.11.11/24",
"22.22.22.22/24"
],
"IPv6": [
"2001:980:7002:6::/64"
]
},
"AddedIPWhitelist": {
"IPv4": [
"22.22.22.22/24"
],
"IPv6": []
},
"RemovedIPWhitelist": {
"IPv4": [],
"IPv6": []
},
"NoChangeIPWhitelist": {
"IPv4": [
"11.11.11.11/24"
],
"IPv6": [
"2001:980:7002:6::/64"
]
}
}
}
]
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
| UnauthorizedOperation.NoPermission | The sub-account is not authorized for the operation. Please get permissions first. |
| UnauthorizedOperation.Unknown | An unknown error occurred in the backend server. |