Help Center/ MapReduce Service/ API Reference (Kuala Lumpur Region)/ API V2/ SQL APIs/ Querying SQL Results
Updated on 2022-12-08 GMT+08:00
View PDF
Share

Querying SQL Results

Function

This API is used to query the execution result of an SQL statement in the MRS cluster.

URI

  • Format

    GET /v2/{project_id}/clusters/{cluster_id}/sql-execution/{sql_id}

  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.

    cluster_id

    Yes

    Cluster ID. For details on how to obtain the cluster ID, see Obtaining a Cluster ID.

    sql_id

    Yes

    SQL execution ID, that is, sql_id in the return result in Submitting an SQL Statement.

Request

Request parameters

None.

Response

Table 2 Response parameters

Parameter

Type

Description

id

String

SQL ID

message

String

Error message

statement

String

Executed SQL statement

status

String

SQL execution status

  • QUEUED
  • WAITING_FOR_RESOURCES
  • PLANNING
  • STARTING
  • RUNNING
  • FINISHING
  • FINISHED
  • FAILED

result_location

String

Path for archiving the final results of the SQL query statement

NOTE:

Only the SELECT statement dumps the SQL execution results to result_location.

content

Array

SQL execution result

NOTE:

Only non-SELECT statements return results in content. If the SQL statement does not return results, content is empty.

Example

  • Example request 
    GET https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/sql-execution/{sql_id}
  • Example response
    • Example of a successful response 
      {
    "id":"20190909_011820_00151_xxxxx ", 
    "statement":"show tables",
    "status":"FINISHED",
    "result_location":" obs://my_bucket/uuid_date/xxxx.csv",  
    "content":[
       ["t1"],["t2"],["t3"]   
      ] 
 }
    • Example of a failed response 
      { 
  "error_code" : "MRS.0011", 
  "message": "Failed to submit SQL to the executor. The cluster ID is xxxx"
}

Status Code

For details about status codes, see Status Codes.

Parent topic: SQL APIs