tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeZoneConfigImportResult

Last updated: 2024-12-16 16:40:02

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

This API is used to query the results of site configuration import via API (ImportZoneConfig). This feature only supports the sites in the plans of the Standard Edition and the Enterprise Edition.

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: DescribeZoneConfigImportResult.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required.
ZoneId Yes String Zone ID.
TaskId Yes String It indicates the configuration import task ID for which the result needs to be queried. The import task ID is only retained for 7 days.

3. Output Parameters

Parameter Name Type Description
Status String The status of this import task. Valid values:
  • success: It indicates the configuration was successfully imported;
  • failure: It indicates the configuration import failed;
  • doing: It indicates the configuration is being imported.
    		•
    Message String The status message of this import task. If the configuration item import fails, you can view the failure cause through this field.
    Content String The configuration content of this import task.
    ImportTime Timestamp ISO8601 The start time of this import task.
    FinishTime Timestamp ISO8601 The end time of this import task.
    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.

    4. Example

    Example1 Querying Configuration Import Results

    This example shows you how to query the import results of the Layer-7 acceleration configuration item under the site zone-21xfqlh4qjee.

    Input Example

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

{
    "ZoneId": "zone-21xfqlh4qjee",
    "TaskId": "33mz68e4gwka"
}

    Output Example

    {
    "Response": {
        "RequestId": "88215c08-67de-4c7d-974e-a14461816f5b",
        "Status": "success",
        "Message": "success",
        "Content": "{\"FormatVersion\":\"1.0\",\"ZoneConfig\": {\"SmartRouting\": {\"Switch\": \"off\"}, \"Cache\": {\"CustomTime\": {\"Switch\": \"on\", \"CacheTime\": 604800}}, \"MaxAge\": {\"FollowOrigin\": \"on\", \"CacheTime\": 600}, \"CacheKey\": {\"FullURLCache\": \"off\", \"QueryString\": {\"Switch\": \"on\", \"Action\": \"includeCustom\", \"Values\": [\"key1\", \"key2\"]}, \"IgnoreCase\": \"on\"}, \"CachePrefresh\": {\"Switch\": \"off\", \"CacheTimePercent\": 90}, \"OfflineCache\": {\"Switch\": \"on\"}, \"Compression\": {\"Switch\": \"on\", \"Algorithms\": [\"brotli\", \"gzip\"]}, \"ImageOptimize\": {\"Switch\": \"off\"}, \"ForceRedirectHTTPS\": {\"Switch\": \"on\", \"RedirectStatusCode\": 302}, \"HSTS\": {\"Switch\": \"on\", \"IncludeSubDomains\": \"on\", \"Timeout\": 16070400, \"Preload\": \"on\"}, \"TLSConfig\": {\"CipherSuite\": \"loose-v2023\", \"Version\": [\"TLSv1\", \"TLSv1.1\", \"TLSv1.2\", \"TLSv1.3\"]}, \"OCSPStapling\": {\"Switch\": \"off\"}, \"HTTP2\": {\"Switch\": \"on\"}, \"QUIC\": {\"Switch\": \"off\"}, \"UpstreamHTTP2\": {\"Switch\": \"off\"}, \"IPv6\": {\"Switch\": \"off\"}, \"WebSocket\": {\"Switch\": \"on\", \"Timeout\": 30}, \"PostMaxSize\": {\"Switch\": \"on\", \"MaxSize\": 838860800}, \"ClientIPHeader\": {\"Switch\": \"off\", \"HeaderName\": \"\"}, \"ClientIPCountry\": {\"Switch\": \"on\", \"HeaderName\": \"EO-Client-IPCountry\"}, \"gRPC\": {\"Switch\": \"off\"}, \"AccelerateMainland\": {\"Switch\": \"off\"}, \"StandardDebug\": {\"Switch\": \"on\", \"AllowClientIPList\": [\"1.2.3.4\"], \"Expires\": \"2023-11-04T04:46:28Z\"}}, \"Rules\": [{\"RuleName\": \"Unnamed Rule\", \"Branches\": [{\"Condition\": \"${http.request.host} matches \".*\"\", \"Actions\": [{\"Name\": \"UpstreamURLRewrite\", \"Parameters\": {\"Type\": \"Path\", \"Action\": \"rmvPrefix\", \"Value\": \"/prefix\"}}], \"SubRules\": [{\"Branches\": [{\"Condition\": \"${http.request.file_extension} in [\".jpg\"]\", \"Actions\": [{\"Name\": \"PostMaxSize\", \"Parameters\": {\"Switch\": \"on\", \"MaxSize\": 524288000}}]}]}, {\"Branches\": [{\"Condition\": \"${http.request.file_extension} in [\".png\"]\", \"Actions\": [{\"Name\": \"PostMaxSize\", \"Parameters\": {\"Switch\": \"on\", \"MaxSize\": 209715200}}]}]}]}]}]}",
        "ImportTime": "2024-10-13T23:58:00+08:00",
        "FinishTime": "2024-10-13T23:59:00+08:00"
    }
}

    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

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy