PushUrlsCache

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

PDF

1. API Description

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

This API is used to cache specified URL resources to CDN nodes. You can specify acceleration regions for the prefetch.
By default, a maximum of 1,000 URLs can be prefetched per day either within or outside Mainland China, and up to 20 tasks can be submitted at a time.
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.

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: PushUrlsCache.
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.
Urls.N Yes Array of String List of URLs. The protocol header such as "http://" or "https://" needs to be included.
UserAgent No String Specifies the User-Agent header of an HTTP prefetch request when it is forwarded to the origin server
Default value: TencentCdn
Area No String Destination region for the prefetch
mainland: prefetches resources to nodes within Mainland China
overseas: prefetches resources to nodes outside Mainland China
global: prefetches resources to global nodes
Default value: mainland. You can prefetch a URL to nodes in a region provided that CDN service has been enabled for the domain name in the URL in the region.

3. Output Parameters

Parameter Name Type Description
TaskId String ID of the submitted task
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

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

5. 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.
InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnHostInvalidMiddleConfig Incorrect intermediate server configuration.
InvalidParameter.CdnHostInvalidParam Invalid domain name format. Please check and try again.
InvalidParameter.CdnHostInvalidStatus Invalid domain name status.
InvalidParameter.CdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
InvalidParameter.CdnPushWildcardNotAllowed Prefetch does not support wildcard domain names.
InvalidParameter.CdnStatInvalidDate Invalid date. Please see the sample date in the documentation.
InvalidParameter.CdnStatInvalidProjectId Incorrect project ID. Please check and try again.
LimitExceeded.CdnHostOpTooOften Domain name operations are too frequent.
LimitExceeded.CdnPushExceedBatchLimit The number of URLs to be prefetched at a time exceeds the limit.
LimitExceeded.CdnPushExceedDayLimit The number of URLs to be prefetched exceeds the daily limit.
ResourceInUse.CdnOpInProgress CDN resources are being operated.
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.
ResourceUnavailable.CdnHostIsLocked The domain name is locked.
ResourceUnavailable.CdnHostIsNotOnline The domain name has been deactivated. Prefetch requests cannot be submitted.
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.