你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Database Automatic Tuning - Get

服务:: SQL Database

API 版本:: 2023-08-01

获取数据库的自动优化。

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

URI 参数

名称	在	必需	类型	说明
databaseName	path	True	string	数据库的名称。
resourceGroupName	path	True	string	包含资源的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

响应

名称	类型	说明
200 OK	DatabaseAutomaticTuning	已成功检索数据库自动优化属性。
Other Status Codes	ErrorResponse	错误响应： *** 400 FeatureDisabledOnSelectedEdition - 用户尝试使用当前数据库版本上禁用的功能。 400 InvalidIdentifier - 标识符包含 NULL 或无效的 unicode 字符。 400 SystemDatabasesNotSupported - 用户尝试获取系统数据库上的自动优化信息。 400 DataWarehouseNotSupported - SQL 数据仓库不支持自动优化。 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 DatabaseDoesNotExist - 找不到请求的数据库 404 SubscriptionDoesNotHaveElasticPool - 找不到请求的弹性池 404 OperationIdNotFound - ID作不存在。 405 NotSupported - 不支持此功能。 409 冲突 - 由于请求中的冲突，无法处理请求。 409 CannotCancelOperation - 管理作处于无法取消的状态。 409 OperationCancelled -作已被用户取消。 409 OperationInterrupted - 无法完成资源上的作，因为它被同一资源上的另一个作中断。 429 SubscriptionTooManyCreateUpdateRequests - 请求超出可用资源可以处理的最大请求数。 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。 500 OperationTimedOut -作超时并自动回滚。请重试该作。 503 ServiceTemporarilyUnavailable - 功能暂时不可用。 503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。

名称

类型

说明

200 OK

DatabaseAutomaticTuning

已成功检索数据库自动优化属性。

Other Status Codes

ErrorResponse

错误响应： ***

400 FeatureDisabledOnSelectedEdition - 用户尝试使用当前数据库版本上禁用的功能。
400 InvalidIdentifier - 标识符包含 NULL 或无效的 unicode 字符。
400 SystemDatabasesNotSupported - 用户尝试获取系统数据库上的自动优化信息。
400 DataWarehouseNotSupported - SQL 数据仓库不支持自动优化。
404 SubscriptionDoesNotHaveServer - 找不到请求的服务器
404 DatabaseDoesNotExist - 找不到请求的数据库
404 SubscriptionDoesNotHaveElasticPool - 找不到请求的弹性池
404 OperationIdNotFound - ID作不存在。
405 NotSupported - 不支持此功能。
409 冲突 - 由于请求中的冲突，无法处理请求。
409 CannotCancelOperation - 管理作处于无法取消的状态。
409 OperationCancelled -作已被用户取消。
409 OperationInterrupted - 无法完成资源上的作，因为它被同一资源上的另一个作中断。
429 SubscriptionTooManyCreateUpdateRequests - 请求超出可用资源可以处理的最大请求数。
429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。
500 OperationTimedOut -作超时并自动回滚。请重试该作。
503 ServiceTemporarilyUnavailable - 功能暂时不可用。
503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。

示例

Get a database's automatic tuning settings

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=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DatabaseAutomaticTuningGet.json
// this example is just showing the usage of "DatabaseAutomaticTuning_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseAutomaticTuningResource created on azure
// for more information of creating SqlDatabaseAutomaticTuningResource, please refer to the document of SqlDatabaseAutomaticTuningResource
string subscriptionId = "c3aa9078-0000-0000-0000-e36f151182d7";
string resourceGroupName = "default-sql-onebox";
string serverName = "testsvr11";
string databaseName = "db1";
ResourceIdentifier sqlDatabaseAutomaticTuningResourceId = SqlDatabaseAutomaticTuningResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseAutomaticTuningResource sqlDatabaseAutomaticTuning = client.GetSqlDatabaseAutomaticTuningResource(sqlDatabaseAutomaticTuningResourceId);

// invoke the operation
SqlDatabaseAutomaticTuningResource result = await sqlDatabaseAutomaticTuning.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDatabaseAutomaticTuningData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/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	数据库级自动优化。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应

AutomaticTuningDisabledReason

枚举

如果需要和实际状态的原因说明不同。

值	说明
Default
Disabled
AutoConfigured
InheritedFromServer
QueryStoreOff
QueryStoreReadOnly
NotSupported

AutomaticTuningMode

枚举

自动优化所需状态。

值	说明
Inherit
Custom
Auto
Unspecified

AutomaticTuningOptionModeActual

枚举

自动优化选项实际状态。

值	说明
Off
On

AutomaticTuningOptionModeDesired

枚举

自动优化选项所需状态。

值	说明
Off
On
Default

AutomaticTuningOptions

Object

单个顾问的自动优化属性。

名称	类型	说明
actualState	AutomaticTuningOptionModeActual	自动优化选项实际状态。
desiredState	AutomaticTuningOptionModeDesired	自动优化选项所需状态。
reasonCode	integer (int32)	如果需要，原因代码和实际状态不同。
reasonDesc	AutomaticTuningDisabledReason	如果需要和实际状态的原因说明不同。

DatabaseAutomaticTuning

Object

数据库级自动优化。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.actualState	AutomaticTuningMode	自动优化实际状态。
properties.desiredState	AutomaticTuningMode	自动优化所需状态。
properties.options	<string, AutomaticTuningOptions>	自动优化选项定义。
type	string	资源类型。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

通过

Database Automatic Tuning - Get

URI 参数

响应

示例

Get a database's automatic tuning settings

示例请求

示例响应

定义

AutomaticTuningDisabledReason

AutomaticTuningMode

AutomaticTuningOptionModeActual

AutomaticTuningOptionModeDesired

AutomaticTuningOptions

DatabaseAutomaticTuning

ErrorAdditionalInfo

ErrorDetail

ErrorResponse