Obtaining SQL Results
Function
This API is used to obtain results returned after the SQL statements for querying SparkSQL and SparkScript jobs in an MRS cluster are executed.
Constraints
None
Debugging
You can debug this API through automatic authentication in API Explorer. API Explorer can automatically generate sample SDK code and provide the sample SDK code debugging.
URI
- Format
GET /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}/sql-result
- Parameter description
Table 1 URI parameters Parameter
Mandatory
Type
Description
project_id
Yes
String
The project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
cluster_id
Yes
String
The cluster ID. For details about how to obtain the cluster ID, see Obtaining a Cluster ID.
job_execution_id
Yes
String
The job ID. For details about how to obtain the job ID, see Obtaining a Job ID.
Request Parameters
Request parameters
None
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
sql-results |
Object |
The query results of a SQL statement. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
The error code. |
error_msg |
String |
The error message. |
Example
- Example request
GET https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}/sql-result
- Example response
- Example of a successful response
{ "sql_results": { "0": [{ "result": "succeed" }], "1": [{ "database": "default", "isTemporary": "false", "tableName": "src_wordcount" }], "2": [{ "result": "succeed" }], "3": [{ "result": "succeed" }], "4": [{ "name": "a", "id": "1" }, { "name": "b", "id": "2" }] } }
- Example of a failed response
{ "error_msg": "Failed to collect SQL job results." "error_code":"0172" }
- Example of a successful response
Status Codes
See Status Codes.
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.