GetSqlStatement - E-MapReduce: Central de Documentação do Alibaba Cloud

Obtém os detalhes de uma consulta SQL.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

emr-serverless-spark:GetSqlStatement

none

*全部资源

*

Nenhuma

Sintaxe da solicitação

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

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
workspaceId	string	Não	O ID do workspace.	w-d2d82aa09155****
statementId	string	Não	O ID da instrução.	st-2dadfhajk11cv****

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
regionId	string	Não	O ID da região.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
data	object	Os dados retornados.
statementId	string	O ID da instrução.	st-1231311abadfaa
state	string	O estado da consulta. Valores válidos: running : running. available : available. cancelled : cancelled. error : error. cancelling : cancelling.	running
sqlOutputs	array<object>	Uma lista de resultados de consultas SQL.
	object	Um único resultado de consulta SQL.
rows	string	Os dados da consulta. Os dados são uma string serializada em JSON.	[{\"values\":[\"test_db\",\"test_table\",false]}
schema	string	Os detalhes do schema. Os detalhes são uma string serializada em JSON.	{\"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	O código de erro da consulta SQL.	ERROR-102
sqlErrorMessage	string	A mensagem de erro da consulta SQL.	error message
executionTime	array	Uma lista de tempos de execução da consulta SQL.
	integer	O tempo consumido por cada consulta SQL, em milissegundos.	1717138731701
requestId	string	O ID da solicitação.	DD6B1B2A-5837-5237-ABE4-FF0C8944****

Exemplos

Resposta de sucesso

JSON formato

{
  "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****"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.