DescribeQueryExplain - Database Autonomy Service: Central de Documentação do Alibaba Cloud

Consulta o plano de execução de uma instrução SQL.

Descrição da operação

Atualmente, você pode consultar os planos de execução de instruções SQL apenas para instâncias do ApsaraDB RDS for MySQL e do PolarDB for MySQL.
Use a versão mais recente do SDK do Alibaba Cloud ou do SDK do DAS.
Ao usar um SDK para chamar o DAS, você deve especificar a região como cn-shanghai.

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

hdm:DescribeQueryExplain

get

*All resources

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	rm-2ze8g2am97624****
NodeId	string	Não	O ID da instância. Nota Para uma instância do PolarDB for MySQL, se um ID de instância for especificado, o plano de execução será consultado no nó especificado. Caso contrário, o plano de execução será consultado em um nó secundário. Para uma instância do ApsaraDB RDS for MySQL High-availability Edition, se um ID de instância for especificado, o plano de execução será consultado no nó especificado. Caso contrário, o plano de execução será consultado no nó secundário.	pi-bp1v203xzzh0a****
Sql	string	Sim	A instrução SQL para a qual consultar o plano de execução.	select * from test where name = 'mockUser'
DbName	string	Não	O nome do banco de dados.	dbtest01
Schema	string	Não	As informações de schema. Este é um parâmetro reservado.	None

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
Code	string	O código de status retornado. Um valor 200 indica sucesso.	200
Message	string	A mensagem retornada para a solicitação. Nota Se a solicitação for bem-sucedida, Successful será retornado. Se a solicitação falhar, uma mensagem de erro, como um código de erro, será retornada.	Successful
RequestId	string	O ID da solicitação.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Data	array<object>	List
	object	Os dados retornados.
Id	string	O ID da consulta.	1
SelectType	string	O tipo de select.	SIMPLE
Table	string	O nome da tabela.	test
Type	string	O tipo de join.	eq_ref
PossibleKeys	string	Os possíveis índices.	test_idx
Key	string	O índice que é realmente usado no plano de execução.	PRIMARY
KeyLen	string	O comprimento do índice usado.	3
Ref	string	As colunas usadas com o índice.	test_column
Rows	string	O número de linhas a serem examinadas.	1000
Extra	string	As informações adicionais.	None
QueryPlan	string	O campo reservado para o mecanismo PostgreSQL.	None
TableList	array	O campo reservado para o mecanismo PostgreSQL.
	string	O campo reservado para o mecanismo PostgreSQL.	None
IndexList	array	O campo reservado para o mecanismo PostgreSQL.
	string	O campo reservado para o mecanismo PostgreSQL.	None
LogicalPlanList	array	O campo reservado para o mecanismo PolarDB-X.
	string	O campo reservado para o mecanismo PolarDB-X.	None
StmtText	string	O campo reservado para o mecanismo SQL Server.	None
StmtId	string	O campo reservado para o mecanismo SQL Server.	None
NodeId	string	O campo reservado para o mecanismo SQL Server.	None
Parent	string	O campo reservado para o mecanismo SQL Server.	None
PhysicalOp	string	O campo reservado para o mecanismo SQL Server.	None
LogicalOp	string	O campo reservado para o mecanismo SQL Server.	None
Argument	string	O campo reservado para o mecanismo SQL Server.	None
DefinedValues	string	O campo reservado para o mecanismo SQL Server.	None
EstimateRows	string	O campo reservado para o mecanismo SQL Server.	None
EstimateIO	string	O campo reservado para o mecanismo SQL Server.	None
EstimateCPU	string	O campo reservado para o mecanismo SQL Server.	None
AvgRowSize	string	O campo reservado para o mecanismo SQL Server.	None
TotalSubtreeCost	string	O campo reservado para o mecanismo SQL Server.	None
OutputList	string	O campo reservado para o mecanismo SQL Server.	None
Warnings	string	O campo reservado para o mecanismo SQL Server.	None
Parallel	string	O campo reservado para o mecanismo SQL Server.	None
EstimateExecutions	string	O campo reservado para o mecanismo SQL Server.	None

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": [
    {
      "Id": "1",
      "SelectType": "SIMPLE",
      "Table": "test",
      "Type": "eq_ref",
      "PossibleKeys": "test_idx",
      "Key": "PRIMARY",
      "KeyLen": "3",
      "Ref": "test_column",
      "Rows": "1000",
      "Extra": "无",
      "QueryPlan": "无",
      "TableList": [
        "无"
      ],
      "IndexList": [
        "无"
      ],
      "LogicalPlanList": [
        "无"
      ],
      "StmtText": "无",
      "StmtId": "无",
      "NodeId": "无",
      "Parent": "无",
      "PhysicalOp": "无",
      "LogicalOp": "无",
      "Argument": "无",
      "DefinedValues": "无",
      "EstimateRows": "无",
      "EstimateIO": "无",
      "EstimateCPU": "无",
      "AvgRowSize": "无",
      "TotalSubtreeCost": "无",
      "OutputList": "无",
      "Warnings": "无",
      "Parallel": "无",
      "EstimateExecutions": "无"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParams	The request parameters are invalid.	Os parâmetros da solicitação são inválidos.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.