tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeResultDownload

Last updated: 2023-09-19 11:26:19

1. API Description

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

This API is used to get a query result download task.

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: DescribeResultDownload.
Version Yes String Common Params. The value used for this API: 2021-01-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DownloadId Yes String The query task ID.

3. Output Parameters

Parameter Name Type Description
Path String The file save path.
Note: This field may return null, indicating that no valid values can be obtained.
Status String The task status. Valid values: init, queue, format, compress, success, timeout, and error.
Reason String The task exception cause.
Note: This field may return null, indicating that no valid values can be obtained.
SecretId String The temporary secret ID.
Note: This field may return null, indicating that no valid values can be obtained.
SecretKey String The temporary secret key.
Note: This field may return null, indicating that no valid values can be obtained.
Token String The temporary token.
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 Example 1

Input Example

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

{
    "DownloadId": "xx"
}

Output Example

{
    "Response": {
        "Status": "xx",
        "Token": "xx",
        "SecretKey": "xx",
        "Reason": "xx",
        "SecretId": "xx",
        "RequestId": "xx",
        "Path": "xx"
    }
}

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
FailedOperation The operation failed.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy