Database Recommended Actions - Get

Referentie

Service:: SQL Database

API-versie:: 2021-11-01

Hiermee haalt u een aanbevolen databaseactie op.

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

URI-parameters

Name	In	Vereist	Type	Description
advisorName	path	True	string	De naam van de Database Advisor.
databaseName	path	True	string	De naam van de database.
recommendedActionName	path	True	string	De naam van de aanbevolen databaseactie.
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Antwoorden

Name	Type	Description
200 OK	RecommendedAction	De details van de aanbevolen actie voor de opgegeven database zijn opgehaald.
Other Status Codes		Foutreacties: *** 400 FeatureDisabledOnSelectedEdition - Gebruiker heeft geprobeerd een functie te gebruiken die is uitgeschakeld voor de huidige database-editie. 400 InvalidIdentifier: de id bevat NULL of een ongeldig Unicode-teken. 404 DatabaseDoesNotExist - De aangevraagde database is niet gevonden 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden 404 SubscriptionDoesNotHaveElasticPool - De aangevraagde elastische pool is niet gevonden 404 AdvisorNotFound - De aangevraagde adviseur is niet gevonden. 404 RecommendedActionNotFound - De aangevraagde aanbevolen actie is niet gevonden. 404 AdvisorNotFound - De aangevraagde adviseur is niet gevonden. 404 RecommendedActionNotFound - De aangevraagde aanbevolen actie is niet gevonden. 405 NotSupported : deze functionaliteit wordt niet ondersteund. 409 Conflict - Aanvraag kan niet worden verwerkt vanwege een conflict in de aanvraag. 503 ServiceTemporarilyUnavailable - Functie tijdelijk niet beschikbaar.

Name

Type

Description

200 OK

RecommendedAction

De details van de aanbevolen actie voor de opgegeven database zijn opgehaald.

Other Status Codes

Foutreacties: ***

400 FeatureDisabledOnSelectedEdition - Gebruiker heeft geprobeerd een functie te gebruiken die is uitgeschakeld voor de huidige database-editie.
400 InvalidIdentifier: de id bevat NULL of een ongeldig Unicode-teken.
404 DatabaseDoesNotExist - De aangevraagde database is niet gevonden
404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden
404 SubscriptionDoesNotHaveElasticPool - De aangevraagde elastische pool is niet gevonden
404 AdvisorNotFound - De aangevraagde adviseur is niet gevonden.
404 RecommendedActionNotFound - De aangevraagde aanbevolen actie is niet gevonden.
404 AdvisorNotFound - De aangevraagde adviseur is niet gevonden.
404 RecommendedActionNotFound - De aangevraagde aanbevolen actie is niet gevonden.
405 NotSupported : deze functionaliteit wordt niet ondersteund.
409 Conflict - Aanvraag kan niet worden verwerkt vanwege een conflict in de aanvraag.
503 ServiceTemporarilyUnavailable - Functie tijdelijk niet beschikbaar.

Voorbeelden

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

Voorbeeldrespons

Statuscode:: 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]"
    }
  }
}

Definities

Name	Description
ImplementationMethod	Hiermee haalt u de methode op waarin deze aanbevolen actie handmatig kan worden geïmplementeerd. bijvoorbeeld TSql, AzurePowerShell.
IsRetryable	Hiermee wordt aangegeven of de fout kan worden genegeerd en aanbevolen actie opnieuw kan worden geprobeerd. Mogelijke waarden zijn: Ja/Nee
RecommendedAction	Aanbevolen actie voor database, server of elastische pool.
RecommendedActionCurrentState	Huidige status waarin de aanbevolen actie zich bevindt. Enkele veelgebruikte statussen zijn: Actief-> aanbevolen actie actief is en er nog geen actie is ondernomen. In behandeling:> aanbevolen actie wordt goedgekeurd en wacht op uitvoering. Uitvoeren:> aanbevolen actie wordt toegepast op de gebruikersdatabase. Controleren:> aanbevolen actie is toegepast en wordt gecontroleerd op de bruikbaarheid van het systeem. Geslaagd:> aanbevolen actie is toegepast en verbeterd tijdens verificatie. Herstellen in behandeling:> verificatie weinig of geen verbetering heeft gevonden, dus aanbevolen actie wordt in de wachtrij geplaatst om terug te keren of de gebruiker heeft handmatig teruggezet. Terugdraaien:> wijzigingen die zijn aangebracht tijdens het toepassen van de aanbevolen actie, worden teruggezet in de gebruikersdatabase. Teruggedraaid:> de wijzigingen die zijn aangebracht door de aanbevolen actie voor de gebruikersdatabase, zijn teruggedraaid. Genegeerd:> gebruiker de aanbevolen actie expliciet genegeerd/genegeerd.
RecommendedActionErrorInfo	Bevat foutinformatie voor een aanbevolen actie azure SQL Database, Server of Elastische pool.
RecommendedActionImpactRecord	Bevat informatie over geschatte of waargenomen impact op verschillende metrische gegevens voor een aanbevolen actie voor Azure SQL Database, Server of Elastische pool.
RecommendedActionImplementationInfo	Bevat informatie voor handmatige implementatie voor een aanbevolen actie voor Azure SQL Database, Server of Elastische pool.
RecommendedActionInitiatedBy	Hiermee wordt aangegeven wie de uitvoering van deze aanbevolen actie heeft gestart. Mogelijke waarde zijn: Gebruiker -> Wanneer de gebruiker expliciet een meldingssysteem heeft ontvangen om de aanbevolen actie toe te passen. Systeem -> Wanneer de status van deze advisor automatisch wordt uitgevoerd, is ingesteld op Ingeschakeld, in welk geval het systeem het heeft toegepast.
RecommendedActionMetricInfo	Bevat tijdreeksen met verschillende beïnvloede metrische gegevens voor een aanbevolen actie voor Azure SQL Database, Server of Elastische pool.
RecommendedActionStateInfo	Bevat informatie over de huidige status voor een aanbevolen actie voor azure SQL Database, Server of Elastische pool.

ImplementationMethod

Inventarisatie

Hiermee haalt u de methode op waarin deze aanbevolen actie handmatig kan worden geïmplementeerd. bijvoorbeeld TSql, AzurePowerShell.

Waarde	Description
AzurePowerShell
TSql

IsRetryable

Inventarisatie

Hiermee wordt aangegeven of de fout kan worden genegeerd en aanbevolen actie opnieuw kan worden geprobeerd. Mogelijke waarden zijn: Ja/Nee

Waarde	Description
No
Yes

RecommendedAction

Object

Aanbevolen actie voor database, server of elastische pool.

Name	Type	Description
id	string	Resource-id.
kind	string	Resourcetype.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.details	object	Hier vindt u aanvullende informatie die specifiek is voor deze aanbevolen actie.
properties.errorDetails	RecommendedActionErrorInfo	Hiermee worden de foutdetails weergegeven als en waarom deze aanbevolen actie wordt geplaatst in de foutstatus.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Hiermee haalt u de geschatte impactinformatie voor deze aanbevolen actie op, bijvoorbeeld geschatte CPU-toename, wijziging van geschatte schijfruimte
properties.executeActionDuration	string (duration)	Hiermee haalt u de tijd op die nodig is voor het toepassen van deze aanbevolen actie op gebruikersresources. bijvoorbeeld de tijd die nodig is voor het maken van een index
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Hiermee wordt aangegeven of goedkeuring voor het toepassen van deze aanbevolen actie is gegeven door gebruiker/systeem.
properties.executeActionInitiatedTime	string (date-time)	Hiermee wordt de tijd opgehaald waarop deze aanbevolen actie is goedgekeurd voor uitvoering.
properties.executeActionStartTime	string (date-time)	Hiermee wordt de tijd opgevraagd waarop het systeem deze aanbevolen actie op de gebruikersresource gaat toepassen. bijvoorbeeld de begintijd voor het maken van een index
properties.implementationDetails	RecommendedActionImplementationInfo	Hiermee haalt u de implementatiedetails van deze aanbevolen actie op zodat de gebruiker deze handmatig kan toepassen.
properties.isArchivedAction	boolean	Hiermee wordt aangegeven of deze aanbevolen actie enige tijd geleden is voorgesteld, maar de gebruiker heeft ervoor gekozen dit te negeren en het systeem heeft opnieuw een nieuwe aanbevolen actie toegevoegd.
properties.isExecutableAction	boolean	Hiermee wordt opgegeven of deze aanbevolen actie kan worden uitgevoerd door de gebruiker
properties.isRevertableAction	boolean	Hiermee wordt opgehaald of wijzigingen die door deze aanbevolen actie worden toegepast, door de gebruiker kunnen worden teruggezet
properties.lastRefresh	string (date-time)	Hiermee wordt tijd opgehaald waarop deze aanbevolen actie voor het laatst is vernieuwd.
properties.linkedObjects	string[]	Hiermee worden de gekoppelde objecten opgehaald, indien van toepassing.
properties.observedImpact	RecommendedActionImpactRecord[]	Hiermee haalt u de waargenomen/werkelijke impactgegevens voor deze aanbevolen actie op, bijvoorbeeld werkelijke CPU-toename, wijziging van de werkelijke schijfruimte
properties.recommendationReason	string	Hiermee krijgt u de reden voor het aanbevelen van deze actie. bijvoorbeeld DuplicateIndex
properties.revertActionDuration	string (duration)	Hiermee haalt u de tijd op die nodig is om wijzigingen van deze aanbevolen actie voor gebruikersresources te herstellen. bijvoorbeeld de tijd die nodig is voor het verwijderen van de gemaakte index.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Hiermee wordt opgehaald of goedkeuring voor het terugzetten van deze aanbevolen actie is gegeven door gebruiker/systeem.
properties.revertActionInitiatedTime	string (date-time)	Hiermee wordt de tijd opgehaald waarop deze aanbevolen actie is goedgekeurd voor terugdraaien.
properties.revertActionStartTime	string (date-time)	Hiermee wordt de tijd opgevraagd waarop het systeem wijzigingen van deze aanbevolen actie voor gebruikersresources terugdraait. Bijvoorbeeld wanneer indexuitval wordt uitgevoerd.
properties.score	integer (int32)	Hiermee haalt u de impact van deze aanbevolen actie op. Mogelijke waarden zijn 1 - Lage impact, 2 - Gemiddelde impact en 3 - Hoge impact
properties.state	RecommendedActionStateInfo	Hiermee haalt u de informatie op van de huidige status waarin de aanbevolen actie zich bevindt.
properties.timeSeries	RecommendedActionMetricInfo[]	Hiermee haalt u de tijdreeksgegevens van metrische gegevens op voor deze aanbevolen actie, bijvoorbeeld tijdreeks voor CPU-verbruik
properties.validSince	string (date-time)	Hiermee haalt u de tijd op sinds wanneer deze aanbevolen actie geldig is.
type	string	Resourcetype.

RecommendedActionCurrentState

Inventarisatie

Huidige status waarin de aanbevolen actie zich bevindt. Enkele veelgebruikte statussen zijn: Actief-> aanbevolen actie actief is en er nog geen actie is ondernomen. In behandeling:> aanbevolen actie wordt goedgekeurd en wacht op uitvoering. Uitvoeren:> aanbevolen actie wordt toegepast op de gebruikersdatabase. Controleren:> aanbevolen actie is toegepast en wordt gecontroleerd op de bruikbaarheid van het systeem. Geslaagd:> aanbevolen actie is toegepast en verbeterd tijdens verificatie. Herstellen in behandeling:> verificatie weinig of geen verbetering heeft gevonden, dus aanbevolen actie wordt in de wachtrij geplaatst om terug te keren of de gebruiker heeft handmatig teruggezet. Terugdraaien:> wijzigingen die zijn aangebracht tijdens het toepassen van de aanbevolen actie, worden teruggezet in de gebruikersdatabase. Teruggedraaid:> de wijzigingen die zijn aangebracht door de aanbevolen actie voor de gebruikersdatabase, zijn teruggedraaid. Genegeerd:> gebruiker de aanbevolen actie expliciet genegeerd/genegeerd.

Waarde	Description
Active
Error
Executing
Expired
Ignored
Monitoring
Pending
PendingRevert
Resolved
RevertCancelled
Reverted
Reverting
Success
Verifying

RecommendedActionErrorInfo

Object

Bevat foutinformatie voor een aanbevolen actie azure SQL Database, Server of Elastische pool.

Name	Type	Description
errorCode	string	Hiermee wordt de reden opgehaald waarom de aanbevolen actie is geplaatst in de foutstatus. bijvoorbeeld DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Hiermee wordt aangegeven of de fout kan worden genegeerd en aanbevolen actie opnieuw kan worden geprobeerd. Mogelijke waarden zijn: Ja/Nee

RecommendedActionImpactRecord

Object

Bevat informatie over geschatte of waargenomen impact op verschillende metrische gegevens voor een aanbevolen actie voor Azure SQL Database, Server of Elastische pool.

Name	Type	Description
absoluteValue	number (double)	Hiermee haalt u de absolute waarde van deze dimensie op, indien van toepassing. Bijvoorbeeld het aantal betrokken query's
changeValueAbsolute	number (double)	Hiermee haalt u de absolute wijziging op in de waarde van deze dimensie. bijvoorbeeld: absolute schijfruimtewijziging in megabytes
changeValueRelative	number (double)	Hiermee haalt u de relatieve wijziging op in de waarde van deze dimensie. bijvoorbeeld: relatieve schijfruimtewijziging in percentage
dimensionName	string	Hiermee haalt u de naam van de impactdimensie op. bijvoorbeeld CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Hiermee haalt u de naam van de impactdimensie op. bijvoorbeeld CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Object

Bevat informatie voor handmatige implementatie voor een aanbevolen actie voor Azure SQL Database, Server of Elastische pool.

Name	Type	Description
method	ImplementationMethod	Hiermee haalt u de methode op waarin deze aanbevolen actie handmatig kan worden geïmplementeerd. bijvoorbeeld TSql, AzurePowerShell.
script	string	Hiermee haalt u het handmatige implementatiescript op. Bijvoorbeeld T-SQL-script dat kan worden uitgevoerd op de database.

RecommendedActionInitiatedBy

Inventarisatie

Hiermee wordt aangegeven wie de uitvoering van deze aanbevolen actie heeft gestart. Mogelijke waarde zijn: Gebruiker -> Wanneer de gebruiker expliciet een meldingssysteem heeft ontvangen om de aanbevolen actie toe te passen. Systeem -> Wanneer de status van deze advisor automatisch wordt uitgevoerd, is ingesteld op Ingeschakeld, in welk geval het systeem het heeft toegepast.

Waarde	Description
System
User

RecommendedActionMetricInfo

Object

Bevat tijdreeksen met verschillende beïnvloede metrische gegevens voor een aanbevolen actie voor Azure SQL Database, Server of Elastische pool.

Name	Type	Description
metricName	string	Hiermee haalt u de naam van de metrische waarde op. bijvoorbeeld CPU, aantal query's.
startTime	string (date-time)	Hiermee haalt u de begintijd van het tijdsinterval op dat is opgegeven door deze MetricInfo.
timeGrain	string	Hiermee haalt u de duur van het tijdsinterval op voor de waarde die is opgegeven door deze MetricInfo. bijvoorbeeld PT1H (1 uur)
unit	string	Hiermee haalt u de eenheid op waarin metrische gegevens worden gemeten. bijvoorbeeld DTU, frequentie
value	number (double)	Hiermee haalt u de waarde op van de metrische waarde in het tijdsinterval dat is opgegeven door deze MetricInfo.

RecommendedActionStateInfo

Object

Bevat informatie over de huidige status voor een aanbevolen actie voor azure SQL Database, Server of Elastische pool.

Name	Type	Description
actionInitiatedBy	RecommendedActionInitiatedBy	Hiermee wordt aangegeven wie de uitvoering van deze aanbevolen actie heeft gestart. Mogelijke waarde zijn: Gebruiker -> Wanneer de gebruiker expliciet een meldingssysteem heeft ontvangen om de aanbevolen actie toe te passen. Systeem -> Wanneer de status van deze advisor automatisch wordt uitgevoerd, is ingesteld op Ingeschakeld, in welk geval het systeem het heeft toegepast.
currentValue	RecommendedActionCurrentState	Huidige status waarin de aanbevolen actie zich bevindt. Enkele veelgebruikte statussen zijn: Actief-> aanbevolen actie actief is en er nog geen actie is ondernomen. In behandeling:> aanbevolen actie wordt goedgekeurd en wacht op uitvoering. Uitvoeren:> aanbevolen actie wordt toegepast op de gebruikersdatabase. Controleren:> aanbevolen actie is toegepast en wordt gecontroleerd op de bruikbaarheid van het systeem. Geslaagd:> aanbevolen actie is toegepast en verbeterd tijdens verificatie. Herstellen in behandeling:> verificatie weinig of geen verbetering heeft gevonden, dus aanbevolen actie wordt in de wachtrij geplaatst om terug te keren of de gebruiker heeft handmatig teruggezet. Terugdraaien:> wijzigingen die zijn aangebracht tijdens het toepassen van de aanbevolen actie, worden teruggezet in de gebruikersdatabase. Teruggedraaid:> de wijzigingen die zijn aangebracht door de aanbevolen actie voor de gebruikersdatabase, zijn teruggedraaid. Genegeerd:> gebruiker de aanbevolen actie expliciet genegeerd/genegeerd.
lastModified	string (date-time)	Hiermee wordt de tijd opgehaald waarop de status voor het laatst is gewijzigd

Delen via

Database Recommended Actions - Get

URI-parameters

Antwoorden

Voorbeelden

Get database recommended action

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ImplementationMethod

IsRetryable

RecommendedAction

RecommendedActionCurrentState

RecommendedActionErrorInfo

RecommendedActionImpactRecord

RecommendedActionImplementationInfo

RecommendedActionInitiatedBy

RecommendedActionMetricInfo

RecommendedActionStateInfo

Aanvullende resources