tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSparkSessionBatchSqlLog

Last updated: 2024-08-08 15:32:03

    1. API Description

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

    This API is used to query Spark SQL batch task logs.

    A maximum of 50 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: DescribeSparkSessionBatchSqlLog.
    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 ID of a Spark SQL job.
    CustomKey No String User-defined primary key. If it is specified, the query should be based on the value.

    3. Output Parameters

    Parameter Name Type Description
    State Integer Status: 0: running; 1: successful; 2: failed; 3: cancellation; 4: timeout
    LogSet Array of SparkSessionBatchLog The log information 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 Spark SQL Batch Task Logs

    This example shows you how to query Spark SQL batch task logs.

    Input Example

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

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

    Output Example

    {
    "Response": {
        "State": 0,
        "LogSet": [
            {
                "Step": "BEG",
                "Time": "2023-03-20 12:12:12",
                "Message": "Cluster name",
                "Operate": [
                    {
                        "Text": "dateEngine-1",
                        "Operate": "COPY",
                        "Supplement": [
                            {
                                "Key": "TASKID",
                                "Value": "d0ds1sad4-9d7e-4f64-a3f4-f385dcs6742"
                            }
                        ]
                    }
                ]
            }
        ],
        "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.BatchSQLTaskNotUnique The specified interactive SQL task is not unique.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy