Managed Instances - List By Managed Instance

Referência

Serviço:: SQL Database

Versão da API:: 2021-11-01

Obtenha as principais consultas consumidoras de recursos de uma instância gerenciada.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/topqueries?api-version=2021-11-01

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/topqueries?numberOfQueries={numberOfQueries}&databases={databases}&startTime={startTime}&endTime={endTime}&interval={interval}&aggregationFunction={aggregationFunction}&observationMetric={observationMetric}&api-version=2021-11-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
managedInstanceName	path	True	string	O nome da instância gerenciada.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.
aggregationFunction	query		AggregationFunctionType	Função de agregação a ser usada, o valor padrão é 'soma'
databases	query		string	Lista separada por vírgulas das bases de dados a incluir na pesquisa. Todos os bancos de dados são incluídos se este parâmetro não for especificado.
endTime	query		string	Tempo de término para o período observado.
interval	query		QueryTimeGrainType	A etapa de tempo a ser usada para resumir os valores métricos. O valor padrão é PT1H
numberOfQueries	query		integer (int32)	Quantas 'principais consultas' retornar. O padrão é 5.
observationMetric	query		MetricType	Métrica a ser usada para classificar as principais consultas. O padrão é 'cpu'
startTime	query		string	Hora de início para o período observado.

Respostas

Name	Tipo	Description
200 OK	TopQueriesListResult	Recuperadas com êxito as principais consultas para instância gerenciada.
Other Status Codes		Respostas de erro: *** 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 ResourceNotFound - O recurso solicitado não foi encontrado.

Name

Tipo

Description

200 OK

TopQueriesListResult

Recuperadas com êxito as principais consultas para instância gerenciada.

Other Status Codes

Respostas de erro: ***

404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado
404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados.
404 ResourceNotFound - O recurso solicitado não foi encontrado.

Exemplos

Obtain list of instance's top resource consuming queries.

Obtain list of instance's top resource consuming queries. Full-blown request and response.

Obtain list of instance's top resource consuming queries. Minimal request and response.

Obtain list of instance's top resource consuming queries.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/topqueries?interval=PT1H&observationMetric=duration&api-version=2021-11-01


import com.azure.resourcemanager.sql.models.MetricType;
import com.azure.resourcemanager.sql.models.QueryTimeGrainType;

/**
 * Samples for ManagedInstances ListByManagedInstance.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedInstanceTopQueriesList.json
     */
    /**
     * Sample code: Obtain list of instance's top resource consuming queries.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        obtainListOfInstanceSTopResourceConsumingQueries(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstances().listByManagedInstance("sqlcrudtest-7398",
            "sqlcrudtest-4645", null, null, null, null, QueryTimeGrainType.PT1H, null, MetricType.DURATION,
            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

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "numberOfQueries": 5,
      "aggregationFunction": "sum",
      "observationMetric": "cpu",
      "intervalType": "P1D",
      "startTime": "03/01/2020 00:00:00",
      "endTime": "03/05/2020 13:00:00",
      "queries": [
        {
          "databaseName": "db1",
          "queryId": "25",
          "intervals": [
            {
              "intervalStartTime": "03/03/2020 00:00:00",
              "executionCount": 1,
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0015841714409722222
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 4.340277777777778E-06
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 8336
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 11306905
                }
              ]
            }
          ]
        },
        {
          "databaseName": "db1",
          "queryId": "21",
          "intervals": [
            {
              "intervalStartTime": "03/03/2020 00:00:00",
              "executionCount": 1,
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0009521432291666667
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 2.3148148148148148E-07
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 1024
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 6620020
                }
              ]
            }
          ]
        },
        {
          "databaseName": "db3",
          "queryId": "3",
          "intervals": [
            {
              "intervalStartTime": "03/04/2020 00:00:00",
              "executionCount": 104,
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0008006611689814815
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 0
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 5543088
                }
              ]
            }
          ]
        },
        {
          "databaseName": "db2",
          "queryId": "3",
          "intervals": [
            {
              "intervalStartTime": "03/03/2020 00:00:00",
              "executionCount": 89,
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0006882543402777778
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 0
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 4761877
                }
              ]
            }
          ]
        },
        {
          "databaseName": "db3",
          "queryId": "22",
          "intervals": [
            {
              "intervalStartTime": "03/04/2020 00:00:00",
              "executionCount": 1,
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0006220661168981482
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 1024
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 4454161
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Obtain list of instance's top resource consuming queries. Full-blown request and response.

Pedido de amostra

HTTP
Java

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/topqueries?databases=db1,db2&startTime=2020-03-10T12:00:00Z&endTime=2020-03-12T12:00:00Z&interval=P1D&observationMetric=cpu&api-version=2021-11-01


import com.azure.resourcemanager.sql.models.MetricType;
import com.azure.resourcemanager.sql.models.QueryTimeGrainType;

/**
 * Samples for ManagedInstances ListByManagedInstance.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedInstanceTopQueriesListMax.json
     */
    /**
     * Sample code: Obtain list of instance's top resource consuming queries. Full-blown request and response.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void obtainListOfInstanceSTopResourceConsumingQueriesFullBlownRequestAndResponse(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstances().listByManagedInstance("sqlcrudtest-7398",
            "sqlcrudtest-4645", null, "db1,db2", "2020-03-10T12:00:00Z", "2020-03-12T12:00:00Z", QueryTimeGrainType.P1D,
            null, MetricType.CPU, 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

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "numberOfQueries": 5,
      "aggregationFunction": "sum",
      "observationMetric": "cpu",
      "intervalType": "P1D",
      "startTime": "03/10/2020 00:00:00",
      "endTime": "03/12/2020 13:00:00",
      "queries": [
        {
          "databaseName": "db1",
          "queryId": "28",
          "intervals": [
            {
              "intervalStartTime": "03/11/2020 00:00:00",
              "executionCount": 1,
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0015934667245370371
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 4.224537037037037E-06
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 8336
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 11091296
                }
              ]
            }
          ]
        },
        {
          "databaseName": "db1",
          "queryId": "24",
          "intervals": [
            {
              "intervalStartTime": "03/11/2020 00:00:00",
              "executionCount": 1,
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0009522783564814815
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 1.7361111111111112E-07
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 1024
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 6625562
                }
              ]
            }
          ]
        },
        {
          "databaseName": "db1",
          "queryId": "3",
          "intervals": [
            {
              "intervalStartTime": "03/11/2020 00:00:00",
              "executionCount": 82,
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0007183139467592593
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 0
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 4970199
                }
              ]
            }
          ]
        },
        {
          "databaseName": "db1",
          "queryId": "29",
          "intervals": [
            {
              "intervalStartTime": "03/11/2020 00:00:00",
              "executionCount": 1,
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0006494454571759259
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 5.034722222222222E-06
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 1024
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 4530668
                }
              ]
            }
          ]
        },
        {
          "databaseName": "db2",
          "queryId": "25",
          "intervals": [
            {
              "intervalStartTime": "03/11/2020 00:00:00",
              "executionCount": 1,
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0006275368923611112
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 1024
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 4349943
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Obtain list of instance's top resource consuming queries. Minimal request and response.

Pedido de amostra

HTTP
Java

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/topqueries?api-version=2021-11-01


/**
 * Samples for ManagedInstances ListByManagedInstance.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedInstanceTopQueriesListMin.json
     */
    /**
     * Sample code: Obtain list of instance's top resource consuming queries. Minimal request and response.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void obtainListOfInstanceSTopResourceConsumingQueriesMinimalRequestAndResponse(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstances().listByManagedInstance("sqlcrudtest-7398",
            "sqlcrudtest-4645", null, null, null, null, null, null, null, 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

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "numberOfQueries": 5,
      "aggregationFunction": "sum",
      "observationMetric": "cpu",
      "intervalType": "PT1H",
      "startTime": "03/10/2020 12:00:00",
      "endTime": "03/11/2020 12:24:07",
      "queries": []
    }
  ]
}

Definições

Name	Description
AggregationFunctionType	Função de agregação a ser usada, o valor padrão é 'soma'
MetricType	Métrica a ser usada para classificar as principais consultas. O padrão é 'cpu'
QueryMetricInterval	Propriedades de um intervalo de métricas de consulta.
QueryMetricProperties	Propriedades de uma métrica topquery em um intervalo.
QueryMetricUnitType	A unidade da métrica.
QueryStatisticsProperties	Propriedades de uma estatística de execução de consulta.
QueryTimeGrainType	Tipo de intervalo (comprimento).
TopQueries
TopQueriesListResult	Uma lista das principais consultas que consomem recursos na instância gerenciada

AggregationFunctionType

Enumeração

Função de agregação a ser usada, o valor padrão é 'soma'

Valor	Description
avg
max
min
stdev
sum

MetricType

Enumeração

Métrica a ser usada para classificar as principais consultas. O padrão é 'cpu'

Valor	Description
cpu
dtu
duration
io
logIo

QueryMetricInterval

Object

Propriedades de um intervalo de métricas de consulta.

Name	Tipo	Description
executionCount	integer (int64)	Contagem de execução de uma consulta neste intervalo.
intervalStartTime	string	A hora de início para o intervalo métrico (formato ISO-8601).
intervalType	QueryTimeGrainType	Tipo de intervalo (comprimento).
metrics	QueryMetricProperties[]	Lista de objetos métricos para este intervalo

QueryMetricProperties

Object

Propriedades de uma métrica topquery em um intervalo.

Name	Tipo	Description
avg	number (double)	Valor métrico quando a função de agregação avg() é usada no intervalo.
displayName	string	O nome apropriado da interface do usuário para a métrica.
max	number (double)	Valor métrico quando a função de agregação max() é usada ao longo do intervalo.
min	number (double)	Valor métrico quando a função de agregação min() é usada no intervalo.
name	string	As informações de nome para a métrica.
stdev	number (double)	Valor métrico quando a função de agregação stdev é usada no intervalo.
sum	number (double)	Valor métrico quando a função de agregação sum() é usada ao longo do intervalo.
unit	QueryMetricUnitType	A unidade da métrica.
value	number (double)	O valor da métrica.

QueryMetricUnitType

Enumeração

A unidade da métrica.

Valor	Description
KB
count
microseconds
percentage

QueryStatisticsProperties

Object

Propriedades de uma estatística de execução de consulta.

Name	Tipo	Description
databaseName	string	Nome do banco de dados do banco de dados no qual essa consulta foi executada.
endTime	string	A hora de término da métrica (formato ISO-8601).
intervals	QueryMetricInterval[]	Lista de intervalos com dados métricos adequados
queryId	string	ID de consulta exclusiva (exclusiva dentro de um banco de dados).
startTime	string	A hora de início da métrica (formato ISO-8601).

QueryTimeGrainType

Enumeração

Tipo de intervalo (comprimento).

Valor	Description
P1D
PT1H

TopQueries

Object

Name	Tipo	Description
aggregationFunction	string	Função de agregação usada para calcular métricas de consulta.
endTime	string	A hora de término da métrica (formato ISO-8601).
intervalType	QueryTimeGrainType	Tipo de intervalo (comprimento).
numberOfQueries	integer (int32)	Número solicitado de consultas principais.
observationMetric	string	Métrica usada para classificar consultas.
queries	QueryStatisticsProperties[]	Lista das principais consultas consumidoras de recursos com dados métricos apropriados
startTime	string	A hora de início da métrica (formato ISO-8601).

TopQueriesListResult

Object

Uma lista das principais consultas que consomem recursos na instância gerenciada

Name	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	TopQueries[]	Matriz de resultados.

Partilhar via

Managed Instances - List By Managed Instance

Parâmetros do URI

Respostas

Exemplos

Obtain list of instance's top resource consuming queries.

Pedido de amostra

Resposta da amostra

Obtain list of instance's top resource consuming queries. Full-blown request and response.

Pedido de amostra

Resposta da amostra

Obtain list of instance's top resource consuming queries. Minimal request and response.

Pedido de amostra

Resposta da amostra

Definições

AggregationFunctionType

MetricType

QueryMetricInterval

QueryMetricProperties

QueryMetricUnitType

QueryStatisticsProperties

QueryTimeGrainType

TopQueries

TopQueriesListResult

Recursos adicionais