Use GetSqlStatement to retrieve SQL statement details - E-MapReduce

Retrieves the details of an SQL query.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

emr-serverless-spark:GetSqlStatement

none

*All Resource

*

None

Request syntax

GET /api/interactive/v1/workspace/{workspaceId}/statement/{statementId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	No	The workspace ID.	w-d2d82aa09155****
statementId	string	No	The statement ID.	st-2dadfhajk11cv****

Request parameters

Parameter	Type	Required	Description	Example
regionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
data	object	The returned data.
statementId	string	The statement ID.	st-1231311abadfaa
state	string	The state of the query. Valid values: running : running available : available cancelled : cancelled error : error cancelling : cancelling	running
sqlOutputs	array<object>	A list of SQL query results.
	object	A single SQL query result.
rows	string	The query data. The data is a JSON-serialized string.	[{\"values\":[\"test_db\",\"test_table\",false]}
schema	string	The details of the schema. The details are a JSON-serialized string.	{\"type\":\"struct\",\"fields\":[{\"name\":\"namespace\",\"type\":\"string\",\"nullable\":false,\"metadata\":{}},{\"name\":\"tableName\",\"type\":\"string\",\"nullable\":false,\"metadata\":{}},{\"name\":\"isTemporary\",\"type\":\"boolean\",\"nullable\":false,\"metadata\":{}}]}
rowsFilePath	string
sqlErrorCode	string	The error code for the SQL query.	ERROR-102
sqlErrorMessage	string	The error message for the SQL query.	error message
executionTime	array	A list of execution times for the SQL query.
	integer	The time consumed by each SQL query, in milliseconds.	1717138731701
requestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****

Examples

Success response

JSON format

{
  "data": {
    "statementId": "st-1231311abadfaa",
    "state": "running",
    "sqlOutputs": [
      {
        "rows": "[{\\\"values\\\":[\\\"test_db\\\",\\\"test_table\\\",false]}",
        "schema": "{\\\"type\\\":\\\"struct\\\",\\\"fields\\\":[{\\\"name\\\":\\\"namespace\\\",\\\"type\\\":\\\"string\\\",\\\"nullable\\\":false,\\\"metadata\\\":{}},{\\\"name\\\":\\\"tableName\\\",\\\"type\\\":\\\"string\\\",\\\"nullable\\\":false,\\\"metadata\\\":{}},{\\\"name\\\":\\\"isTemporary\\\",\\\"type\\\":\\\"boolean\\\",\\\"nullable\\\":false,\\\"metadata\\\":{}}]}",
        "rowsFilePath": ""
      }
    ],
    "sqlErrorCode": "ERROR-102",
    "sqlErrorMessage": "error message",
    "executionTime": [
      1717138731701
    ]
  },
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.