Database Recommended Actions - Get

Referência

Serviço:: SQL Database

Versão da API:: 2021-11-01

Obtém uma ação recomendada para a base de dados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}?api-version=2021-11-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
advisorName	path	True	string	O nome do Assistente de Bases de Dados.
databaseName	path	True	string	O nome da base de dados.
recommendedActionName	path	True	string	O nome da Ação Recomendada da Base de Dados.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
api-version	query	True	string	A versão da API a utilizar para o pedido.

Respostas

Name	Tipo	Description
200 OK	RecommendedAction	Foram obtidos com êxito detalhes da ação recomendada da base de dados especificada.
Other Status Codes		Respostas de Erro: *** 400 FeatureDisabledOnSelectedEdition – o utilizador tentou utilizar uma funcionalidade que está desativada na edição atual da base de dados. 400 InvalidIdentifier - O identificador contém NULL ou um caráter unicode inválido. 404 DatabaseDoesNotExist - A base de dados pedida não foi encontrada 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado 404 SubscriptionDoesNotHaveElasticPool - O conjunto elástico pedido não foi encontrado 404 AdvisorNotFound - O assistente pedido não foi encontrado. 404 RecommendedActionNotFound – a ação recomendada pedida não foi encontrada. 404 AdvisorNotFound - O assistente pedido não foi encontrado. 404 RecommendedActionNotFound – a ação recomendada pedida não foi encontrada. 405 NotSupported – esta funcionalidade não é suportada. 409 Conflito – não foi possível processar o pedido devido a um conflito no pedido. 503 ServiceTemporarilyUnavailable - Funcionalidade temporariamente indisponível.

Name

Tipo

Description

200 OK

RecommendedAction

Foram obtidos com êxito detalhes da ação recomendada da base de dados especificada.

Other Status Codes

Respostas de Erro: ***

400 FeatureDisabledOnSelectedEdition – o utilizador tentou utilizar uma funcionalidade que está desativada na edição atual da base de dados.
400 InvalidIdentifier - O identificador contém NULL ou um caráter unicode inválido.
404 DatabaseDoesNotExist - A base de dados pedida não foi encontrada
404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado
404 SubscriptionDoesNotHaveElasticPool - O conjunto elástico pedido não foi encontrado
404 AdvisorNotFound - O assistente pedido não foi encontrado.
404 RecommendedActionNotFound – a ação recomendada pedida não foi encontrada.
404 AdvisorNotFound - O assistente pedido não foi encontrado.
404 RecommendedActionNotFound – a ação recomendada pedida não foi encontrada.
405 NotSupported – esta funcionalidade não é suportada.
409 Conflito – não foi possível processar o pedido devido a um conflito no pedido.
503 ServiceTemporarilyUnavailable - Funcionalidade temporariamente indisponível.

Exemplos

Get database recommended action

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/databases/IndexAdvisor_test_3/advisors/CreateIndex/recommendedActions/IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB?api-version=2021-11-01


/**
 * Samples for DatabaseRecommendedActions Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseRecommendedActionGet.json
     */
    /**
     * Sample code: Get database recommended action.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getDatabaseRecommendedAction(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseRecommendedActions().getWithResponse(
            "workloadinsight-demos", "misosisvr", "IndexAdvisor_test_3", "CreateIndex",
            "IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/databases/IndexAdvisor_test_3/advisors/CreateIndex/recommendedActions/IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB",
  "name": "IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB",
  "type": "Microsoft.Sql/servers/databases/advisors/recommendedActions",
  "location": "East Asia",
  "kind": "",
  "properties": {
    "recommendationReason": "",
    "validSince": "2017-03-01T14:38:04Z",
    "lastRefresh": "2017-03-01T14:38:04Z",
    "state": {
      "currentValue": "Active",
      "lastModified": "2017-03-01T14:38:05Z"
    },
    "isExecutableAction": true,
    "isRevertableAction": true,
    "isArchivedAction": false,
    "score": 1,
    "implementationDetails": {
      "method": "TSql",
      "script": "CREATE NONCLUSTERED INDEX [nci_wi_DataPoints_B892614093BAC56295EF6018BD4CB51B] ON [CRM].[DataPoints] ([Name],[Money],[Power]) INCLUDE ([Hour], [System], [LastChanged]) WITH (ONLINE = ON)"
    },
    "errorDetails": {},
    "estimatedImpact": [
      {
        "dimensionName": "ActionDuration",
        "unit": "Seconds",
        "absoluteValue": 1440
      },
      {
        "dimensionName": "SpaceChange",
        "unit": "Megabytes",
        "absoluteValue": 209.3125
      }
    ],
    "observedImpact": [],
    "timeSeries": [],
    "details": {
      "indexName": "nci_wi_DataPoints_B892614093BAC56295EF6018BD4CB51B",
      "indexType": "NONCLUSTERED",
      "schema": "[CRM]",
      "table": "[DataPoints]",
      "indexColumns": "[Name],[Money],[Power]",
      "includedColumns": "[Hour], [System], [LastChanged]"
    }
  }
}

Definições

Name	Description
ImplementationMethod	Obtém o método no qual esta ação recomendada pode ser implementada manualmente. Por exemplo, TSql, AzurePowerShell.
IsRetryable	Obtém se o erro pode ser ignorado e se a ação recomendada pode ser repetida. Os valores possíveis são: Sim/Não
RecommendedAction	Ação Recomendada de Base de Dados, Servidor ou Conjunto Elástico.
RecommendedActionCurrentState	Estado atual em que se encontra a ação recomendada. Alguns estados frequentemente utilizados são: Ativo –> a ação recomendada está ativa e ainda não foram tomadas medidas. Pendente –> a ação recomendada é aprovada para e aguarda a execução. Execução –> a ação recomendada está a ser aplicada na base de dados do utilizador. Verificar –> a ação recomendada foi aplicada e está a ser verificada da sua utilidade pelo sistema. Êxito –> a ação recomendada foi aplicada e foi encontrada uma melhoria durante a verificação. Reversão Pendente –> a verificação encontrou pouca ou nenhuma melhoria, pelo que a ação recomendada está em fila de espera para reverter ou o utilizador foi revertido manualmente. A reverter –> as alterações efetuadas ao aplicar a ação recomendada estão a ser revertidas na base de dados do utilizador. Revertido –> revertido com êxito as alterações efetuadas pela ação recomendada na base de dados do utilizador. Ignorado –> o utilizador ignorou/eliminou explicitamente a ação recomendada.
RecommendedActionErrorInfo	Contém informações de erro para uma Ação Recomendada de Base de Dados SQL do Azure, Servidor ou Conjunto Elástico.
RecommendedActionImpactRecord	Contém informações sobre o impacto estimado ou observado em várias métricas de uma Base de Dados SQL do Azure, Servidor ou Ação Recomendada do Conjunto Elástico.
RecommendedActionImplementationInfo	Contém informações sobre a implementação manual de uma Base de Dados SQL do Azure, Servidor ou Ação Recomendada do Conjunto Elástico.
RecommendedActionInitiatedBy	Obtém quem iniciou a execução desta ação recomendada. Valor Possível: Utilizador –> quando o utilizador notificou explicitamente o sistema para aplicar a ação recomendada. Sistema –> quando o estado de execução automática deste assistente foi definido como "Ativado", caso em que o sistema o aplicou.
RecommendedActionMetricInfo	Contém uma série temporal de várias métricas afetadas para uma Ação Recomendada de Base de Dados SQL do Azure, Servidor ou Conjunto Elástico.
RecommendedActionStateInfo	Contém informações sobre o estado atual de uma Ação Recomendada de Base de Dados SQL do Azure, Servidor ou Conjunto Elástico.

ImplementationMethod

Obtém o método no qual esta ação recomendada pode ser implementada manualmente. Por exemplo, TSql, AzurePowerShell.

Name	Tipo	Description
AzurePowerShell	string
TSql	string

IsRetryable

Obtém se o erro pode ser ignorado e se a ação recomendada pode ser repetida. Os valores possíveis são: Sim/Não

Name	Tipo	Description
No	string
Yes	string

RecommendedAction

Ação Recomendada de Base de Dados, Servidor ou Conjunto Elástico.

Name	Tipo	Description
id	string	ID do Recurso.
kind	string	Tipo de recurso.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.details	object	Obtém detalhes adicionais específicos desta ação recomendada.
properties.errorDetails	RecommendedActionErrorInfo	Obtém os detalhes do erro se e por que motivo esta ação recomendada é colocada no estado de erro.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Obtém as informações de impacto estimado para esta ação recomendada, por exemplo, Ganho estimado da CPU, Alteração estimada do Espaço em Disco
properties.executeActionDuration	string	Obtém o tempo necessário para aplicar esta ação recomendada no recurso do utilizador. Por exemplo, tempo decorrido para a criação de índices
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Obtém se a aprovação para aplicar esta ação recomendada tiver sido dada pelo utilizador/sistema.
properties.executeActionInitiatedTime	string	Obtém o tempo em que esta ação recomendada foi aprovada para execução.
properties.executeActionStartTime	string	Obtém a hora em que o sistema começou a aplicar esta ação recomendada no recurso de utilizador. Por exemplo, hora de início da criação do índice
properties.implementationDetails	RecommendedActionImplementationInfo	Obtém os detalhes de implementação desta ação recomendada para que o utilizador a aplique manualmente.
properties.isArchivedAction	boolean	Obtém se esta ação recomendada foi sugerida há algum tempo, mas o utilizador optou por ignorar esta situação e o sistema adicionou novamente uma nova ação recomendada.
properties.isExecutableAction	boolean	Obtém se esta ação recomendada for acionável pelo utilizador
properties.isRevertableAction	boolean	Obtém se as alterações aplicadas por esta ação recomendada podem ser revertidas pelo utilizador
properties.lastRefresh	string	Obtém tempo quando esta ação recomendada foi atualizada pela última vez.
properties.linkedObjects	string[]	Obtém os objetos ligados, se existirem.
properties.observedImpact	RecommendedActionImpactRecord[]	Obtém as informações de impacto observados/reais para esta ação recomendada, por exemplo, Ganho real da CPU, alteração do Espaço em Disco Real
properties.recommendationReason	string	Obtém o motivo para recomendar esta ação. Por exemplo, DuplicateIndex
properties.revertActionDuration	string	Obtém o tempo necessário para reverter as alterações desta ação recomendada no recurso do utilizador. Por exemplo, tempo necessário para remover o índice criado.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Obtém se a aprovação para reverter esta ação recomendada tiver sido dada pelo utilizador/sistema.
properties.revertActionInitiatedTime	string	Obtém a hora em que esta ação recomendada foi aprovada para reverter.
properties.revertActionStartTime	string	Obtém a hora em que o sistema começou a reverter as alterações desta ação recomendada no recurso do utilizador. Por exemplo, a hora em que a queda do índice é executada.
properties.score	integer	Obtém o impacto desta ação recomendada. Os valores possíveis são 1 - Baixo impacto, 2 - Impacto Médio e 3 - Impacto Elevado
properties.state	RecommendedActionStateInfo	Obtém as informações do estado atual em que se encontra a ação recomendada.
properties.timeSeries	RecommendedActionMetricInfo[]	Obtém as informações de série temporal das métricas para esta ação recomendada, por exemplo, série temporal de consumo da CPU
properties.validSince	string	Obtém o tempo desde quando esta ação recomendada é válida.
type	string	Tipo de recurso.

RecommendedActionCurrentState

Estado atual em que se encontra a ação recomendada. Alguns estados frequentemente utilizados são: Ativo –> a ação recomendada está ativa e ainda não foram tomadas medidas. Pendente –> a ação recomendada é aprovada para e aguarda a execução. Execução –> a ação recomendada está a ser aplicada na base de dados do utilizador. Verificar –> a ação recomendada foi aplicada e está a ser verificada da sua utilidade pelo sistema. Êxito –> a ação recomendada foi aplicada e foi encontrada uma melhoria durante a verificação. Reversão Pendente –> a verificação encontrou pouca ou nenhuma melhoria, pelo que a ação recomendada está em fila de espera para reverter ou o utilizador foi revertido manualmente. A reverter –> as alterações efetuadas ao aplicar a ação recomendada estão a ser revertidas na base de dados do utilizador. Revertido –> revertido com êxito as alterações efetuadas pela ação recomendada na base de dados do utilizador. Ignorado –> o utilizador ignorou/eliminou explicitamente a ação recomendada.

Name	Tipo	Description
Active	string
Error	string
Executing	string
Expired	string
Ignored	string
Monitoring	string
Pending	string
PendingRevert	string
Resolved	string
RevertCancelled	string
Reverted	string
Reverting	string
Success	string
Verifying	string

RecommendedActionErrorInfo

Contém informações de erro para uma Ação Recomendada de Base de Dados SQL do Azure, Servidor ou Conjunto Elástico.

Name	Tipo	Description
errorCode	string	Obtém o motivo pelo qual a ação recomendada foi colocada no estado de erro. Por exemplo, DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Obtém se o erro pode ser ignorado e se a ação recomendada pode ser repetida. Os valores possíveis são: Sim/Não

RecommendedActionImpactRecord

Contém informações sobre o impacto estimado ou observado em várias métricas de uma Base de Dados SQL do Azure, Servidor ou Ação Recomendada do Conjunto Elástico.

Name	Tipo	Description
absoluteValue	number	Obtém o valor absoluto desta dimensão, se aplicável. Por exemplo, Número de Consultas afetadas
changeValueAbsolute	number	Obtém a alteração absoluta no valor desta dimensão. Por exemplo, alteração absoluta do espaço em disco em Megabytes
changeValueRelative	number	Obtém a alteração relativa no valor desta dimensão. Por exemplo, alteração do espaço em Disco Relativo em Percentagem
dimensionName	string	Obtém o nome da dimensão de impacto. por exemplo, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Obtém o nome da dimensão de impacto. por exemplo, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Contém informações sobre a implementação manual de uma Base de Dados SQL do Azure, Servidor ou Ação Recomendada do Conjunto Elástico.

Name	Tipo	Description
method	ImplementationMethod	Obtém o método no qual esta ação recomendada pode ser implementada manualmente. Por exemplo, TSql, AzurePowerShell.
script	string	Obtém o script de implementação manual. Por exemplo, script T-SQL que pode ser executado na base de dados.

RecommendedActionInitiatedBy

Obtém quem iniciou a execução desta ação recomendada. Valor Possível: Utilizador –> quando o utilizador notificou explicitamente o sistema para aplicar a ação recomendada. Sistema –> quando o estado de execução automática deste assistente foi definido como "Ativado", caso em que o sistema o aplicou.

Name	Tipo	Description
System	string
User	string

RecommendedActionMetricInfo

Contém uma série temporal de várias métricas afetadas para uma Ação Recomendada de Base de Dados SQL do Azure, Servidor ou Conjunto Elástico.

Name	Tipo	Description
metricName	string	Obtém o nome da métrica. Por exemplo, CPU, Número de Consultas.
startTime	string	Obtém a hora de início do intervalo de tempo dada por este MetricInfo.
timeGrain	string	Obtém a duração do intervalo de tempo para o valor fornecido por este MetricInfo. por exemplo, PT1H (1 hora)
unit	string	Obtém a unidade em que a métrica é medida. Por exemplo, DTU, Frequência
value	number	Obtém o valor da métrica no intervalo de tempo fornecido por este MetricInfo.

RecommendedActionStateInfo

Contém informações sobre o estado atual de uma Ação Recomendada de Base de Dados SQL do Azure, Servidor ou Conjunto Elástico.

Name	Tipo	Description
actionInitiatedBy	RecommendedActionInitiatedBy	Obtém quem iniciou a execução desta ação recomendada. Valor Possível: Utilizador –> quando o utilizador notificou explicitamente o sistema para aplicar a ação recomendada. Sistema –> quando o estado de execução automática deste assistente foi definido como "Ativado", caso em que o sistema o aplicou.
currentValue	RecommendedActionCurrentState	Estado atual em que se encontra a ação recomendada. Alguns estados frequentemente utilizados são: Ativo –> a ação recomendada está ativa e ainda não foram tomadas medidas. Pendente –> a ação recomendada é aprovada para e aguarda a execução. Execução –> a ação recomendada está a ser aplicada na base de dados do utilizador. Verificar –> a ação recomendada foi aplicada e está a ser verificada da sua utilidade pelo sistema. Êxito –> a ação recomendada foi aplicada e foi encontrada uma melhoria durante a verificação. Reversão Pendente –> a verificação encontrou pouca ou nenhuma melhoria, pelo que a ação recomendada está em fila de espera para reverter ou o utilizador foi revertido manualmente. A reverter –> as alterações efetuadas ao aplicar a ação recomendada estão a ser revertidas na base de dados do utilizador. Revertido –> revertido com êxito as alterações efetuadas pela ação recomendada na base de dados do utilizador. Ignorado –> o utilizador ignorou/eliminou explicitamente a ação recomendada.
lastModified	string	Obtém a hora em que o estado foi modificado pela última vez

Partilhar via

Database Recommended Actions - Get

Parâmetros do URI

Respostas

Exemplos

Get database recommended action

Pedido de amostra

Resposta da amostra

Definições

ImplementationMethod

IsRetryable

RecommendedAction

RecommendedActionCurrentState

RecommendedActionErrorInfo

RecommendedActionImpactRecord

RecommendedActionImplementationInfo

RecommendedActionInitiatedBy

RecommendedActionMetricInfo

RecommendedActionStateInfo

Recursos adicionais