Database Recommended Actions - Get

Reference

Služba:: SQL Database

Verze rozhraní API:: 2021-11-01

Získá doporučenou akci databáze.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
advisorName	path	True	string	Název databázového poradce.
databaseName	path	True	string	Název databáze.
recommendedActionName	path	True	string	Název doporučené akce databáze.
resourceGroupName	path	True	string	Název skupiny prostředků, která prostředek obsahuje. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Odpovědi

Name	Typ	Description
200 OK	RecommendedAction	Podrobnosti o doporučené akci zadané databáze se úspěšně načetly.
Other Status Codes		Chybové odpovědi: *** 400 FeatureDisabledOnSelectedEdition – uživatel se pokusil použít funkci, která je v aktuální edici databáze zakázaná. 400 InvalidIdentifier – identifikátor obsahuje hodnotu NULL nebo neplatný znak unicode. 404 DatabaseDoesNotExist – Požadovaná databáze nebyla nalezena. 404 SubscriptionDoesNotHaveServer – Požadovaný server se nenašel. 404 SubscriptionDoesNotHaveElasticPool – Požadovaný elastický fond se nenašel. 404 AdvisorNotFound – požadovaný poradce nebyl nalezen. 404 RecommendedActionNotFound – Požadovaná doporučená akce nebyla nalezena. 404 AdvisorNotFound – požadovaný poradce nebyl nalezen. 404 RecommendedActionNotFound – Požadovaná doporučená akce nebyla nalezena. 405 NotSupported –Tato funkce není podporována. 409 Konflikt – Požadavek nelze zpracovat kvůli konfliktu v požadavku. 503 ServiceTemporarilyUnavailable – Funkce je dočasně nedostupná.

Name

Typ

Description

200 OK

RecommendedAction

Podrobnosti o doporučené akci zadané databáze se úspěšně načetly.

Other Status Codes

Chybové odpovědi: ***

400 FeatureDisabledOnSelectedEdition – uživatel se pokusil použít funkci, která je v aktuální edici databáze zakázaná.
400 InvalidIdentifier – identifikátor obsahuje hodnotu NULL nebo neplatný znak unicode.
404 DatabaseDoesNotExist – Požadovaná databáze nebyla nalezena.
404 SubscriptionDoesNotHaveServer – Požadovaný server se nenašel.
404 SubscriptionDoesNotHaveElasticPool – Požadovaný elastický fond se nenašel.
404 AdvisorNotFound – požadovaný poradce nebyl nalezen.
404 RecommendedActionNotFound – Požadovaná doporučená akce nebyla nalezena.
404 AdvisorNotFound – požadovaný poradce nebyl nalezen.
404 RecommendedActionNotFound – Požadovaná doporučená akce nebyla nalezena.
405 NotSupported –Tato funkce není podporována.
409 Konflikt – Požadavek nelze zpracovat kvůli konfliktu v požadavku.
503 ServiceTemporarilyUnavailable – Funkce je dočasně nedostupná.

Příklady

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

Ukázková odpověď

Stavový kód:: 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]"
    }
  }
}

Definice

Name	Description
ImplementationMethod	Získá metodu, ve které lze tuto doporučenou akci ručně implementovat. např. TSql, AzurePowerShell.
IsRetryable	Získá, zda by chyba mohla být ignorována a doporučená akce by mohla být zopakována. Možné hodnoty jsou: Ano/Ne
RecommendedAction	Doporučená akce databáze, serveru nebo elastického fondu
RecommendedActionCurrentState	Aktuální stav, ve který je doporučená akce. Mezi běžně používané stavy patří: Aktivní –> doporučená akce je aktivní a zatím nebyla provedena žádná akce. Čeká na vyřízení –> doporučená akce je schválená pro a čeká na provedení. Provádění –> u uživatelské databáze se používá doporučená akce. Ověření –> byla použita doporučená akce, která ověřuje její užitečnost systémem. Úspěch –> byla použita doporučená akce a během ověřování bylo nalezeno zlepšení. Čeká se na vrácení –> ověření zjistilo jen malé nebo žádné zlepšení, takže doporučená akce je zařazena do fronty pro vrácení zpět nebo se uživatel vrátil ručně. Vrácení zpět –> změny provedené při použití doporučené akce se v uživatelské databázi vrací. Vráceno –> úspěšně se vrátily změny provedené doporučenou akcí v uživatelské databázi. Ignorováno –> uživatel doporučenou akci explicitně ignoroval nebo zahodil.
RecommendedActionErrorInfo	Obsahuje informace o chybách pro doporučenou akci Azure SQL databáze, serveru nebo elastického fondu.
RecommendedActionImpactRecord	Obsahuje informace o odhadovaném nebo zjištěném dopadu na různé metriky doporučené akce Azure SQL databáze, serveru nebo elastického fondu.
RecommendedActionImplementationInfo	Obsahuje informace pro ruční implementaci doporučené akce Azure SQL databáze, serveru nebo elastického fondu.
RecommendedActionInitiatedBy	Získá, kdo inicioval provedení této doporučené akce. Možné hodnoty jsou: Uživatel –> když uživatel explicitně oznámí systému, aby použil doporučenou akci. Systém –> když byl stav automatického spuštění tohoto poradce nastavený na Povoleno, v takovém případě ho systém použil.
RecommendedActionMetricInfo	Obsahuje časové řady různých ovlivněných metrik pro doporučenou akci Azure SQL databáze, serveru nebo elastického fondu.
RecommendedActionStateInfo	Obsahuje informace o aktuálním stavu doporučené akce Azure SQL databáze, serveru nebo elastického fondu.

ImplementationMethod

Získá metodu, ve které lze tuto doporučenou akci ručně implementovat. např. TSql, AzurePowerShell.

Name	Typ	Description
AzurePowerShell	string
TSql	string

IsRetryable

Získá, zda by chyba mohla být ignorována a doporučená akce by mohla být zopakována. Možné hodnoty jsou: Ano/Ne

Name	Typ	Description
No	string
Yes	string

RecommendedAction

Doporučená akce databáze, serveru nebo elastického fondu

Name	Typ	Description
id	string	ID prostředku.
kind	string	Druh prostředku.
location	string	Umístění prostředku.
name	string	Název prostředku.
properties.details	object	Získá další podrobnosti specifické pro tuto doporučenou akci.
properties.errorDetails	RecommendedActionErrorInfo	Získá podrobnosti o chybě, pokud a proč je tato doporučená akce uvedena do chybového stavu.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Získá informace o odhadovaném dopadu pro tuto doporučenou akci, například Odhadovaný zisk procesoru, Změna odhadovaného místa na disku.
properties.executeActionDuration	string	Získá čas potřebný k použití této doporučené akce u prostředku uživatele. např. doba potřebná k vytvoření indexu
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Získá, pokud uživatel nebo systém udělil schválení pro použití této doporučené akce.
properties.executeActionInitiatedTime	string	Získá čas, kdy byla tato doporučená akce schválena pro provedení.
properties.executeActionStartTime	string	Získá čas, kdy systém začal používat tuto doporučenou akci u prostředku uživatele. Např. počáteční čas vytváření indexu
properties.implementationDetails	RecommendedActionImplementationInfo	Získá podrobnosti implementace této doporučené akce pro uživatele použít ji ručně.
properties.isArchivedAction	boolean	Získá, pokud byla tato doporučená akce navržena před nějakým časem, ale uživatel se rozhodl tuto akci ignorovat a systém znovu přidal novou doporučenou akci.
properties.isExecutableAction	boolean	Získá, pokud je tato doporučená akce použitelná uživatelem.
properties.isRevertableAction	boolean	Získá, pokud uživatel může změny použité touto doporučenou akcí vrátit zpět.
properties.lastRefresh	string	Získá čas, kdy byla tato doporučená akce naposledy aktualizována.
properties.linkedObjects	string[]	Získá propojené objekty, pokud existují.
properties.observedImpact	RecommendedActionImpactRecord[]	Získá informace o pozorovaných nebo skutečných dopadech pro tuto doporučenou akci, například skutečné získání procesoru, změna skutečného místa na disku.
properties.recommendationReason	string	Získá důvod pro doporučení této akce. Např. DuplicateIndex
properties.revertActionDuration	string	Získá čas potřebný k vrácení změn této doporučené akce u prostředku uživatele. například doba potřebná k odstranění vytvořeného indexu.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Získá, pokud uživatel nebo systém udělil schválení pro vrácení této doporučené akce.
properties.revertActionInitiatedTime	string	Získá čas, kdy byla tato doporučená akce schválena pro vrácení zpět.
properties.revertActionStartTime	string	Získá čas, kdy systém začal vracet změny této doporučené akce pro prostředek uživatele. Např. čas, kdy se spustí pokles indexu.
properties.score	integer	Získá dopad této doporučené akce. Možné hodnoty jsou 1 – Nízký dopad, 2 – Střední dopad a 3 – Vysoký dopad
properties.state	RecommendedActionStateInfo	Získá informace o aktuálním stavu, ve které se doporučená akce nachází.
properties.timeSeries	RecommendedActionMetricInfo[]	Získá informace o časových řadách metrik pro tuto doporučenou akci, například časová řada využití procesoru.
properties.validSince	string	Získá čas od doby, kdy je tato doporučená akce platná.
type	string	Typ prostředku.

RecommendedActionCurrentState

Aktuální stav, ve který je doporučená akce. Mezi běžně používané stavy patří: Aktivní –> doporučená akce je aktivní a zatím nebyla provedena žádná akce. Čeká na vyřízení –> doporučená akce je schválená pro a čeká na provedení. Provádění –> u uživatelské databáze se používá doporučená akce. Ověření –> byla použita doporučená akce, která ověřuje její užitečnost systémem. Úspěch –> byla použita doporučená akce a během ověřování bylo nalezeno zlepšení. Čeká se na vrácení –> ověření zjistilo jen malé nebo žádné zlepšení, takže doporučená akce je zařazena do fronty pro vrácení zpět nebo se uživatel vrátil ručně. Vrácení zpět –> změny provedené při použití doporučené akce se v uživatelské databázi vrací. Vráceno –> úspěšně se vrátily změny provedené doporučenou akcí v uživatelské databázi. Ignorováno –> uživatel doporučenou akci explicitně ignoroval nebo zahodil.

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

Obsahuje informace o chybách pro doporučenou akci Azure SQL databáze, serveru nebo elastického fondu.

Name	Typ	Description
errorCode	string	Získá důvod, proč byla doporučená akce uvedena do chybového stavu. Např. DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Získá, zda by chyba mohla být ignorována a doporučená akce by mohla být zopakována. Možné hodnoty jsou: Ano/Ne

RecommendedActionImpactRecord

Obsahuje informace o odhadovaném nebo zjištěném dopadu na různé metriky doporučené akce Azure SQL databáze, serveru nebo elastického fondu.

Name	Typ	Description
absoluteValue	number	Získá absolutní hodnotu této dimenze, pokud je k dispozici. Například počet ovlivněných dotazů
changeValueAbsolute	number	Získá absolutní změnu hodnoty této dimenze. Například absolutní změna místa na disku v megabajtech
changeValueRelative	number	Získá relativní změnu hodnoty této dimenze. Například relativní změna místa na disku v procentech
dimensionName	string	Získá název dimenze dopadu. Například CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Získá název dimenze dopadu. Například CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Obsahuje informace pro ruční implementaci doporučené akce Azure SQL databáze, serveru nebo elastického fondu.

Name	Typ	Description
method	ImplementationMethod	Získá metodu, ve které lze tuto doporučenou akci ručně implementovat. např. TSql, AzurePowerShell.
script	string	Získá ruční implementační skript. Například skript T-SQL, který by mohl být spuštěn v databázi.

RecommendedActionInitiatedBy

Získá, kdo inicioval provedení této doporučené akce. Možné hodnoty jsou: Uživatel –> když uživatel explicitně oznámí systému, aby použil doporučenou akci. Systém –> když byl stav automatického spuštění tohoto poradce nastavený na Povoleno, v takovém případě ho systém použil.

Name	Typ	Description
System	string
User	string

RecommendedActionMetricInfo

Obsahuje časové řady různých ovlivněných metrik pro doporučenou akci Azure SQL databáze, serveru nebo elastického fondu.

Name	Typ	Description
metricName	string	Získá název metriky. např. PROCESOR, počet dotazů.
startTime	string	Získá počáteční čas časového intervalu dané tímto MetricInfo.
timeGrain	string	Získá dobu trvání časového intervalu pro hodnotu danou tímto MetricInfo. např. PT1H (1 hodina)
unit	string	Získá jednotku, ve které se měří metrika. např. DTU, frekvence
value	number	Získá hodnotu metriky v časovém intervalu zadaném tímto MetricInfo.

RecommendedActionStateInfo

Obsahuje informace o aktuálním stavu doporučené akce Azure SQL databáze, serveru nebo elastického fondu.

Name	Typ	Description
actionInitiatedBy	RecommendedActionInitiatedBy	Získá, kdo inicioval provedení této doporučené akce. Možné hodnoty jsou: Uživatel –> když uživatel explicitně oznámí systému, aby použil doporučenou akci. Systém –> když byl stav automatického spuštění tohoto poradce nastavený na Povoleno, v takovém případě ho systém použil.
currentValue	RecommendedActionCurrentState	Aktuální stav, ve který je doporučená akce. Mezi běžně používané stavy patří: Aktivní –> doporučená akce je aktivní a zatím nebyla provedena žádná akce. Čeká na vyřízení –> doporučená akce je schválená pro a čeká na provedení. Provádění –> u uživatelské databáze se používá doporučená akce. Ověření –> byla použita doporučená akce, která ověřuje její užitečnost systémem. Úspěch –> byla použita doporučená akce a během ověřování bylo nalezeno zlepšení. Čeká se na vrácení –> ověření zjistilo jen malé nebo žádné zlepšení, takže doporučená akce je zařazena do fronty pro vrácení zpět nebo se uživatel vrátil ručně. Vrácení zpět –> změny provedené při použití doporučené akce se v uživatelské databázi vrací. Vráceno –> úspěšně se vrátily změny provedené doporučenou akcí v uživatelské databázi. Ignorováno –> uživatel doporučenou akci explicitně ignoroval nebo zahodil.
lastModified	string	Získá čas poslední změny stavu.

Sdílet prostřednictvím

Database Recommended Actions - Get

Parametry identifikátoru URI

Odpovědi

Příklady

Get database recommended action

Ukázkový požadavek

Ukázková odpověď

Definice

ImplementationMethod

IsRetryable

RecommendedAction

RecommendedActionCurrentState

RecommendedActionErrorInfo

RecommendedActionImpactRecord

RecommendedActionImplementationInfo

RecommendedActionInitiatedBy

RecommendedActionMetricInfo

RecommendedActionStateInfo

Další materiály