Database Recommended Actions - Update

  • Odwołanie
Usługa:
SQL Database
Wersja interfejsu API:
2021-11-01

Aktualizacje zalecaną akcję bazy danych.

PATCH 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 identyfikatora URI

Nazwa W Wymagane Typ Opis
advisorName
 path True

string

Nazwa doradcy bazy danych.
databaseName
 path True

string

Nazwa bazy danych.
recommendedActionName
 path True

string

Nazwa zalecanej akcji bazy danych.
resourceGroupName
 path True

string

Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API Resource Manager platformy Azure lub portalu.
serverName
 path True

string

Nazwa serwera.
subscriptionId
 path True

string

Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version
 query True

string

Wersja interfejsu API do użycia dla żądania.

Treść żądania

Nazwa Wymagane Typ Opis
properties.state True

RecommendedActionStateInfo

Pobiera informacje o bieżącym stanie, w których znajduje się zalecana akcja.

Odpowiedzi

Nazwa Typ Opis
200 OK

RecommendedAction

Pomyślnie zaktualizowano zalecaną akcję określonej bazy danych.
Other Status Codes

Odpowiedzi na błędy: ***

  • 400 FeatureDisabledOnSelectedEdition — użytkownik próbował użyć funkcji wyłączonej w bieżącej wersji bazy danych.

  • 400 InvalidIdentifier — identyfikator zawiera wartość NULL lub nieprawidłowy znak Unicode.

  • 400 InvalidRecommendedActionUpsertRequest — zalecana treść żądania akcji aktualizacji nie istnieje lub nie ma właściwości ani obiektu stanu.

  • 400 InvalidRecommendedActionState — określony stan zalecanej akcji jest nieprawidłowy

  • 404 DatabaseDoesNotExist — żądana baza danych nie została znaleziona

  • 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera

  • 404 SubscriptionDoesNotHaveElasticPool — nie znaleziono żądanej elastycznej puli

  • 404 AdvisorNotFound — nie znaleziono żądanego doradcy.

  • 404 RecommendedActionNotFound — nie znaleziono żądanej zalecanej akcji.

  • 404 AdvisorNotFound — nie znaleziono żądanego doradcy.

  • 404 RecommendedActionNotFound — nie znaleziono żądanej zalecanej akcji.

  • 405 Nieobsługiwane — ta funkcja nie jest obsługiwana.

  • 409 Konflikt — nie można przetworzyć żądania z powodu konfliktu w żądaniu.

  • 503 ServiceTemporarilyUnavailable — funkcja jest tymczasowo niedostępna.

Przykłady

Przykładowe żądanie

PATCH 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

{
  "properties": {
    "state": {
      "currentValue": "Pending"
    }
  }
}

Przykładowa odpowiedź

Kod stanu:
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": "Pending",
      "actionInitiatedBy": "User",
      "lastModified": "2017-06-20T15:11:15Z"
    },
    "isExecutableAction": true,
    "isRevertableAction": true,
    "isArchivedAction": false,
    "executeActionInitiatedBy": "User",
    "executeActionInitiatedTime": "2017-06-20T15:11:15Z",
    "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]"
    }
  }
}

Definicje

Nazwa Opis
ImplementationMethod

Pobiera metodę, w której tę zalecaną akcję można zaimplementować ręcznie. np. TSql, AzurePowerShell.
IsRetryable

Pobiera informację o tym, czy można zignorować błąd i można ponowić zalecaną akcję. Możliwe wartości to: Tak/Nie
RecommendedAction

Zalecana akcja bazy danych, serwera lub puli elastycznej.
RecommendedActionCurrentState

Bieżący stan, w których znajduje się zalecana akcja. Niektóre często używane stany to: Aktywne —> zalecana akcja jest aktywna i nie podjęto jeszcze żadnej akcji. Oczekujące —> zalecana akcja jest zatwierdzana i oczekuje na wykonanie. Wykonywanie —> zalecana akcja jest stosowana w bazie danych użytkownika. Weryfikowanie —> zastosowano zalecaną akcję i jest weryfikowana jej użyteczność przez system. Powodzenie —> zastosowano zalecaną akcję i znaleziono ulepszenia podczas weryfikacji. Oczekiwanie na przywrócenie —> weryfikacja nie wykryła niewielkiego lub żadnego ulepszenia, dlatego zalecana akcja jest w kolejce w celu przywracania lub ręcznego przywracania użytkownika. Przywracanie —> zmiany wprowadzone podczas stosowania zalecanej akcji są przywracane w bazie danych użytkowników. Przywrócono —> pomyślnie przywrócono zmiany wprowadzone przez zalecaną akcję w bazie danych użytkowników. Zignorowane —> użytkownik jawnie zignorował/odrzucił zalecaną akcję.
RecommendedActionErrorInfo

Zawiera informacje o błędach zalecanej akcji Azure SQL Database, Server lub Elastic Pool.
RecommendedActionImpactRecord

Zawiera informacje o szacowanym lub obserwowanym wpływie na różne metryki dla zalecanej akcji Azure SQL Database, Server lub Elastic Pool.
RecommendedActionImplementationInfo

Zawiera informacje dotyczące ręcznej implementacji zalecanej akcji bazy danych Azure SQL, serwera lub puli elastycznej.
RecommendedActionInitiatedBy

Pobiera, kto zainicjował wykonanie tej zalecanej akcji. Możliwa wartość to: Użytkownik —> gdy użytkownik jawnie powiadomił system o zastosowaniu zalecanej akcji. System —> po ustawieniu stanu automatycznego wykonywania tego doradcy na wartość "Włączone", w takim przypadku system go zastosował.
RecommendedActionMetricInfo

Zawiera szereg czasowy różnych metryk, których dotyczy Azure SQL baza danych, serwer lub zalecana akcja puli elastycznej.
RecommendedActionStateInfo

Zawiera informacje o bieżącym stanie zalecanej akcji bazy danych Azure SQL, serwera lub puli elastycznej.

ImplementationMethod

Pobiera metodę, w której tę zalecaną akcję można zaimplementować ręcznie. np. TSql, AzurePowerShell.

Nazwa Typ Opis
AzurePowerShell

string

TSql

string

IsRetryable

Pobiera informację o tym, czy można zignorować błąd i można ponowić zalecaną akcję. Możliwe wartości to: Tak/Nie

Nazwa Typ Opis
No

string

Yes

string

RecommendedAction

Zalecana akcja bazy danych, serwera lub puli elastycznej.

Nazwa Typ Opis
id

string

Identyfikator zasobu.
kind

string

Rodzaj zasobu.
location

string

Lokalizacja zasobu.
name

string

Nazwa zasobu.
properties.details

object

Pobiera dodatkowe szczegóły specyficzne dla tej zalecanej akcji.
properties.errorDetails

RecommendedActionErrorInfo

Pobiera szczegóły błędu, jeśli i dlaczego ta zalecana akcja jest umieszczana w stanie błędu.
properties.estimatedImpact

RecommendedActionImpactRecord[]

Pobiera szacowane informacje o wpływie dla tej zalecanej akcji, np. Szacowany zysk procesora CPU, Szacowana zmiana miejsca na dysku
properties.executeActionDuration

string

Pobiera czas stosowania tej zalecanej akcji dla zasobu użytkownika. np. czas potrzebny na utworzenie indeksu
properties.executeActionInitiatedBy

RecommendedActionInitiatedBy

Pobiera, jeśli zatwierdzenie zastosowania tej zalecanej akcji zostało podane przez użytkownika/system.
properties.executeActionInitiatedTime

string

Pobiera czas zatwierdzenia tej zalecanej akcji do wykonania.
properties.executeActionStartTime

string

Pobiera czas rozpoczęcia stosowania tej zalecanej akcji dla zasobu użytkownika. np. czas rozpoczęcia tworzenia indeksu
properties.implementationDetails

RecommendedActionImplementationInfo

Pobiera szczegóły implementacji tej zalecanej akcji dla użytkownika, aby zastosować ją ręcznie.
properties.isArchivedAction

boolean

Pobiera, jeśli ta zalecana akcja została zasugerowana jakiś czas temu, ale użytkownik zdecydował się zignorować to i system ponownie dodał nową zalecaną akcję.
properties.isExecutableAction

boolean

Pobiera, jeśli ta zalecana akcja jest wykonywana przez użytkownika
properties.isRevertableAction

boolean

Pobiera, jeśli zmiany zastosowane przez tę zalecaną akcję mogą zostać przywrócone przez użytkownika
properties.lastRefresh

string

Pobiera czas ostatniego odświeżenia tej zalecanej akcji.
properties.linkedObjects

string[]

Pobiera połączone obiekty, jeśli istnieją.
properties.observedImpact

RecommendedActionImpactRecord[]

Pobiera zaobserwowane/rzeczywiste informacje o wpływie dla tej zalecanej akcji, np. rzeczywistego zysku procesora CPU, rzeczywista zmiana miejsca na dysku
properties.recommendationReason

string

Pobiera przyczynę rekomendowania tej akcji. np. DuplicateIndex
properties.revertActionDuration

string

Pobiera czas potrzebny na przywrócenie zmian tej zalecanej akcji dotyczącej zasobu użytkownika. np. czas potrzebny na usunięcie utworzonego indeksu.
properties.revertActionInitiatedBy

RecommendedActionInitiatedBy

Pobiera, jeśli zatwierdzenie do przywracania tej zalecanej akcji zostało podane przez użytkownika/system.
properties.revertActionInitiatedTime

string

Pobiera czas, kiedy ta zalecana akcja została zatwierdzona do przywracania.
properties.revertActionStartTime

string

Pobiera czas, kiedy system zaczął przywracać zmiany tej zalecanej akcji dla zasobu użytkownika. Np. czas wykonywania spadku indeksu.
properties.score

integer

Pobiera wpływ tej zalecanej akcji. Możliwe wartości to 1 — niski wpływ, 2 — średni wpływ i 3 — duży wpływ
properties.state

RecommendedActionStateInfo

Pobiera informacje o bieżącym stanie, w których znajduje się zalecana akcja.
properties.timeSeries

RecommendedActionMetricInfo[]

Pobiera informacje o szeregach czasowych metryk dla tej zalecanej akcji, np. szeregi czasowe użycia procesora CPU
properties.validSince

string

Pobiera czas od momentu, gdy ta zalecana akcja jest prawidłowa.
type

string

Typ zasobu.

RecommendedActionCurrentState

Bieżący stan, w których znajduje się zalecana akcja. Niektóre często używane stany to: Aktywne —> zalecana akcja jest aktywna i nie podjęto jeszcze żadnej akcji. Oczekujące —> zalecana akcja jest zatwierdzana i oczekuje na wykonanie. Wykonywanie —> zalecana akcja jest stosowana w bazie danych użytkownika. Weryfikowanie —> zastosowano zalecaną akcję i jest weryfikowana jej użyteczność przez system. Powodzenie —> zastosowano zalecaną akcję i znaleziono ulepszenia podczas weryfikacji. Oczekiwanie na przywrócenie —> weryfikacja nie wykryła niewielkiego lub żadnego ulepszenia, dlatego zalecana akcja jest w kolejce w celu przywracania lub ręcznego przywracania użytkownika. Przywracanie —> zmiany wprowadzone podczas stosowania zalecanej akcji są przywracane w bazie danych użytkowników. Przywrócono —> pomyślnie przywrócono zmiany wprowadzone przez zalecaną akcję w bazie danych użytkowników. Zignorowane —> użytkownik jawnie zignorował/odrzucił zalecaną akcję.

Nazwa Typ Opis
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

Zawiera informacje o błędach zalecanej akcji Azure SQL Database, Server lub Elastic Pool.

Nazwa Typ Opis
errorCode

string

Pobiera przyczynę, dla którego zalecana akcja została umieszczona w stanie błędu. np. DatabaseHasQdsOff, IndexAlreadyExists
isRetryable

IsRetryable

Pobiera informację o tym, czy można zignorować błąd i można ponowić zalecaną akcję. Możliwe wartości to: Tak/Nie

RecommendedActionImpactRecord

Zawiera informacje o szacowanym lub obserwowanym wpływie na różne metryki dla zalecanej akcji Azure SQL Database, Server lub Elastic Pool.

Nazwa Typ Opis
absoluteValue

number

Pobiera wartość bezwzględną tego wymiaru, jeśli ma to zastosowanie. np. liczba zapytań, których dotyczy problem
changeValueAbsolute

number

Pobiera bezwzględną zmianę wartości tego wymiaru. np. Zmiana miejsca na dysku bezwzględnym w megabajtach
changeValueRelative

number

Pobiera względną zmianę wartości tego wymiaru. np. względna zmiana miejsca na dysku w procentach
dimensionName

string

Pobiera nazwę wymiaru wpływu. np. CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit

string

Pobiera nazwę wymiaru wpływu. np. CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Zawiera informacje dotyczące ręcznej implementacji zalecanej akcji bazy danych Azure SQL, serwera lub puli elastycznej.

Nazwa Typ Opis
method

ImplementationMethod

Pobiera metodę, w której tę zalecaną akcję można zaimplementować ręcznie. np. TSql, AzurePowerShell.
script

string

Pobiera skrypt implementacji ręcznej. Np. skrypt języka T-SQL, który można wykonać w bazie danych.

RecommendedActionInitiatedBy

Pobiera, kto zainicjował wykonanie tej zalecanej akcji. Możliwa wartość to: Użytkownik —> gdy użytkownik jawnie powiadomił system o zastosowaniu zalecanej akcji. System —> po ustawieniu stanu automatycznego wykonywania tego doradcy na wartość "Włączone", w takim przypadku system go zastosował.

Nazwa Typ Opis
System

string

User

string

RecommendedActionMetricInfo

Zawiera szereg czasowy różnych metryk, których dotyczy Azure SQL baza danych, serwer lub zalecana akcja puli elastycznej.

Nazwa Typ Opis
metricName

string

Pobiera nazwę metryki. np. procesor CPU, liczba zapytań.
startTime

string

Pobiera czas rozpoczęcia interwału czasu podany przez tę wartość MetricInfo.
timeGrain

string

Pobiera czas trwania interwału czasu dla wartości podanej przez tę wartość MetricInfo. np. PT1H (1 godzina)
unit

string

Pobiera jednostkę, w której mierzona jest metryka. np. DTU, częstotliwość
value

number

Pobiera wartość metryki w interwale czasu podanym przez tę wartość MetricInfo.

RecommendedActionStateInfo

Zawiera informacje o bieżącym stanie zalecanej akcji bazy danych Azure SQL, serwera lub puli elastycznej.

Nazwa Typ Opis
actionInitiatedBy

RecommendedActionInitiatedBy

Pobiera, kto zainicjował wykonanie tej zalecanej akcji. Możliwa wartość to: Użytkownik —> gdy użytkownik jawnie powiadomił system o zastosowaniu zalecanej akcji. System —> po ustawieniu stanu automatycznego wykonywania tego doradcy na wartość "Włączone", w takim przypadku system go zastosował.
currentValue

RecommendedActionCurrentState

Bieżący stan, w których znajduje się zalecana akcja. Niektóre często używane stany to: Aktywne —> zalecana akcja jest aktywna i nie podjęto jeszcze żadnej akcji. Oczekujące —> zalecana akcja jest zatwierdzana i oczekuje na wykonanie. Wykonywanie —> zalecana akcja jest stosowana w bazie danych użytkownika. Weryfikowanie —> zastosowano zalecaną akcję i jest weryfikowana jej użyteczność przez system. Powodzenie —> zastosowano zalecaną akcję i znaleziono ulepszenia podczas weryfikacji. Oczekiwanie na przywrócenie —> weryfikacja nie wykryła niewielkiego lub żadnego ulepszenia, dlatego zalecana akcja jest w kolejce w celu przywracania lub ręcznego przywracania użytkownika. Przywracanie —> zmiany wprowadzone podczas stosowania zalecanej akcji są przywracane w bazie danych użytkowników. Przywrócono —> pomyślnie przywrócono zmiany wprowadzone przez zalecaną akcję w bazie danych użytkowników. Zignorowane —> użytkownik jawnie zignorował/odrzucił zalecaną akcję.
lastModified

string

Pobiera czas ostatniej modyfikacji stanu