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

Consulta as sugestões de diagnóstico geradas pelo recurso de otimização automática de SQL do DAS.

Descrição da operação

O recurso de diagnósticos de SQL fornece sugestões de diagnóstico de instância. Você pode usar as sugestões para otimizar os índices da instância. Para obter detalhes, consulte Otimização automática de SQL.

Nota

Você pode invocar esta operação apenas para consultar sugestões de diagnóstico geradas pelo recurso de otimização automática de SQL do DAS.

Antes de começar:

O mecanismo DPI do banco de dados é RDS MySQL ou PolarDB for MySQL.
Se você usar o site da China (aliyun.com) ou o SDK do DAS, utilize a versão mais recente.
Ao invocar o DAS usando 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:GetSqlOptimizeAdvice

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ConsoleContext	string	Não	Um parâmetro reservado.	None
Engine	string	Não	O mecanismo do banco de dados. Valores válidos: MySQL: RDS MySQL. PolarDBMySQL: PolarDB for MySQL.	MySQL
InstanceIds	string	Não	O ID da instância. Nota Apenas instâncias RDS MySQL e PolarDB for MySQL são suportadas.	rm-2ze1jdv45i7l6****
StartDt	string	Não	A data inicial da consulta. Formato: yyyyMMdd (UTC). Se este parâmetro for deixado vazio, o valor padrão será o dia anterior à data atual. Você só pode consultar dados do dia anterior à data atual ou anteriores.	20210916
EndDt	string	Não	A data final da consulta. Formato: yyyyMMdd (UTC). Se este parâmetro for deixado vazio, o valor padrão será o dia anterior à data atual. Você só pode consultar dados do dia anterior à data atual ou anteriores. O intervalo entre a data inicial e a data final não pode exceder 30 dias.	20210917
Region	string	Não	A região à qual a instância pertence. Valores válidos: cn-china: China continental. cn-hongkong: Hong Kong (China). ap-southeast-1: Singapura. Este parâmetro entra em vigor somente quando o parâmetro de solicitação InstanceIds é deixado vazio. Se InstanceIds for deixado vazio, os dados serão recuperados com base na região especificada pelo parâmetro Region. A região padrão é cn-china. Se InstanceIds não estiver vazio, os dados serão recuperados com base na região da primeira instância especificada por InstanceIds, mesmo que o parâmetro Region esteja definido. Nota Para instâncias criadas em regiões dentro da China continental, defina este parâmetro como cn-china.	cn-china

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de status retornado.	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 será retornada, como um código de erro.	Successful
Data	object	Os detalhes, incluindo o número total de entradas e códigos de erro.
Status	string	O status da tarefa. Valores válidos: INIT: inicializando. RUNNING: em execução. FINISH: concluída. FAILED: falhou.	FINISH
StatusCode	string	O código de status da tarefa. Valores válidos: NO_DATA: nenhum dado disponível. INTERNAL_ERROR: erro interno. SUCCESS: sucesso.	SUCCESS
DownloadUrl	string	A URL de download do arquivo.	https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******
CreateTime	string	A hora em que a tarefa foi criada. O valor é um timestamp UNIX. Unidade: milissegundos.	1632303861000
ExpireTime	string	A hora em que o arquivo expira. O valor é um timestamp UNIX. Unidade: milissegundos. Nota O arquivo expira três dias após a criação da tarefa.	1632563061000
TaskId	string	O ID da tarefa.	2021091710461519216****
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: sucesso. false: falha.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Status": "FINISH",
    "StatusCode": "SUCCESS",
    "DownloadUrl": "https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******",
    "CreateTime": "1632303861000",
    "ExpireTime": "1632563061000",
    "TaskId": "2021091710461519216****"
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

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.
403	NoPermission	You are not authorized to do this action.	Você não tem as permissões para realizar esta operação.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.