ListSQLReviewOriginSQL - - Centro de documentación de Alibaba Cloud

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

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

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListSQLReviewOriginSQL	La operación que desea ejecutar. Establezca el valor en ListSQLReviewOriginSQL.
OrderId	Long	Sí	123321	El ID del ticket. Llame a la operación CreateSQLReviewOrder para consultar el ID del ticket.
OrderActionDetail	Object	No		Los parámetros utilizados para filtrar las sentencias SQL incluidas en el ticket.
FileId	Long	No	123345	El ID del archivo.
SQLReviewResult	String	No	MUST_IMPROVE	La sugerencia de optimización de 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.
CheckStatusResult	String	No	check_not_pass	El estado de revisión de la sentencia SQL. Valores válidos: new: La sentencia SQL está pendiente de análisis. unknown: No se pudo analizar sintácticamente la sentencia SQL. check_not_pass: La sentencia SQL no pasó la revisión. check_pass: La sentencia SQL pasó la revisión. force_pass: El estado de revisión de la sentencia SQL se cambió manualmente a aprobado. force_not_pass: El estado de revisión de la sentencia SQL se cambió manualmente a rechazado.
Page	Object	No		Los detalles sobre la página que se devolverá.
PageNumber	Integer	No	1	El número de la página que se devolverá.
PageSize	Integer	No	20	El número de entradas que se devolverán en cada página.
Tid	Long	No	1	El ID del inquilino. Llame a la operación GetUserActiveTenant o ListUserTenants para obtener el ID del inquilino.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931	El ID de la solicitud.
ErrorCode	String	UnknownError	El código de error devuelto si la solicitud falló.
ErrorMessage	String	UnknownError	El mensaje de error devuelto si la solicitud falló.
Success	Boolean	true	Indica si la solicitud se realizó correctamente.
TotalCount	Integer	10	El número total de sentencias SQL.
OriginSQLList	Array of OriginSQLList		La información sobre las sentencias SQL analizadas.
SQLId	Long	1111	El ID de la sentencia SQL.
FileId	Long	123321	El ID del archivo.
FileName	String	test.sql	El nombre del archivo.
SQLContent	String	select id from table_name	La sentencia SQL.
CheckStatus	String	check_pass	El estado de revisión de la sentencia SQL. Valores válidos: new: La sentencia SQL está pendiente de análisis. unknown: No se pudo analizar sintácticamente la sentencia SQL. check_not_pass: La sentencia SQL no pasó la revisión. check_pass: La sentencia SQL pasó la revisión. force_pass: El estado de revisión de la sentencia SQL se cambió manualmente a aprobado. force_not_pass: El estado de revisión de la sentencia SQL se cambió manualmente a rechazado.
StatusDesc	String	The SQL statement passed the review.	La descripción del estado de revisión.
CheckedTime	String	2021-06-09 21:07:00	La hora en que se revisó la sentencia SQL.
SqlHash	String	95adb6e77a0884d9e50232cb8c5c969d	El valor hash MD5 de la sentencia SQL.
ReviewSummary	String	{"POTENTIAL_ISSUE":1,"SUGGEST_IMPROVE":1}	La sugerencia de optimización de la sentencia SQL. El valor es una cadena JSON. 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. USEDMSTOOLKIT: Se recomienda cambiar esquemas sin bloquear tablas. USEDMSDML_UNLOCK: Se recomienda cambiar datos sin bloquear tablas. TABLEINDEXSUGGEST: Se recomienda optimizar los índices.
SQLReviewQueryKey	String	a57e54ec5433475ea3082d882fdb89c5	La clave utilizada para consultar los detalles de las sugerencias de optimización. Llame a la operación GetSQLReviewOptimizeDetail para consultar los detalles de las sugerencias de optimización mediante esta clave.
SQLName	String	getByPk	El nombre de la sentencia SQL.

Ejemplos

Solicitudes de ejemplo

http(s)://dms-enterprise.aliyuncs.com/?Action=ListSQLReviewOriginSQL
&OrderId=123321
&OrderActionDetail={"FileId":123345,"SQLReviewResult":"MUST_IMPROVE","CheckStatusResult":"check_not_pass","Page":{"PageNumber":1,"PageSize":20}}
&Tid=1
&Common request parameters

Respuestas de ejemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListSQLReviewOriginSQLResponse>
    <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <Success>true</Success>
    <TotalCount>10</TotalCount>
    <OriginSQLList>
        <SQLId>1111</SQLId>
        <FileId>123321</FileId>
        <FileName>test.sql</FileName>
        <SQLContent>select id from table_name</SQLContent>
        <CheckStatus>check_pass</CheckStatus>
        <StatusDesc>The SQL statement passed the review.</StatusDesc>
        <CheckedTime>2021-06-09 21:07:00</CheckedTime>
        <SqlHash>95adb6e77a0884d9e50232cb8c5c969d</SqlHash>
        <ReviewSummary>{"POTENTIAL_ISSUE":1,"SUGGEST_IMPROVE":1}</ReviewSummary>
        <SQLReviewQueryKey>a57e54ec5433475ea3082d882fdb89c5</SQLReviewQueryKey>
        <SQLName>getByPk</SQLName>
    </OriginSQLList>
</ListSQLReviewOriginSQLResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode" : "UnknownError",
  "ErrorMessage" : "UnknownError",
  "Success" : true,
  "TotalCount" : 10,
  "OriginSQLList" : [ {
    "SQLId" : 1111,
    "FileId" : 123321,
    "FileName" : "test.sql",
    "SQLContent" : "select id from table_name",
    "CheckStatus" : "check_pass",
    "StatusDesc" : "The SQL statement passed the review.",
    "CheckedTime" : "2021-06-09 21:07:00",
    "SqlHash" : "95adb6e77a0884d9e50232cb8c5c969d",
    "ReviewSummary" : "{\"POTENTIAL_ISSUE\":1,\"SUGGEST_IMPROVE\":1}",
    "SQLReviewQueryKey" : "a57e54ec5433475ea3082d882fdb89c5",
    "SQLName" : "getByPk"
  } ]
}

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.