tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

PushUrlsCache

Last updated: 2023-12-01 16:39:48

    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 1000 URLs can be prefetched per day for regions either within or outside the Chinese mainland, and up to 500 tasks can be submitted at a time. Note that resources prefetched outside the Chinese mainland will be cached to CDN nodes outside the Chinese mainland and the traffic generated will incur costs.

    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: PushUrlsCache.
    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.
    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.
    Layer No String By default, prefetch for regions in the Chinese mainland is performed onto the intermediate nodes, while prefetch for regions outside the Chinese mainland is performed onto the edge nodes and the traffic generated will be billed.
    If this parameter is middle or left empty, prefetch will be performed onto the intermediate node.
    ParseM3U8 No Boolean Whether to recursively resolve the M3U8 index file and prefetch the TS shards in it.
    Notes:
    1. This feature requires that the M3U8 index file can be directly requested and obtained.
    2. In the M3U8 index file, currently only the TS shards at the first to the third level can be recursively resolved.
    3. Prefetching the TS shards obtained through recursive resolution consumes the daily prefetch quota. If the usage exceeds the quota, the feature will be disabled and TS shards will not be prefetched.
    DisableRange No Boolean Specifies whether to disable Range GETs.
    Notes:
    This feature is in beta test.
    Headers.N No Array of HTTPHeader Custom HTTP request headers (Up to 20). Name: Up to 128 characters. Value: Up to 1024 characters.
    UrlEncode No Boolean Whether to encode the URL

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

    Example1 Prefetching URLs

    Input Example

    POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PushUrlsCache
<Common request parameters>

{
    "Urls": [
        "http://www.test.com/1.jpg"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "123",
        "TaskId": "15475444535871929928456"
    }
}

    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.CdnConfigError Failed to update the domain name configuration.
    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.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 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.CdnHostIsLocked The domain name is locked.
    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.CdnHostUnauthorized The sub-account has no access to the CDN-accelerated domain name.
    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.EcdnMigratedCdn Please go to the CDN console for operation.
    UnauthorizedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.
    UnauthorizedOperation.OperationTooOften Too many calling attempts.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy