Database Advisors - Get

Ссылка

Служба:: SQL Database

Версия API:: 2021-11-01

Возвращает помощник по базам данных.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
advisorName	path	True	string	Имя помощника по базам данных.
databaseName	path	True	string	Имя базы данных.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.

Ответы

Имя	Тип	Описание
200 OK	Advisor	Сведения об указанном помощнике по базам данных успешно получены.
Other Status Codes		Ответы об ошибках: *** 400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных. 400 InvalidIdentifier — идентификатор содержит значение NULL или недопустимый символ Юникода. 400 DataWarehouseNotSupported — автоматическая настройка не поддерживается для sql Data Warehouse. 404 DatabaseDoesNotExist — запрошенная база данных не найдена 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден. 404 SubscriptionDoesNotHaveElasticPool — запрошенный эластичный пул не найден 404 AdvisorNotFound — запрошенный помощник не найден. 405 NotSupported — эта функция не поддерживается. 409 Conflict — не удалось обработать запрос из-за конфликта в запросе. 503 ServiceTemporarilyUnavailable — компонент временно недоступен.

Имя

Тип

Описание

200 OK

Advisor

Сведения об указанном помощнике по базам данных успешно получены.

Other Status Codes

Ответы об ошибках: ***

400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных.
400 InvalidIdentifier — идентификатор содержит значение NULL или недопустимый символ Юникода.
400 DataWarehouseNotSupported — автоматическая настройка не поддерживается для sql Data Warehouse.
404 DatabaseDoesNotExist — запрошенная база данных не найдена
404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден.
404 SubscriptionDoesNotHaveElasticPool — запрошенный эластичный пул не найден
404 AdvisorNotFound — запрошенный помощник не найден.
405 NotSupported — эта функция не поддерживается.
409 Conflict — не удалось обработать запрос из-за конфликта в запросе.
503 ServiceTemporarilyUnavailable — компонент временно недоступен.

Примеры

Get database advisor

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?api-version=2021-11-01


/**
 * Samples for DatabaseAdvisors Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseAdvisorGet.json
     */
    /**
     * Sample code: Get database advisor.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getDatabaseAdvisor(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseAdvisors().getWithResponse("workloadinsight-demos",
            "misosisvr", "IndexAdvisor_test_3", "CreateIndex", 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

Пример ответа

Код состояния:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/databases/IndexAdvisor_test_3/advisors/CreateIndex",
  "name": "CreateIndex",
  "type": "Microsoft.Sql/servers/databases/advisors",
  "properties": {
    "advisorStatus": "GA",
    "autoExecuteStatus": "Disabled",
    "recommendationsStatus": "Ok",
    "lastChecked": "2017-06-20T00:24:39Z"
  }
}

Определения

Имя	Описание
Advisor	Помощник по базам данных, серверам или эластичным пулам.
AdvisorStatus	Возвращает состояние доступности этого помощника для клиентов. Возможные значения: GA, PublicPreview, LimitedPublicPreview и PrivatePreview.
AutoExecuteStatus	Возвращает состояние автоматического выполнения (следует ли разрешить системе выполнять рекомендации) этого помощника. Возможные значения: Enabled и Disabled.
AutoExecuteStatusInheritedFrom	Возвращает ресурс, от которого наследуется текущее значение состояния автоматического выполнения. Состояние автоматического выполнения можно задать на разных уровнях иерархии ресурсов (и наследовать от нее). Возможные значения: Subscription, Server, ElasticPool, Database и Default (если состояние не задано явным образом на любом уровне).
ImplementationMethod	Возвращает метод, в котором это рекомендуемое действие можно реализовать вручную. Например, TSql, AzurePowerShell.
IsRetryable	Возвращает значение, указывающее, можно ли игнорировать ошибку и можно ли повторить рекомендуемое действие. Возможные значения: Да или Нет.
RecommendedAction	Рекомендуемое действие базы данных, сервера или эластичного пула.
RecommendedActionCurrentState	Текущее состояние рекомендуемого действия. Некоторые часто используемые состояния: Активный —> рекомендуемое действие активно и еще не выполнено никаких действий. Ожидание —> рекомендуемое действие утверждено для и ожидает выполнения. Выполнение —> к пользовательской базе данных применяется рекомендуемое действие. Проверка —> было применено рекомендуемое действие, и система проверяет его полезность. Успешно —> во время проверки было применено рекомендуемое действие, а во время проверки обнаружено улучшение. Ожидание отмены —> проверка не нашла никаких улучшений, поэтому рекомендуемое действие помещается в очередь для отменить изменения или пользователь был отменен вручную. Восстановление — изменения,> внесенные при применении рекомендуемого действия, восстанавливаются в пользовательской базе данных. Reverted —> успешно отменены изменения, внесенные рекомендуемым действием в пользовательской базе данных. Игнорируется —> пользователь явно игнорирует или отменяет рекомендуемое действие.
RecommendedActionErrorInfo	Содержит сведения об ошибке для рекомендуемого действия базы данных Azure SQL, сервера или эластичного пула.
RecommendedActionImpactRecord	Содержит сведения о предполагаемом или наблюдаемом влиянии на различные метрики для рекомендуемого действия базы данных Azure SQL, сервера или эластичного пула.
RecommendedActionImplementationInfo	Содержит сведения о реализации вручную для рекомендуемого действия базы данных Azure SQL, сервера или эластичного пула.
RecommendedActionInitiatedBy	Возвращает, кто инициировал выполнение этого рекомендуемого действия. Возможные значения: Пользователь —> когда пользователь явно уведомляет систему о применении рекомендуемого действия. Система —> если для этого помощника задано состояние "Включено", в этом случае система применила его.
RecommendedActionMetricInfo	Содержит временные ряды различных затронутых метрик для рекомендуемого действия Azure SQL базы данных, сервера или эластичного пула.
RecommendedActionStateInfo	Содержит сведения о текущем состоянии для рекомендуемого действия базы данных Azure SQL, сервера или эластичного пула.

Advisor

Object

Помощник по базам данных, серверам или эластичным пулам.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
kind	string	Тип ресурса.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.advisorStatus	AdvisorStatus	Возвращает состояние доступности этого помощника для клиентов. Возможные значения: GA, PublicPreview, LimitedPublicPreview и PrivatePreview.
properties.autoExecuteStatus	AutoExecuteStatus	Возвращает состояние автоматического выполнения (следует ли разрешить системе выполнять рекомендации) этого помощника. Возможные значения: Enabled и Disabled.
properties.autoExecuteStatusInheritedFrom	AutoExecuteStatusInheritedFrom	Возвращает ресурс, от которого наследуется текущее значение состояния автоматического выполнения. Состояние автоматического выполнения можно задать на разных уровнях иерархии ресурсов (и наследовать от нее). Возможные значения: Subscription, Server, ElasticPool, Database и Default (если состояние не задано явным образом на любом уровне).
properties.lastChecked	string	Возвращает время, когда текущий ресурс был проанализирован на предмет рекомендаций этим помощником.
properties.recommendationsStatus	string	Возвращает состояние рекомендаций для этого помощника и причину, по которой рекомендации отсутствуют. Возможные значения: "ОК" (доступны рекомендации), LowActivity (недостаточно рабочей нагрузки для анализа), DbSeemsTuned (база данных работает хорошо) и т. д.
properties.recommendedActions	RecommendedAction[]	Возвращает рекомендуемые действия для этого помощника.
type	string	Тип ресурса.

AdvisorStatus

Enumeration

Возвращает состояние доступности этого помощника для клиентов. Возможные значения: GA, PublicPreview, LimitedPublicPreview и PrivatePreview.

Значение	Описание
GA
LimitedPublicPreview
PrivatePreview
PublicPreview

AutoExecuteStatus

Enumeration

Возвращает состояние автоматического выполнения (следует ли разрешить системе выполнять рекомендации) этого помощника. Возможные значения: Enabled и Disabled.

Значение	Описание
Default
Disabled
Enabled

AutoExecuteStatusInheritedFrom

Enumeration

Возвращает ресурс, от которого наследуется текущее значение состояния автоматического выполнения. Состояние автоматического выполнения можно задать на разных уровнях иерархии ресурсов (и наследовать от нее). Возможные значения: Subscription, Server, ElasticPool, Database и Default (если состояние не задано явным образом на любом уровне).

Значение	Описание
Database
Default
ElasticPool
Server
Subscription

ImplementationMethod

Enumeration

Возвращает метод, в котором это рекомендуемое действие можно реализовать вручную. Например, TSql, AzurePowerShell.

Значение	Описание
AzurePowerShell
TSql

IsRetryable

Enumeration

Возвращает значение, указывающее, можно ли игнорировать ошибку и можно ли повторить рекомендуемое действие. Возможные значения: Да или Нет.

Значение	Описание
No
Yes

RecommendedAction

Object

Рекомендуемое действие базы данных, сервера или эластичного пула.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
kind	string	Тип ресурса.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.details	object	Получает дополнительные сведения, относящиеся к этому рекомендуемму действию.
properties.errorDetails	RecommendedActionErrorInfo	Возвращает сведения об ошибке, если и почему это рекомендуемое действие переводится в состояние ошибки.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Возвращает сведения о предполагаемом влиянии для этого рекомендуемого действия, например, предполагаемое увеличение загрузки ЦП, предполагаемое изменение места на диске.
properties.executeActionDuration	string	Возвращает время, затраченное на применение этого рекомендуемого действия к ресурсу пользователя. Например, время, затраченного на создание индекса
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Возвращает значение, если пользователь или система предоставили разрешение на применение этого рекомендуемого действия.
properties.executeActionInitiatedTime	string	Возвращает время, когда это рекомендуемое действие было утверждено для выполнения.
properties.executeActionStartTime	string	Возвращает время, когда система начала применять это рекомендуемое действие к ресурсу пользователя. Например, время начала создания индекса
properties.implementationDetails	RecommendedActionImplementationInfo	Получает сведения о реализации этого рекомендуемого действия, чтобы пользователь применил его вручную.
properties.isArchivedAction	boolean	Возвращает значение , если это рекомендуемое действие было предложено некоторое время назад, но пользователь решил проигнорировать это действие и система снова добавила новое рекомендуемое действие.
properties.isExecutableAction	boolean	Возвращает значение, если это рекомендуемое действие доступно для пользователя
properties.isRevertableAction	boolean	Возвращает , если изменения, примененные этим рекомендуемым действием, могут быть отменены пользователем
properties.lastRefresh	string	Возвращает время последнего обновления рекомендуемого действия.
properties.linkedObjects	string[]	Возвращает связанные объекты , если таковые есть.
properties.observedImpact	RecommendedActionImpactRecord[]	Возвращает наблюдаемые или фактические сведения о влиянии для этого рекомендуемого действия, например фактическое увеличение загрузки ЦП, фактическое изменение места на диске.
properties.recommendationReason	string	Возвращает причину для рекомендации этого действия. Например, DuplicateIndex
properties.revertActionDuration	string	Возвращает время, затраченное на отмену изменений этого рекомендуемого действия для ресурса пользователя. Например, время, затраченного на удаление созданного индекса.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Возвращает значение , если пользователь или система предоставили разрешение на отмену этого рекомендуемого действия.
properties.revertActionInitiatedTime	string	Возвращает время утверждения рекомендуемого действия для отменить изменения.
properties.revertActionStartTime	string	Возвращает время, когда система начала возвращать изменения этого рекомендуемого действия для ресурса пользователя. Например, время, когда выполняется удаление индекса.
properties.score	integer	Возвращает влияние этого рекомендуемого действия. Возможные значения: 1 — низкое влияние, 2 — среднее влияние и 3 — высокое влияние.
properties.state	RecommendedActionStateInfo	Возвращает сведения о текущем состоянии рекомендуемого действия.
properties.timeSeries	RecommendedActionMetricInfo[]	Возвращает сведения о временных рядах метрик для этого рекомендуемого действия, например временных рядов потребления ЦП.
properties.validSince	string	Возвращает время с момента, когда это рекомендуемое действие является допустимым.
type	string	Тип ресурса.

RecommendedActionCurrentState

Enumeration

Текущее состояние рекомендуемого действия. Некоторые часто используемые состояния: Активный —> рекомендуемое действие активно и еще не выполнено никаких действий. Ожидание —> рекомендуемое действие утверждено для и ожидает выполнения. Выполнение —> к пользовательской базе данных применяется рекомендуемое действие. Проверка —> было применено рекомендуемое действие, и система проверяет его полезность. Успешно —> во время проверки было применено рекомендуемое действие, а во время проверки обнаружено улучшение. Ожидание отмены —> проверка не нашла никаких улучшений, поэтому рекомендуемое действие помещается в очередь для отменить изменения или пользователь был отменен вручную. Восстановление — изменения,> внесенные при применении рекомендуемого действия, восстанавливаются в пользовательской базе данных. Reverted —> успешно отменены изменения, внесенные рекомендуемым действием в пользовательской базе данных. Игнорируется —> пользователь явно игнорирует или отменяет рекомендуемое действие.

Значение	Описание
Active
Error
Executing
Expired
Ignored
Monitoring
Pending
PendingRevert
Resolved
RevertCancelled
Reverted
Reverting
Success
Verifying

RecommendedActionErrorInfo

Object

Содержит сведения об ошибке для рекомендуемого действия базы данных Azure SQL, сервера или эластичного пула.

Имя	Тип	Описание
errorCode	string	Возвращает причину, по которой рекомендуемое действие было помещено в состояние ошибки. Например, DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Возвращает значение, указывающее, можно ли игнорировать ошибку и можно ли повторно выполнить рекомендуемое действие. Возможные значения: Да/Нет

RecommendedActionImpactRecord

Object

Содержит сведения о предполагаемом или наблюдаемом влиянии на различные метрики для рекомендуемого действия базы данных Azure SQL, сервера или эластичного пула.

Имя	Тип	Описание
absoluteValue	number	Возвращает абсолютное значение этого измерения, если применимо. Например, число затронутых запросов
changeValueAbsolute	number	Возвращает абсолютное изменение значения этого измерения. Например, изменение абсолютного места на диске в мегабайтах
changeValueRelative	number	Возвращает относительное изменение значения этого измерения. Например, изменение относительного места на диске в процентах
dimensionName	string	Возвращает имя измерения влияния. Например, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Возвращает имя измерения влияния. Например, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Object

Содержит сведения о реализации вручную для рекомендуемого действия базы данных Azure SQL, сервера или эластичного пула.

Имя	Тип	Описание
method	ImplementationMethod	Возвращает метод, в котором это рекомендуемое действие можно реализовать вручную. Например, TSql, AzurePowerShell.
script	string	Возвращает скрипт реализации вручную. Например, скрипт T-SQL, который может выполняться в базе данных.

RecommendedActionInitiatedBy

Enumeration

Возвращает, кто инициировал выполнение этого рекомендуемого действия. Возможные значения: Пользователь —> когда пользователь явно уведомляет систему о применении рекомендуемого действия. Система —> если для этого помощника задано состояние "Включено", в этом случае система применила его.

Значение	Описание
System
User

RecommendedActionMetricInfo

Object

Содержит временные ряды различных затронутых метрик для рекомендуемого действия Azure SQL базы данных, сервера или эластичного пула.

Имя	Тип	Описание
metricName	string	Возвращает имя метрики. Например, ЦП, количество запросов.
startTime	string	Возвращает время начала интервала времени, заданного данным MetricInfo.
timeGrain	string	Возвращает длительность интервала времени для значения, заданного данным MetricInfo. Например, PT1H (1 час)
unit	string	Возвращает единицу измерения метрики. Например, DTU, Frequency
value	number	Возвращает значение метрики в интервале времени, заданном данной MetricInfo.

RecommendedActionStateInfo

Object

Содержит сведения о текущем состоянии для рекомендуемого действия базы данных Azure SQL, сервера или эластичного пула.

Имя	Тип	Описание
actionInitiatedBy	RecommendedActionInitiatedBy	Возвращает, кто инициировал выполнение этого рекомендуемого действия. Возможные значения: Пользователь —> когда пользователь явно уведомляет систему о применении рекомендуемого действия. Система —> если для этого помощника задано состояние "Включено", в этом случае система применила его.
currentValue	RecommendedActionCurrentState	Текущее состояние, в которое находится рекомендуемое действие. Некоторые часто используемые состояния: Активный —> рекомендуемое действие активно и действие еще не выполнено. Ожидание —> рекомендуемое действие утверждено для и ожидает выполнения. Выполнение —> рекомендуемое действие применяется к пользовательской базе данных. Проверка —> рекомендуемое действие было применено и проверяется системой на его полезность. Успешно —> было применено рекомендуемое действие, а во время проверки обнаружено улучшение. Ожидание возврата —> проверка не обнаружила практически никаких улучшений, поэтому рекомендуемое действие помещается в очередь для отменить изменения или пользователь был возвращен вручную. Возврат —> изменения, внесенные при применении рекомендуемого действия, отменяются в пользовательской базе данных. Возвращено —> успешно отменены изменения, внесенные рекомендуемым действием для пользовательской базы данных. Игнорируется —> пользователь явно проигнорировал или отбросил рекомендуемое действие.
lastModified	string	Возвращает время последнего изменения состояния.

Поделиться через

Database Advisors - Get

Параметры URI

Ответы

Примеры

Get database advisor

Образец запроса

Пример ответа

Определения

Advisor

AdvisorStatus

AutoExecuteStatus

AutoExecuteStatusInheritedFrom

ImplementationMethod

IsRetryable

RecommendedAction

RecommendedActionCurrentState

RecommendedActionErrorInfo

RecommendedActionImpactRecord

RecommendedActionImplementationInfo

RecommendedActionInitiatedBy

RecommendedActionMetricInfo

RecommendedActionStateInfo

Дополнительные ресурсы