tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeUploadedFiles

Last updated: 2024-11-20 11:15:37

    1. API Description

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

    This API is used to query the list of SQL files imported by users. The common request parameter Region must be ap-shanghai.

    A maximum of 1 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: DescribeUploadedFiles.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-shanghai.
    Path Yes String File path. OwnerUin information of the root account should be entered in this field.
    Offset No Integer Record offset. Default value: 0.
    Limit No Integer Number of results to be returned for a single request. Default value: 20.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible SQL files.
    Items Array of SqlFileInfo List of returned SQL files.
    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 the list of imported SQL files

    Input Example

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

{
    "Path": "100000983328"
}

    Output Example

    {
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "TotalCount": 1,
        "Items": [
            {
                "UploadTime": "2016-11-28 15:16:13",
                "UploadInfo": {
                    "AllSliceNum": 5,
                    "CompleteNum": 3
                },
                "FileName": "joellwang.sql",
                "FileSize": 8581633,
                "IsUploadFinished": 0,
                "FileId": "5596d7433fe211da4b487228db4e7c57"
            }
        ]
    }
}

    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
    AuthFailure CAM signature/authentication error.
    InternalError.CosError Failed to obtain file information.
    InternalError.UnknownError Unknown error
    InvalidParameter Parameter error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy