Database Recommended Actions - Get

Referens

Tjänst:: SQL Database

API-version:: 2021-11-01

Hämtar en databas rekommenderad åtgärd.

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-parametrar

Name	I	Obligatorisk	Typ	Description
advisorName	path	True	string	Namnet på Database Advisor.
databaseName	path	True	string	Namnet på databasen.
recommendedActionName	path	True	string	Namnet på den databas som rekommenderas.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Svar

Name	Typ	Description
200 OK	RecommendedAction	Information om den rekommenderade åtgärden för den angivna databasen har hämtats.
Other Status Codes		Felsvar: *** 400 FeatureDisabledOnSelectedEdition – Användaren försökte använda en funktion som är inaktiverad i den aktuella databasutgåvan. 400 InvalidIdentifier – identifieraren innehåller NULL eller ett ogiltigt unicode-tecken. 404 DatabaseDoesNotExist – Den begärda databasen hittades inte 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 404 SubscriptionDoesNotHaveElasticPool – Den begärda elastiska poolen hittades inte 404 AdvisorNotFound – Den begärda rådgivaren hittades inte. 404 RecommendedActionNotFound – Den begärda rekommenderade åtgärden hittades inte. 404 AdvisorNotFound – Den begärda rådgivaren hittades inte. 404 RecommendedActionNotFound – Den begärda rekommenderade åtgärden hittades inte. 405 NotSupported – den här funktionen stöds inte. 409 Konflikt – Begäran kunde inte bearbetas på grund av en konflikt i begäran. 503 ServiceTemporarilyUnavailable – Funktionen är inte tillgänglig för tillfället.

Name

Typ

Description

200 OK

RecommendedAction

Information om den rekommenderade åtgärden för den angivna databasen har hämtats.

Other Status Codes

Felsvar: ***

400 FeatureDisabledOnSelectedEdition – Användaren försökte använda en funktion som är inaktiverad i den aktuella databasutgåvan.
400 InvalidIdentifier – identifieraren innehåller NULL eller ett ogiltigt unicode-tecken.
404 DatabaseDoesNotExist – Den begärda databasen hittades inte
404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte
404 SubscriptionDoesNotHaveElasticPool – Den begärda elastiska poolen hittades inte
404 AdvisorNotFound – Den begärda rådgivaren hittades inte.
404 RecommendedActionNotFound – Den begärda rekommenderade åtgärden hittades inte.
404 AdvisorNotFound – Den begärda rådgivaren hittades inte.
404 RecommendedActionNotFound – Den begärda rekommenderade åtgärden hittades inte.
405 NotSupported – den här funktionen stöds inte.
409 Konflikt – Begäran kunde inte bearbetas på grund av en konflikt i begäran.
503 ServiceTemporarilyUnavailable – Funktionen är inte tillgänglig för tillfället.

Exempel

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


import com.azure.core.util.Context;

/** 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", 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

Exempelsvar

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

Definitioner

Name	Description
ImplementationMethod	Hämtar metoden där den här rekommenderade åtgärden kan implementeras manuellt. t.ex. TSql, AzurePowerShell.
IsRetryable	Hämtar info om felet kan ignoreras och rekommenderad åtgärd kan försökas igen. Möjliga värden är: Ja/Nej
RecommendedAction	Rekommenderad åtgärd för databas, server eller elastisk pool.
RecommendedActionCurrentState	Aktuellt tillstånd den rekommenderade åtgärden är i. Några vanliga tillstånd är: Aktiv –> rekommenderad åtgärd är aktiv och inga åtgärder har vidtagits ännu. Väntar –> rekommenderad åtgärd godkänns för och väntar på körning. Kör –> rekommenderad åtgärd tillämpas på användardatabasen. Verifiera –> rekommenderad åtgärd tillämpades och verifieras av systemet. Lyckades –> rekommenderad åtgärd tillämpades och förbättringar hittades under verifieringen. Väntar på återställning –> verifieringen hittade liten eller ingen förbättring, så den rekommenderade åtgärden köas för återställning eller så har användaren återställts manuellt. Återställer –> ändringar som görs vid tillämpning av rekommenderad åtgärd återställs på användardatabasen. Återställd –> återställde ändringarna som gjorts genom rekommenderad åtgärd i användardatabasen. Ignoreras –> användaren ignorerade/ignorerade uttryckligen den rekommenderade åtgärden.
RecommendedActionErrorInfo	Innehåller felinformation för en rekommenderad åtgärd för Azure SQL databas, server eller elastisk pool.
RecommendedActionImpactRecord	Innehåller information om uppskattad eller observerad påverkan på olika mått för en rekommenderad åtgärd för Azure SQL databas, server eller elastisk pool.
RecommendedActionImplementationInfo	Innehåller information om manuell implementering av en Azure SQL databas, server eller elastisk pool rekommenderad åtgärd.
RecommendedActionInitiatedBy	Hämtar vem som initierade körningen av den här rekommenderade åtgärden. Möjliga värden är: Användare –> När användaren uttryckligen meddelade systemet att tillämpa den rekommenderade åtgärden. System –> När statusen för automatisk körning för den här rådgivaren var inställd på "Aktiverad", i vilket fall systemet tillämpade den.
RecommendedActionMetricInfo	Innehåller tidsserier med olika mått som påverkas för en Azure SQL databas, server eller elastisk pool rekommenderad åtgärd.
RecommendedActionStateInfo	Innehåller information om aktuellt tillstånd för en Azure SQL databas, server eller elastisk pool rekommenderad åtgärd.

ImplementationMethod

Hämtar metoden där den här rekommenderade åtgärden kan implementeras manuellt. t.ex. TSql, AzurePowerShell.

Name	Typ	Description
AzurePowerShell	string
TSql	string

IsRetryable

Hämtar info om felet kan ignoreras och rekommenderad åtgärd kan försökas igen. Möjliga värden är: Ja/Nej

Name	Typ	Description
No	string
Yes	string

RecommendedAction

Rekommenderad åtgärd för databas, server eller elastisk pool.

Name	Typ	Description
id	string	Resurs-ID.
kind	string	Resurstyp.
location	string	Resursplats.
name	string	Resursnamn.
properties.details	object	Hämtar ytterligare information som är specifik för den här rekommenderade åtgärden.
properties.errorDetails	RecommendedActionErrorInfo	Hämtar felinformationen om och varför den här rekommenderade åtgärden förs till feltillstånd.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Hämtar den uppskattade effektinformationen för den här rekommenderade åtgärden, t.ex. uppskattad CPU-vinst, beräknad ändring av diskutrymme
properties.executeActionDuration	string	Hämtar den tid det tar att tillämpa den här rekommenderade åtgärden på användarresursen. t.ex. tidsåtgången för att skapa index
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Hämtar om godkännande för att tillämpa den här rekommenderade åtgärden har getts av användaren/systemet.
properties.executeActionInitiatedTime	string	Hämtar den tid då den här rekommenderade åtgärden godkändes för körning.
properties.executeActionStartTime	string	Hämtar den tid då systemet började tillämpa den här rekommenderade åtgärden på användarresursen. t.ex. starttid för indexskapande
properties.implementationDetails	RecommendedActionImplementationInfo	Hämtar implementeringsinformationen för den här rekommenderade åtgärden så att användaren kan tillämpa den manuellt.
properties.isArchivedAction	boolean	Hämtar om den här rekommenderade åtgärden föreslogs för en tid sedan, men användaren valde att ignorera detta och systemet lade till en ny rekommenderad åtgärd igen.
properties.isExecutableAction	boolean	Hämtar om den här rekommenderade åtgärden kan åtgärdas av användaren
properties.isRevertableAction	boolean	Hämtar om ändringar som tillämpas av den här rekommenderade åtgärden kan återställas av användaren
properties.lastRefresh	string	Hämtar tid när den rekommenderade åtgärden senast uppdaterades.
properties.linkedObjects	string[]	Hämtar eventuella länkade objekt.
properties.observedImpact	RecommendedActionImpactRecord[]	Hämtar den observerade/faktiska effektinformationen för den här rekommenderade åtgärden, t.ex. faktisk cpu-vinst, ändring av verkligt diskutrymme
properties.recommendationReason	string	Hämtar anledningen till att rekommendera den här åtgärden. t.ex. DuplicateIndex
properties.revertActionDuration	string	Hämtar den tid det tar att återställa ändringar av den här rekommenderade åtgärden för användarresursen. T.ex. tidsåtgången för att ta bort det skapade indexet.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Hämtar om godkännande för att återställa den här rekommenderade åtgärden har getts av användaren/systemet.
properties.revertActionInitiatedTime	string	Hämtar den tid då den här rekommenderade åtgärden godkändes för återställning.
properties.revertActionStartTime	string	Hämtar den tid då systemet började återställa ändringar av den här rekommenderade åtgärden på användarresursen. t.ex. tid när indexborttagningen körs.
properties.score	integer	Hämtar effekten av den här rekommenderade åtgärden. Möjliga värden är 1 – Låg påverkan, 2 – Medelpåverkan och 3 – Hög påverkan
properties.state	RecommendedActionStateInfo	Hämtar information om det aktuella tillståndet som den rekommenderade åtgärden finns i.
properties.timeSeries	RecommendedActionMetricInfo[]	Hämtar tidsserieinformation för mått för den här rekommenderade åtgärden, t.ex. tidsserie för CPU-förbrukning
properties.validSince	string	Hämtar tiden sedan den här rekommenderade åtgärden är giltig.
type	string	Resurstyp.

RecommendedActionCurrentState

Aktuellt tillstånd den rekommenderade åtgärden är i. Några vanliga tillstånd är: Aktiv –> rekommenderad åtgärd är aktiv och inga åtgärder har vidtagits ännu. Väntar –> rekommenderad åtgärd godkänns för och väntar på körning. Kör –> rekommenderad åtgärd tillämpas på användardatabasen. Verifiera –> rekommenderad åtgärd tillämpades och verifieras av systemet. Lyckades –> rekommenderad åtgärd tillämpades och förbättringar hittades under verifieringen. Väntar på återställning –> verifieringen hittade liten eller ingen förbättring, så den rekommenderade åtgärden köas för återställning eller så har användaren återställts manuellt. Återställer –> ändringar som görs vid tillämpning av rekommenderad åtgärd återställs på användardatabasen. Återställd –> återställde ändringarna som gjorts genom rekommenderad åtgärd i användardatabasen. Ignoreras –> användaren ignorerade/ignorerade uttryckligen den rekommenderade åtgärden.

Name	Typ	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

Innehåller felinformation för en rekommenderad åtgärd för Azure SQL databas, server eller elastisk pool.

Name	Typ	Description
errorCode	string	Hämtar orsaken till att den rekommenderade åtgärden försatts i feltillstånd. t.ex. DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Hämtar info om felet kan ignoreras och rekommenderad åtgärd kan försökas igen. Möjliga värden är: Ja/Nej

RecommendedActionImpactRecord

Innehåller information om uppskattad eller observerad påverkan på olika mått för en rekommenderad åtgärd för Azure SQL databas, server eller elastisk pool.

Name	Typ	Description
absoluteValue	number	Hämtar det absoluta värdet för den här dimensionen om det är tillämpligt. t.ex. antal frågor som påverkas
changeValueAbsolute	number	Hämtar den absoluta ändringen i värdet för den här dimensionen. t.ex. ändring av absolut diskutrymme i Megabyte
changeValueRelative	number	Hämtar den relativa ändringen i värdet för den här dimensionen. t.ex. Relativ diskutrymmesändring i procent
dimensionName	string	Hämtar namnet på effektdimensionen. t.ex. CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Hämtar namnet på effektdimensionen. t.ex. CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Innehåller information om manuell implementering av en Azure SQL databas, server eller elastisk pool rekommenderad åtgärd.

Name	Typ	Description
method	ImplementationMethod	Hämtar metoden där den här rekommenderade åtgärden kan implementeras manuellt. t.ex. TSql, AzurePowerShell.
script	string	Hämtar det manuella implementeringsskriptet. T-SQL-skript som kan köras på databasen.

RecommendedActionInitiatedBy

Hämtar vem som initierade körningen av den här rekommenderade åtgärden. Möjliga värden är: Användare –> När användaren uttryckligen meddelade systemet att tillämpa den rekommenderade åtgärden. System –> När statusen för automatisk körning för den här rådgivaren var inställd på "Aktiverad", i vilket fall systemet tillämpade den.

Name	Typ	Description
System	string
User	string

RecommendedActionMetricInfo

Innehåller tidsserier med olika mått som påverkas för en Azure SQL databas, server eller elastisk pool rekommenderad åtgärd.

Name	Typ	Description
metricName	string	Hämtar namnet på måttet. t.ex. CPU, antal frågor.
startTime	string	Hämtar starttiden för tidsintervallet som anges av denna MetricInfo.
timeGrain	string	Hämtar varaktigheten för tidsintervallet för det värde som anges av denna MetricInfo. t.ex. PT1H (1 timme)
unit	string	Hämtar den enhet där måttet mäts. t.ex. DTU, frekvens
value	number	Hämtar värdet för måttet i tidsintervallet som anges av denna MetricInfo.

RecommendedActionStateInfo

Innehåller information om aktuellt tillstånd för en Azure SQL databas, server eller elastisk pool rekommenderad åtgärd.

Name	Typ	Description
actionInitiatedBy	RecommendedActionInitiatedBy	Hämtar vem som initierade körningen av den här rekommenderade åtgärden. Möjliga värden är: Användare –> När användaren uttryckligen meddelade systemet att tillämpa den rekommenderade åtgärden. System –> När statusen för automatisk körning för den här rådgivaren var inställd på "Aktiverad", i vilket fall systemet tillämpade den.
currentValue	RecommendedActionCurrentState	Aktuellt tillstånd den rekommenderade åtgärden är i. Några vanliga tillstånd är: Aktiv –> rekommenderad åtgärd är aktiv och inga åtgärder har vidtagits ännu. Väntar –> rekommenderad åtgärd godkänns för och väntar på körning. Kör –> rekommenderad åtgärd tillämpas på användardatabasen. Verifiera –> rekommenderad åtgärd tillämpades och verifieras av systemet. Lyckades –> rekommenderad åtgärd tillämpades och förbättringar hittades under verifieringen. Väntar på återställning –> verifieringen hittade liten eller ingen förbättring, så den rekommenderade åtgärden köas för återställning eller så har användaren återställts manuellt. Återställer –> ändringar som görs vid tillämpning av rekommenderad åtgärd återställs på användardatabasen. Återställd –> återställde ändringarna som gjorts genom rekommenderad åtgärd i användardatabasen. Ignoreras –> användaren ignorerade/ignorerade uttryckligen den rekommenderade åtgärden.
lastModified	string	Hämtar den tid då tillståndet senast ändrades

Dela via

Database Recommended Actions - Get

URI-parametrar

Svar

Exempel

Get database recommended action

Exempelbegäran

Exempelsvar

Definitioner

ImplementationMethod

IsRetryable

RecommendedAction

RecommendedActionCurrentState

RecommendedActionErrorInfo

RecommendedActionImpactRecord

RecommendedActionImplementationInfo

RecommendedActionInitiatedBy

RecommendedActionMetricInfo

RecommendedActionStateInfo

Ytterligare resurser