DescribePushTasks

Last updated: 2021-03-19 16:45:21

1. API Description

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

This API is used to query the submission record and progress of prefetch tasks.
This API is in beta test and not fully available yet. Please stay tuned.

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.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribePushTasks.
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.
StartTime No Timestamp Starting time, such as 2018-08-08 00:00:00
EndTime No Timestamp End time, such as 2018-08-08 23:59:59
TaskId No String Specifies a task ID for your query.
You must specify either a task ID or a starting time.
Keyword No String Specifies a keyword for your query. Please enter a domain name or a complete URL beginning with http(s)://
Offset No Integer Offset for paginated queries. Default value: 0
Limit No Integer Limit on paged queries. Default value: 20
Area No String Specifies a region for your query:
mainland: within Mainland China
overseas: outside Mainland China
global: global
Status No String Specifies a task state for your query:
fail: prefetch failed
done: prefetch succeeded
process: prefetch in progress

3. Output Parameters

Parameter Name Type Description
PushLogs Array of PushTask Prefetch history
Note: This field may return null, indicating that no valid values can be obtained.
TotalCount Integer Total number of tasks, which is used for pagination.
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying prefetch history

Input Example

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

Output Example

{
  "Response": {
    "RequestId": "4d5a83f8-a61f-445b-8036-5636be640bef",
    "PushLogs": [
      {
        "TaskId": "1533031853231313311",
        "Url": "http://www.test.com/",
        "Status": "Done",
        "Percent": 100,
        "CreateTime": "2018-07-30 18:10:53",
        "Area": "mainland"
      }
    ],
    "TotalCount": 20
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various progra