tencent cloud

Feedback

CreateSparkAppTask

Last updated: 2023-09-19 11:26:20

1. API Description

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

This API is used to start a Spark job.

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: CreateSparkAppTask.
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.
JobName Yes String Spark job name
CmdArgs No String The input parameters of the Spark job, separated by space. They are generally used for periodic calls.

3. Output Parameters

Parameter Name Type Description
BatchId String Batch ID
TaskId String Task ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Starting a Spark job

This example shows you how to start a Spark job.

Input Example

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

{
    "JobName": "spark-app-test",
    "CmdArgs": "10 test 20"
}

Output Example

{
    "Response": {
        "RequestId": "2ae4707a-9f72-44aa-9fd4-65cb739d6301",
        "BatchId": "batch-9vsx3lh0",
        "TaskId": "4a7cad6bb86211ec9c616e6f30623d72"
    }
}

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.
InvalidParameter.InvalidRoleArn The CAM role arn is invalid.
InvalidParameter.InvalidSparkAppParam The SparkAppParam is invalid.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation.UseComputingEngine The sub-user does not have permission to use the compute engine.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support