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

Obtém o plano de execução de uma instrução SQL.

Descrição da operação

Esta operação suporta apenas instâncias do ApsaraDB RDS for MySQL e do PolarDB for MySQL.
Ao usar o SDK do Alibaba Cloud ou do DAS, utilize a versão mais recente.
Ao chamar o serviço DAS com o SDK, defina 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 Resource

*

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 do nó. Nota Para instâncias do PolarDB for MySQL, se você especificar um ID de nó, o sistema consultará o plano de execução nesse nó. Caso contrário, consultará o plano de execução em um nó secundário. Para instâncias de alta disponibilidade do ApsaraDB RDS for MySQL, se você especificar um ID de instância, o sistema consultará o plano de execução nesse nó. Caso contrário, consultará o plano de execução em um nó secundário.	pi-bp1v203xzzh0a****
Sql	string	Sim	A instrução SQL para a qual você deseja obter 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	Informações do schema. Este é um parâmetro reservado.	无

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 da resposta. Nota Se a solicitação for bem-sucedida, este parâmetro retornará Successful. Se a solicitação falhar, este parâmetro retornará detalhes do erro, como um código de erro.	Successful
RequestId	string	O ID da solicitação.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indica se a solicitação foi bem-sucedida: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Data	array<object>	Lista de planos de execução.
	object	Os dados retornados.
Id	string	O ID da consulta.	1
SelectType	string	O tipo da consulta.	SIMPLE
Table	string	O nome da tabela.	test
Type	string	O tipo de junção.	eq_ref
PossibleKeys	string	Os índices que podem ser usados.	test_idx
Key	string	O índice realmente usado no plano de execução.	PRIMARY
KeyLen	string	O comprimento do índice realmente usado.	3
Ref	string	A coluna usada pelo índice.	test_column
Rows	string	O número de linhas a serem escaneadas.	1000
Extra	string	Informações adicionais.	无
QueryPlan	string	Um campo reservado para o mecanismo PostgreSQL.	无
TableList	array	Um campo reservado para o mecanismo PostgreSQL.
	string	Um campo reservado para o mecanismo PostgreSQL.	无
IndexList	array	Um campo reservado para o mecanismo PostgreSQL.
	string	Um campo reservado para o mecanismo PostgreSQL.	无
LogicalPlanList	array	Um campo reservado para o mecanismo PolarDB X.
	string	Um campo reservado para o mecanismo PolarDB X.	无
StmtText	string	Um campo reservado para o mecanismo SQL Server.	无
StmtId	string	Um campo reservado para o mecanismo SQL Server.	无
NodeId	string	Um campo reservado para o mecanismo SQL Server.	无
Parent	string	Um campo reservado para o mecanismo SQL Server.	无
PhysicalOp	string	Um campo reservado para o mecanismo SQL Server.	无
LogicalOp	string	Um campo reservado para o mecanismo SQL Server.	无
Argument	string	Um campo reservado para o mecanismo SQL Server.	无
DefinedValues	string	Um campo reservado para o mecanismo SQL Server.	无
EstimateRows	string	Um campo reservado para o mecanismo SQL Server.	无
EstimateIO	string	Um campo reservado para o mecanismo SQL Server.	无
EstimateCPU	string	Um campo reservado para o mecanismo SQL Server.	无
AvgRowSize	string	Um campo reservado para o mecanismo SQL Server.	无
TotalSubtreeCost	string	Um campo reservado para o mecanismo SQL Server.	无
OutputList	string	Um campo reservado para o mecanismo SQL Server.	无
Warnings	string	Um campo reservado para o mecanismo SQL Server.	无
Parallel	string	Um campo reservado para o mecanismo SQL Server.	无
EstimateExecutions	string	Um campo reservado para o mecanismo SQL Server.	无

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.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.