tencent cloud

PrevNext

피드백

키워드를 검색하세요

Recent Pages

문서
문서

CancelSparkSessionBatchSQL

마지막 업데이트 시간:2024-08-08 15:32:11

    1. API Description

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

    This API is used to cancel a Spark SQL batch 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: CancelSparkSessionBatchSQL.
    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.
    BatchId Yes String The unique identifier of a batch task.
    CustomKey No String User-defined primary key. If it is specified, the value should be used for querying.

    3. Output Parameters

    Parameter Name Type Description
    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 Canceling a Spark SQL batch task

    This example shows you how to cancel a Spark SQL batch task.

    Input Example

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

{
    "BatchId": "d3018ad4-9a7e-4f64-a3f4-f38507c69742"
}

    Output Example

    {
    "Response": {
        "RequestId": "b8sd7dd7-ekd4-4e5e-993e-e5db64fa21c1"
    }
}

    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.
    InternalError An internal error occurred.
    InternalError.InternalSystemException The business system is abnormal. Please try again or submit a ticket to contact us.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.InvalidSQL SQL parsing failed.
    InvalidParameter.ParameterNotFoundOrBeNone The parameter is not found or empty.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.BatchSQLTaskNotFound The specified interactive SQL task does not exist.
    ResourceNotFound.SessionNotFound The session does not exist.
    ResourceNotFound.SessionStateDead The session has expired.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    개인정보 처리방침서비스 약관쿠키 정책