DescribeSQLTuningAdvices - ApsaraDB for OceanBase (Deprecated) - Centro de documentación de Alibaba Cloud

Puede llamar a esta operación para consultar sugerencias de optimización de SQL con dos propósitos: crear índices y vincular planes de ejecución.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

oceanbase:DescribeSQLTuningAdvices

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID del clúster de OceanBase.	obsdf43****
TenantId	string	Sí	El ID del inquilino.	tsdc2s2****
DbName	string	Sí	El nombre de la base de datos.	testdb
SqlId	string	Sí	El ID de la sentencia SQL.	123456
StartTime	string	Sí	La hora de inicio.	2023-04-12T04:38:38Z
EndTime	string	Sí	La hora de finalización.	2023-04-12T05:38:38Z
AcceptLanguage	string	No	El idioma admitido. Valores válidos: zh-CN en-US	zh-CN

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El resultado devuelto de la solicitud.
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Data	array<object>	Los datos devueltos.
	array<object>	La información sobre los planes de ejecución de la sentencia SQL.
Type	string	El tipo de optimización.	PLAN_BINDING/INDEX_CREATION
ColumnNames	string	La secuencia de columnas de índice.	c1;c2;c3
LocalityType	string	El tipo de índice.	Local/Global
Columns	array<object>	La lista de columnas de índice.
	object	La información sobre las columnas de índice.
ColumnName	string	El nombre de la columna.	xxxx
Ndv	number	El NDV de la columna.	100
MinValue	string	El valor mínimo de la columna.	1
MaxValue	string	El valor máximo de la columna.	100
DbName	string	El nombre de la base de datos.	test_db
Table	string	El nombre de la tabla.	test_table
Plan	object	El plan de ejecución.
Executions	integer	El número total de ejecuciones dentro del período de tiempo especificado.	2062
AvgCpuTime	number	El tiempo promedio de CPU dentro del período de tiempo especificado, en milisegundos.	100.36
PlanHash	string	El identificador único del plan de ejecución en el sistema de diagnóstico.	-86290582****886880
TimeoutPercentage	number	El porcentaje de ejecuciones con error de tiempo de espera agotado.	0
AvgConcurrencyWaitTime	number	El tiempo promedio dedicado a un evento de espera de concurrencia dentro del período de tiempo especificado, en milisegundos.	0
FirstLoadTimeUs	integer	La hora en que se cargó el plan de ejecución por primera vez.	1672367130576163
AvgDiskWrites	number	El número promedio de escrituras físicas dentro del período de tiempo especificado.	0
AvgUserIoWaitTime	number	El tiempo promedio dedicado a un evento de espera UserIo dentro del período de tiempo especificado, en milisegundos.	0
PlanSize	integer	El tamaño del plan de ejecución.	49216
ServerSn	string	El ID del nodo.	i-bp1***sw64dhb***
OutlineData	string	El campo outline_data del plan de ejecución.	xxxxx
PlanType	string	El tipo de plan de ejecución. Valores válidos: LOCAL, REMOTE y DIST.	LOCAL
ObDbId	integer	El ID de la base de datos.	1108307720799259
HitPercentage	number	La tasa de aciertos.	66.8
AvgBufferGets	number	El número promedio de lecturas de caché dentro del período de tiempo especificado.	0
ExecPs	number	El número promedio de ejecuciones por segundo dentro del período de tiempo especificado.	1.45
DelayedLargeQueryPercentage	number	El porcentaje de consultas de larga duración retrasadas.	0
TableScan	boolean	Indica si se realiza un escaneo completo de tabla.	false
LargeQueryPercentage	number	El porcentaje de consultas de larga duración completadas.	0
SchemaVersion	integer	La versión del esquema.	1672367130529680
PlanId	integer	El ID del plan de ejecución.	818
FirstLoadTime	string	La hora en que se cargó el plan de ejecución por primera vez.	2022-12-30T02:25:30.576Z
AvgRowProcessed	number	El tiempo de espera promedio del procesamiento de filas dentro del período de tiempo especificado, en milisegundos.	1
MergedVersion	integer	La versión de la compactación principal.	3
HitDiagnosis	boolean	Indica si se ha identificado el diagnóstico.	false
Uid	string	El identificador único del plan de ejecución.	AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj
AvgApplicationWaitTime	number	El tiempo promedio dedicado a un evento de espera de aplicación dentro del período de tiempo especificado, en milisegundos.	0
CollectTimeUs	integer	El período de tiempo durante el cual se recopilan los datos.	1672358400000000
AvgElapsedTime	number	El tiempo de espera de intervalo promedio dentro del período de tiempo especificado, en milisegundos.	713.62
ObServerId	integer	El ID del servidor.	1
OutlineId	integer	El ID del outline.	1
AvgDiskReads	number	El número promedio de lecturas físicas dentro del período de tiempo especificado.	0

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Data": [
    {
      "Type": "PLAN_BINDING/INDEX_CREATION",
      "ColumnNames": "c1;c2;c3",
      "LocalityType": "Local/Global",
      "Columns": [
        {
          "ColumnName": "xxxx",
          "Ndv": 100,
          "MinValue": "1",
          "MaxValue": "100"
        }
      ],
      "DbName": "test_db",
      "Table": "test_table",
      "Plan": {
        "Executions": 2062,
        "AvgCpuTime": 100.36,
        "PlanHash": "-86290582****886880",
        "TimeoutPercentage": 0,
        "AvgConcurrencyWaitTime": 0,
        "FirstLoadTimeUs": 1672367130576163,
        "AvgDiskWrites": 0,
        "AvgUserIoWaitTime": 0,
        "PlanSize": 49216,
        "ServerSn": "i-bp1*****sw64dhb*****",
        "OutlineData": "xxxxx",
        "PlanType": "LOCAL",
        "ObDbId": 1108307720799259,
        "HitPercentage": 66.8,
        "AvgBufferGets": 0,
        "ExecPs": 1.45,
        "DelayedLargeQueryPercentage": 0,
        "TableScan": false,
        "LargeQueryPercentage": 0,
        "SchemaVersion": 1672367130529680,
        "PlanId": 818,
        "FirstLoadTime": "2022-12-30T02:25:30.576Z",
        "AvgRowProcessed": 1,
        "MergedVersion": 3,
        "HitDiagnosis": false,
        "Uid": "AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj",
        "AvgApplicationWaitTime": 0,
        "CollectTimeUs": 1672358400000000,
        "AvgElapsedTime": 713.62,
        "ObServerId": 1,
        "OutlineId": 1,
        "AvgDiskReads": 0
      }
    }
  ]
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.