1. 接口描述
接口请求域名： teo.tencentcloudapi.com 。
查询源站防护信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeOriginProtection。 |
| Version | 是 | String | 公共参数，本接口取值：2022-09-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ZoneIds.N | 否 | Array of String | 查询的站点ID集合。该参数必填。 |
| Filters.N | 否 | Array of Filter | 过滤条件，Filters.Values的上限为20。详细的过滤条件如下： 按照【站点是否需要更新源站防护IP白名单】进行过滤。 类型：String 必选：否 可选项： true：需要更新 false：无需更新 按照【站点套餐是否支持源站防护】进行过滤。 类型：String 必选：否 可选项： true：支持 false：不支持 |
| Offset | 否 | Integer | 分页查询偏移量，默认为0。 |
| Limit | 否 | Integer | 分页查询限制数目。默认值：20，最大值：1000。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| OriginProtectionInfo | Array of OriginProtectionInfo | 源站防护信息。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询源站防护信息
查询源站防护信息
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOriginProtection
<公共请求参数>
{
"ZoneIds": [
"zone-276zs184g93m"
],
"Filters": [
{
"Values": [
"true"
],
"Name": "need-update"
}
],
"Offset": 0,
"Limit": 20
}输出示例
{
"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. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |
| UnauthorizedOperation.NoPermission | 子账户没有操作权限，请添加权限后继续操作。 |
| UnauthorizedOperation.Unknown | 后端服务器发生未知错误。 |
