tencent cloud

APIs

DescribeLogDownloadTasks

포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-12-03 10:42:05

1. API Description

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

This API is used to query a log 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: DescribeLogDownloadTasks.
Version Yes String Common Params. The value used for this API: 2019-07-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID.
Limit No Integer Number of queries.
Offset No Integer Page number.
StartTime No String Start time of the download task.
EndTime No String End time of the download task.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Quantity.
Tasks Array of Task Task list.
Note: This field may return null, indicating that no valid values can be obtained.
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 a Log Download Task

This example shows you how to query a log download task.

Input Example

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

{
    "InstanceId": "cmgo-k2p5su09",
    "StartTime": "2024-03-07 9:22:15",
    "EndTime": "2024-03-07 15:33:15"
}

Output Example

{
    "Response": {
        "RequestId": "832423fdfsfsd-312jdsf",
        "Tasks": [
            {
                "CreateTime": "2024-03-07 21:01:00",
                "FileSize": 372432,
                "Percent": 100,
                "Status": 2,
                "TaskId": "export-28439fb3-90a6-4ca2-bd2f-ad99e99a14e9",
                "TaskType": 0,
                "UpdateTime": "2024-03-07 21:14:02",
                "Url": ""
            }
        ],
        "TotalCount": 1
    }
}

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 Internal error
InvalidParameterValue.NotFoundInstance The instance was not found.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백