Overview
Strengths
Use Cases
Domain name for API request: dlc.intl.tencentcloudapi.com.
This API is used to query the list of Spark jobs.
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: DescribeSparkAppJobs. |
| 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. |
| SortBy | No | String | The returned results are sorted by this field. |
| Sorting | No | String | Descending or ascending order, such as desc. |
| Filters.N | No | Array of Filter | The filters. The following types are supported, and Name of the parameter passed in must be one of them: spark-job-name (job name), spark-job-id (job ID), spark-app-type (job type: 1 for batch, 2 for streaming, and 4 for SQL), user-name (creator), and key-word (job name or ID keywords for fuzzy search). |
| StartTime | No | String | The update start time in the format of yyyy-mm-dd HH:MM:SS. |
| EndTime | No | String | The update end time in the format of yyyy-mm-dd HH:MM:SS. |
| Offset | No | Integer | The query list offset, which defaults to 0. |
| Limit | No | Integer | The maximum number of queries allowed in the list, which defaults to 100. |
| Parameter Name | Type | Description |
|---|---|---|
| SparkAppJobs | Array of SparkJobInfo | Detailed list of Spark jobs |
| TotalCount | Integer | Total number of Spark jobs |
| 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. |
This example shows you how to query the list of Spark jobs.
POST / HTTP/1.1
Host: dlc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action:DescribeSparkAppJobs
<Common request parameters>
{
"Sorting": "desc",
"SortBy": "create-time",
"StartTime": "2022-01-01 00:00:00",
"EndTime": "2022-01-01 00:00:00",
"Filters": [
{
"Values": [
"value"
],
"Name": "key"
}
],
"Offset": 0,
"Limit": 10
}{
"Response": {
"RequestId": "2ae4707a-9f72-44aa-9fd4-65cb739d6301",
"SparkAppJobs": [],
"TotalCount": 0
}
}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. |
| 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.InvalidTimeFormat | The specified time format is not compliant. Currently, only YYYY-mm-dd HH:MM:SS is supported. |
| InvalidParameter.SparkJobFiltersKeyTypeNotMath | The specified Spark task Filter.Key does not match. Currently, only spark-app-type/user-name/spark-job-name/spark-job-id/key-word is supported. |
| InvalidParameter.SparkJobSortByTypeNotMatch | The specified Spark task sorting type does not match. Currently, only create-time/update-time/user-name/data-engine-name is supported. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.BatchSQLTaskNotFound | The specified interactive SQL task does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback