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


Database Automatic Tuning - Get

Возвращает автоматическую настройку базы данных.

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

Параметры URI

Имя В Обязательно Тип Описание
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

DatabaseAutomaticTuning

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

Other Status Codes

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

  • 400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных.

  • 400 InvalidIdentifier — идентификатор содержит значение NULL или недопустимый символ Юникода.

  • 400 SystemDatabasesNotSupported — пользователь пытался получить сведения об автоматической настройке системных баз данных.

  • 400 DataWarehouseNotSupported — автоматическая настройка не поддерживается для sql Data Warehouse.

  • 404 DatabaseDoesNotExist — запрошенная база данных не найдена

  • 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден.

  • 404 SubscriptionDoesNotHaveElasticPool — запрошенный эластичный пул не найден

  • 404 OperationIdNotFound — операция с идентификатором не существует.

  • 405 NotSupported — эта функция не поддерживается.

  • 409 Conflict — не удалось обработать запрос из-за конфликта в запросе.

  • 409 OperationCancelled — операция была отменена пользователем.

  • 409 OperationInterrupted — не удалось завершить операцию с ресурсом, так как она была прервана другой операцией с тем же ресурсом.

  • 429 SubscriptionTooManyCreateUpdateRequests — запросы сверх максимального количества запросов, которые могут быть обработаны доступными ресурсами.

  • 429 SubscriptionTooManyRequests — запросы, превышающие максимальное количество запросов, которые могут быть обработаны доступными ресурсами.

  • 500 OperationTimedOut — время ожидания операции истекло и автоматически откатывается. Повторите операцию.

  • 503 ServiceTemporarilyUnavailable — компонент временно недоступен.

  • 503 TooManyRequests — запросы сверх максимального числа запросов, которые могут быть обработаны доступными ресурсами.

Примеры

Get a database's automatic tuning settings

Sample Request

GET https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current?api-version=2021-11-01

Sample Response

{
  "id": "/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/automaticTuning",
  "properties": {
    "desiredState": "Auto",
    "actualState": "Auto",
    "options": {
      "forceLastGoodPlan": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "createIndex": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "dropIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "maintainIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

Определения

Имя Описание
AutomaticTuningDisabledReason

При необходимости описание причины и фактическое состояние отличаются.

AutomaticTuningMode

Автоматическая настройка требуемого состояния.

AutomaticTuningOptionModeActual

Фактическое состояние параметра автоматической настройки.

AutomaticTuningOptionModeDesired

Требуемое состояние параметра автоматической настройки.

AutomaticTuningOptions

Свойства автоматической настройки для отдельных помощников.

DatabaseAutomaticTuning

Автоматическая настройка на уровне базы данных.

AutomaticTuningDisabledReason

При необходимости описание причины и фактическое состояние отличаются.

Имя Тип Описание
AutoConfigured

string

Default

string

Disabled

string

InheritedFromServer

string

NotSupported

string

QueryStoreOff

string

QueryStoreReadOnly

string

AutomaticTuningMode

Автоматическая настройка требуемого состояния.

Имя Тип Описание
Auto

string

Custom

string

Inherit

string

Unspecified

string

AutomaticTuningOptionModeActual

Фактическое состояние параметра автоматической настройки.

Имя Тип Описание
Off

string

On

string

AutomaticTuningOptionModeDesired

Требуемое состояние параметра автоматической настройки.

Имя Тип Описание
Default

string

Off

string

On

string

AutomaticTuningOptions

Свойства автоматической настройки для отдельных помощников.

Имя Тип Описание
actualState

AutomaticTuningOptionModeActual

Фактическое состояние параметра автоматической настройки.

desiredState

AutomaticTuningOptionModeDesired

Требуемое состояние параметра автоматической настройки.

reasonCode

integer

При необходимости код причины и фактическое состояние отличаются.

reasonDesc

AutomaticTuningDisabledReason

При необходимости описание причины и фактическое состояние отличаются.

DatabaseAutomaticTuning

Автоматическая настройка на уровне базы данных.

Имя Тип Описание
id

string

Идентификатор ресурса.

name

string

Имя ресурса.

properties.actualState

AutomaticTuningMode

Автоматическая настройка фактического состояния.

properties.desiredState

AutomaticTuningMode

Автоматическая настройка требуемого состояния.

properties.options

<string,  AutomaticTuningOptions>

Определение параметров автоматической настройки.

type

string

Тип ресурса.