tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSnapshotTask

Last updated: 2023-12-07 10:46:26

    1. API Description

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

    This API is used to query the information about a whiteboard snapshot 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: DescribeSnapshotTask.
    Version Yes String Common Params. The value used for this API: 2019-09-19.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore.
    TaskID Yes String ID of the query task.
    SdkAppId Yes Integer SdkAppId of the task.

    3. Output Parameters

    Parameter Name Type Description
    TaskID String Task ID.
    Note: This parameter may return null, indicating that no valid values can be obtained.
    Status String Task status.
    Running: The task is running.
    Finished: The task is finished.
    Note: This parameter may return null, indicating that no valid values can be obtained.
    CreateTime Integer Creation time of the task. Unit: seconds.
    Note: This parameter may return null, indicating that no valid values can be obtained.
    FinishTime Integer Completion time of the task. Unit: seconds.
    Note: This parameter may return null, indicating that no valid values can be obtained.
    Result SnapshotResult Task result information.
    Note: This parameter 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 Querying the information about a task

    Input Example

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

{
    "SdkAppId": 1400127230,
    "TaskID": "f2e1728c-6e87-4481-abe1-cde8542a5a10"
}

    Output Example

    {
    "Response": {
        "CreateTime": 1626249427,
        "FinishTime": 1626250455,
        "RequestId": "38d75752-85e0-4931-9837-d41be5409a0a",
        "Result": {
            "ErrorCode": "OK",
            "ErrorMessage": "",
            "Snapshots": [
                "http://tiw-snapshot-1259648581.cos.ap-guangzhou.myqcloud.com/880520/f2e1728c-6e87-4481-abe1-cde8542a5a10/53255368873480.png",
                "http://tiw-snapshot-1259648581.cos.ap-guangzhou.myqcloud.com/880520/f2e1728c-6e87-4481-abe1-cde8542a5a10/53255373174978.png",
                "http://tiw-snapshot-1259648581.cos.ap-guangzhou.myqcloud.com/880520/f2e1728c-6e87-4481-abe1-cde8542a5a10/53255375472670.png"
            ],
            "Total": 3
        },
        "Status": "Finished",
        "TaskID": "f2e1728c-6e87-4481-abe1-cde8542a5a10"
    }
}

    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
    InternalError Internal error.
    InvalidParameter A parameter error occurred.
    RequestLimitExceeded Too many requests.
    ResourceUnavailable The resource is unavailable.
    ResourceUnavailable.NotRegistered TIW is not enabled.
    ResourceUnavailable.ServiceExpired The account is in arrears or the TIW service has expired.
    UnauthorizedOperation Unauthorized operation.
    UnauthorizedOperation.SdkAppId The SdkAppId does not exist or does not match the current Tencent Cloud account.
    UnknownParameter Unknown parameter error.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy