製品アップデート情報
Domain name for API request: cdn.intl.tencentcloudapi.com.
This API is used to query the record and progress of URL or directory purge tasks submitted via the PurgePathCache or PurgeUrlsCache APIs.
A maximum of 20 requests can be initiated per second for this API.
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: DescribePurgeTasks. |
| Version | Yes | String | Common Params. The value used for this API: 2018-06-06. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| PurgeType | No | String | Specifies a purge type:url: URL purge recordpath: Directory purge record |
| StartTime | No | Timestamp | Specifies the starting time of the period you want to query, such as 2018-08-08 00:00:00 |
| EndTime | No | Timestamp | Specifies the end time of the period you want to query, such as 2018-08-08 23:59:59 |
| TaskId | No | String | Specifies a task ID when you want to query by task ID. You must specify either a task ID or a starting time for your query. |
| Offset | No | Integer | Offset for paginated queries. Default value: 0 |
| Limit | No | Integer | Limit on paginated queries. Default value: 20 |
| Keyword | No | String | You can filter the results by domain name or a complete URL beginning with http(s):// |
| Status | No | String | Specifies a task state for your query:fail: purge faileddone: purge succeededprocess: purge in progress |
| Area | No | String | Specifies a purge region for your query:mainland: within Mainland Chinaoverseas: outside Mainland Chinaglobal: global |
| Parameter Name | Type | Description |
|---|---|---|
| PurgeLogs | Array of PurgeTask | Detailed purge record. Note: This field may return null, indicating that no valid value can be obtained. |
| TotalCount | Integer | Total number of tasks, which is used for pagination. Note: This field may return null, indicating that no valid value 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. |
https://cdn.intl.tencentcloudapi.com/?Action=DescribePurgeTasks
&TaskId=1234567
&Area=mainland
&<Common request parameters>{
"Response": {
"RequestId": "4d5a83f8-a61f-445b-8036-5636be640bef",
"PurgeLogs": [
{
"TaskId": "153303185323131331",
"Url": "http://www.test.com/",
"Status": "Done",
"PurgeType": "url",
"FlushType": "flush",
"CreateTime": "2018-07-30 18:10:53"
}
],
"TotalCount": 1
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.CamSystemError | Authentication system internal error. |
| InternalError.CdnDbError | Internal data error. Please submit a ticket for troubleshooting. |
| InternalError.CdnQuerySystemError | Internal error. Please try again or contact the customer service for assistance. |
| InternalError.CdnSystemError | System error. Please submit a ticket for troubleshooting. |
| InternalError.Error | Service internal error. Please submit a ticket for troubleshooting. |
| InternalError.ProxyServer | Internal service error. Please submit a ticket for troubleshooting. |
| InternalError.RouteError | Internal service error. Please submit a ticket for troubleshooting. |
| InternalError.UnknownError | Internal service error. Please submit a ticket for troubleshooting. |
| InvalidParameter.CdnParamError | Parameter error. Please see the sample parameters in the documentation. |
| ResourceNotFound.CdnUserNotExists | The CDN service has not been activated. Please activate it first before using this API. |
| UnauthorizedOperation.CdnCamUnauthorized | No CAM policy is configured for the sub-account. |
| UnauthorizedOperation.OpNoAuth | This operation is not supported currently. Please submit a ticket for assistance. |
| UnauthorizedOperation.OperationTooOften | Too many calling attempts. |
フィードバック