Help & DocumentationContent Delivery NetworkAPI Documentation Content Management APIsDescribeUrlViolations

DescribeUrlViolations

Last updated: 2020-03-16 17:17:57

PDF

1. API Description

Domain name for API request: cdn.tencentcloudapi.com.

This API is used to query the list of domain name URLs containing regulation-violating content scanned and detected by the CDN system, and the current status of the URLs.
It corresponds to the Pornography Detection page on the CDN Console.

A maximum of 20 requests can be initiated per second for this API.

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 parameter. The value used for this API: DescribeUrlViolations.
Version Yes String Common parameter. The value used for this API: 2018-06-06.
Region No String Common parameter. This parameter is not required for this API.
Offset No Integer Offset for paginated queries. Default value: 0 (the first page).
Limit No Integer Limit on paginated queries. Default value: 100.
Domains.N No Array of String Specified domain name query

3. Output Parameters

Parameter Name Type Description
UrlRecordList Array of ViolationUrl Details of URLs in violation
Note: this field may return null, indicating that no valid values can be obtained.
TotalCount Integer Total number of records, which is used for pagination.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying violation history

Input Example

https://cdn.tencentcloudapi.com/?Action=DescribeUrlViolations
&<Common request parameters>

Output Example

{
  "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. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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 Code Description
InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
ResourceNotFound.CdnHostNotExists This domain name does not exist under the account. Please check and try again.
ResourceNotFound.CdnUserNotExists The CDN service has not been activated. Please activate it first before using this API.
UnauthorizedOperation.CdnAccountUnauthorized The sub-account is unauthorized to query full data.
UnauthorizedOperation.CdnCamUnauthorized No CAM policy is configured for the sub-account.
UnauthorizedOperation.CdnHostUnauthorized The sub-account has no access to the CDN-accelerated domain name.
UnauthorizedOperation.CdnProjectUnauthorized The sub-account has no access to the project.