tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

StopWhiteboardPush

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

    1. API Description

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

    This API is used to stop a whiteboard push 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: StopWhiteboardPush.
    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.
    SdkAppId Yes Integer SdkAppId of the whiteboard application.
    TaskId Yes String ID of the whiteboard push task to be stopped.

    3. Output Parameters

    Parameter Name Type Description
    Backup String Parameters of the backup task.
    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 Stopping a whiteboard push task

    Input Example

    https://tiw.tencentcloudapi.com/?Action=StopWhiteboardPush
&SdkAppId=1400000001
&TaskId=07b4c70bpafm1b4majmb
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Backup": "{\"RequestId\":\"87c334b8-dbf6-4013-8d65-9a9ea60eff27\"}",
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

    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
    InvalidParameter.BodyParameterTypeUnmatched The parameter type does not match.
    InvalidParameter.SdkAppIdNotFound The SdkAppId does not exist or is invalid.
    InvalidParameter.TaskNotFound The task to query does not exist.
    ResourceUnavailable.NotRegistered TIW is not enabled.
    ResourceUnavailable.ServiceExpired The account is in arrears or the TIW service has expired.
    UnauthorizedOperation.SdkAppId The SdkAppId does not exist or does not match the current Tencent Cloud account.
    UnsupportedOperation.TaskHasAlreadyStopped The task is completed, and therefore the specified operation cannot be performed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy