tencent cloud

Feedback

DescribePushTasks

Last updated: 2022-08-25 10:14:28

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.

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 Params. The value used for this API: DescribePushTasks.
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.
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 paginated queries. Default value: 20
Area No String Specifies a region for your query:
mainland: Chinese mainland
overseas: Outside the Chinese mainland
global: Globe
Status No String Queries the status of a specified task
fail: Prefetch failed
done: Prefetch succeeded
process: Prefetch in progress
invalid: Invalid prefetch with 4XX/5XX status code returned from the origin server

3. Output Parameters

Parameter Name Type Description
PushLogs Array of PushTask Prefetch history
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, 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 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
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.
InvalidParameter.CdnHostInvalidParam Invalid domain name format. Please check and try again.
InvalidParameter.CdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
InvalidParameter.CdnStatInvalidDate Invalid date. Please see the sample date in the documentation.
InvalidParameter.CdnStatInvalidMetric Invalid statistical type. Please see the sample statistical analysis in the documentation.
InvalidParameter.CdnStatInvalidProjectId Incorrect project ID. Please check and try again.
LimitExceeded.CdnHostOpTooOften Domain name operations are too frequent.
ResourceNotFound.CdnHostNotExists Unable to find the domain name. Please make sure the domain name is correct.
ResourceNotFound.CdnUserNotExists The CDN service has not been activated. Please activate it first before using this API.
ResourceUnavailable.CdnHostIsNotOnline The domain name has been deactivated. Prefetch requests cannot be submitted.
UnauthorizedOperation.CdnCamUnauthorized No CAM policy is configured for the sub-account.
UnauthorizedOperation.CdnUserAuthFail Fail to authenticate the CDN user.
UnauthorizedOperation.CdnUserAuthWait The CDN user is pending authentication.
UnauthorizedOperation.CdnUserIsSuspended The CDN service has been suspended. Please restart it and try again.
UnauthorizedOperation.CdnUserNoWhitelist You are not in the beta whitelist and thus have no permission to use this function.
UnauthorizedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.
UnauthorizedOperation.OperationTooOften Too many calling attempts.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support