ListSQLReviewOriginSQL - Data Management - Centro de documentación de Alibaba Cloud

Consulta los detalles de las sentencias SQL involucradas en un ticket de revisión de SQL.

Descripción de la operación

Para obtener más información sobre la función de revisión de SQL, consulte Revisión de SQL.

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

dms:ListSQLReviewOriginSQL

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
OrderId	integer	Sí	El ID del ticket de revisión de SQL. Puede llamar a la operación CreateSQLReviewOrder para consultar el ID del ticket.	903****
OrderActionDetail	object	No	Los parámetros que se utilizan para filtrar las sentencias SQL involucradas en el ticket.
FileId	integer	No	El ID del archivo que contiene las sentencias SQL que se van a revisar.	85****
SQLReviewResult	string	No	La sugerencia de optimización para la sentencia SQL. Valores válidos: MUST_IMPROVE: La sentencia SQL debe optimizarse. POTENTIAL_ISSUE: La sentencia SQL contiene problemas potenciales. SUGGEST_IMPROVE: Se recomienda optimizar la sentencia SQL. USE_DMS_TOOLKIT: Se recomienda cambiar esquemas sin bloquear tablas. USE_DMS_DML_UNLOCK: Se recomienda cambiar datos sin bloquear tablas. TABLE_INDEX_SUGGEST: Se recomienda optimizar los índices para la sentencia SQL.	MUST_IMPROVE
CheckStatusResult	string	No	El estado de revisión de la sentencia SQL. Valores válidos: new: La sentencia SQL estaba en espera de revisión. unknown: La sentencia SQL no se puede analizar. check_not_pass: La sentencia SQL no pasó la revisión. check_pass: La sentencia SQL pasó la revisión. force_pass: La sentencia SQL pasó la revisión manual. force_not_pass: La sentencia SQL no pasó la revisión manual.	check_not_pass
Page	object	No	La información de paginación.
PageNumber	integer	No	El número de página.	1
PageSize	integer	No	El número de entradas por página.	20
Tid	integer	No	El ID del inquilino. Puede llamar a la operación GetUserActiveTenant o ListUserTenants para consultar el ID del inquilino.	233***

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	0A00863F-6366-5583-9B96-891DC8D8F88A
ErrorCode	string	El código de error devuelto.	UnknownError
ErrorMessage	string	El mensaje de error devuelto si la solicitud falló.	UnknownError
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true false	true
TotalCount	integer	El número de sentencias SQL en el archivo.	1
OriginSQLList	array<object>	La información sobre las sentencias SQL analizadas.
	object
SQLId	integer	El ID de la sentencia SQL.	1111
FileId	integer	El ID del archivo.	858***
FileName	string	El nombre del archivo.	test.sql
SQLContent	string	La sentencia SQL en el archivo.	CREATE TABLE `test_sql_review_table` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `gmt_create` datetime NOT NULL, `name` varchar(256) DEFAULT NULL ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
CheckStatus	string	El estado de revisión de la sentencia SQL. Valores válidos: new: La sentencia SQL estaba en espera de revisión. unknown: La sentencia SQL no se puede analizar. check_not_pass: La sentencia SQL no pasó la revisión. check_pass: La sentencia SQL pasó la revisión. force_pass: La sentencia SQL pasó la revisión manual. force_not_pass: La sentencia SQL no pasó la revisión manual.	check_pass
StatusDesc	string	La descripción del estado de revisión.	检测通过
CheckedTime	string	La hora en que se revisó la sentencia SQL.	2021-06-09 21:07:00
SqlHash	string	El valor hash MD5 que se obtiene después de calcular la sentencia SQL mediante un algoritmo hash.	c7992dc1b681c6733894aded7834f423
ReviewSummary	string	Las estadísticas sobre las sugerencias de optimización para las sentencias SQL. El valor es una cadena JSON. Valores válidos: MUST_IMPROVE: Las sentencias SQL deben optimizarse. POTENTIAL_ISSUE: Las sentencias SQL contienen problemas potenciales. SUGGEST_IMPROVE: Se recomienda optimizar las sentencias SQL. USEDMSTOOLKIT: Se recomienda cambiar esquemas sin bloquear tablas. USEDMSDML_UNLOCK: Se recomienda cambiar datos sin bloquear tablas. TABLEINDEXSUGGEST: Se recomienda optimizar los índices para las sentencias SQL.	{\"SUGGEST_IMPROVE\":2,\"POTENTIAL_ISSUE\":1}
SQLReviewQueryKey	string	La clave que se utiliza para consultar la información sobre las sugerencias de optimización. Puede llamar a la operación GetSQLReviewOptimizeDetail para consultar los detalles basándose en esta clave.	6e9a4bc6867a4174a96b23c8b48b****
SQLName	string	El nombre de la sentencia SQL.	getByPk

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "0A00863F-6366-5583-9B96-891DC8D8F88A",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TotalCount": 1,
  "OriginSQLList": [
    {
      "SQLId": 1111,
      "FileId": 0,
      "FileName": "test.sql",
      "SQLContent": "CREATE TABLE `test_sql_review_table` (\n  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,\n  `gmt_create` datetime NOT NULL,\n  `name` varchar(256) DEFAULT NULL\n) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;",
      "CheckStatus": "check_pass",
      "StatusDesc": "检测通过",
      "CheckedTime": "2021-06-09 21:07:00",
      "SqlHash": "c7992dc1b681c6733894aded7834f423",
      "ReviewSummary": "{\\\"SUGGEST_IMPROVE\\\":2,\\\"POTENTIAL_ISSUE\\\":1}",
      "SQLReviewQueryKey": "6e9a4bc6867a4174a96b23c8b48b****",
      "SQLName": "getByPk"
    }
  ]
}

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.