DescribeUrlViolations

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-20 10:10:26

Download 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.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

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
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

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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.CdnDbError	Internal data error. Please submit a ticket for troubleshooting.
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.

Recent Pages