违规历史查询

最近更新时间:2024-03-12 01:14:40

我的收藏

1. 接口描述

接口请求域名: cdn.tencentcloudapi.com 。

DescribeUrlViolations 用于查询被 CDN 系统扫描到的域名违规 URL 列表及当前状态。
对应内容分发网络控制台【图片鉴黄】页面。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUrlViolations。
Version String 公共参数,本接口取值:2018-06-06。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 分页查询偏移量,默认为 0
示例值:0
Limit Integer 分页查询限制数目,默认为 100
示例值:1
Domains.N Array of String 指定的域名查询

3. 输出参数

参数名称 类型 描述
UrlRecordList Array of ViolationUrl 违规 URL 详情
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 记录总数,用于分页
示例值:10
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 违规历史查询

输入示例

https://cdn.tencentcloudapi.com/?Action=DescribeUrlViolations
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "ptplrss8qqf9x7534noql6",
        "UrlRecordList": [
            {
                "Id": 2256186,
                "RealUrl": "http://www.test.com/a.jpeg",
                "DownloadUrl": "2019-11-18/2019-11-18-18-26-08-1794844604-29-21-a.jpeg",
                "UrlStatus": "forbid",
                "CreateTime": "2019-11-17 18:25:47",
                "UpdateTime": "2019-11-18 18:06:47"
            }
        ],
        "TotalCount": 10
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
ResourceNotFound.CdnHostNotExists 未查询到该域名,请确认域名是否正确。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
UnauthorizedOperation.CdnAccountUnauthorized 子账号禁止查询整体数据。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.CdnHostUnauthorized CDN子账号加速域名未授权。
UnauthorizedOperation.CdnProjectUnauthorized 子账号项目未授权。
UnauthorizedOperation.OperationTooOften 操作超出调用频次限制。