Domain name for API request: dlc.tencentcloudapi.com.
This API is used to submit a Spark SQL batch task to the job engine.
A maximum of 20 requests can be initiated per second for this API.
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: CreateSparkSessionBatchSQL. |
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. |
DataEngineName | Yes | String | The name of the engine for executing the Spark job. |
ExecuteSQL | Yes | String | The SQL statement to execute. |
DriverSize | No | String | The driver size. Valid values: small (default, 1 CU), medium (2 CUs), large (4 CUs), and xlarge (8 CUs). |
ExecutorSize | No | String | The executor size. Valid values: small (default, 1 CU), medium (2 CUs), large (4 CUs), and xlarge (8 CUs). |
ExecutorNumbers | No | Integer | The executor count, which defaults to 1. |
ExecutorMaxNumbers | No | Integer | The maximum executor count, which defaults to 1. This parameter applies if the "Dynamic" mode is selected. If the "Dynamic" mode is not selected, the value of this parameter is the same as that of ExecutorNumbers . |
TimeoutInSecond | No | Integer | The session timeout period in seconds. Default value: 3600 |
SessionId | No | String | The unique ID of a session. If this parameter is specified, the task will be run using the specified session. |
SessionName | No | String | The name of the session to create. |
Arguments.N | No | Array of KVPair | The session configurations. Valid values: 1.dlc.eni for user-defined ENI gateway information;2.dlc.role.arn for user-defined roleArn configurations;and 3.dlc.sql.set.config for user-defined cluster configurations. |
IsInherit | No | Integer | Whether to inherit the resource configurations from the cluster. Valid values: 0 for no (default) and 1 for yes. |
Parameter Name | Type | Description |
---|---|---|
BatchId | String | The unique identifier of a batch task. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to submit a Spark SQL batch task to the Spark job engine.
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSparkSessionBatchSQL
<Common request parameters>
{
"DataEngineName": "data_engine_1",
"ExecuteSQL": "select 1",
"DriverSize": "small",
"ExecutorSize": "small",
"ExecutorNumbers": 1,
"ExecutorMaxNumbers": 1,
"TimeoutInSecond": 2,
"SessionId": "",
"SessionName": "livy-session-123",
"Arguments": [
{
"Value": "eni",
"Key": "test_eni"
}
]
}
{
"Response": {
"RequestId": "b8sd7dd7-ekd4-4e5e-993e-e5db64fa21c1",
"BatchId": "d3018ad4-9a7e-4f64-a3f4-f38507c69742"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
InvalidParameter | The parameter is incorrect. |
InvalidParameter.InvalidSQL | SQL parsing failed. |
ResourceNotFound | The resource does not exist. |
ResourceNotFound.ResourceNotFoundCode_SessionInsufficientResources | No resources are available to create a session currently. Please try again later or use a monthly subscription cluster. |
ResourceNotFound.SessionNotFound | The session does not exist. |
ResourceNotFound.SessionStateDead | The session has expired. |
本页内容是否解决了您的问题?