GetSQLReviewOptimizeDetail - - Centro de documentación de Alibaba Cloud

Consulta los detalles de las sugerencias de optimización. Esta operación solo aplica a los tickets de cambio de datos y 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í	GetSQLReviewOptimizeDetail	La operación que desea ejecutar. Establezca el valor en GetSQLReviewOptimizeDetail.
SQLReviewQueryKey	String	Sí	a57e54ec5433475ea3082d882fdb****	Clave para consultar los detalles de las sugerencias de optimización. Llame a la operación ListSQLReviewOriginSQL para obtenerla.
Tid	Long	No	1	ID del inquilino. Llame a la operación GetUserActiveTenant o ListUserTenants para consultarlo.
RegionId	String	No	cn-hangzhou	ID de la región donde está activado DMS. Para obtener más información sobre los valores válidos de este parámetro, consulte Parámetro RegionID. Nota Establezca este parámetro en el ID de la región más cercana a su servicio.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931	ID de la solicitud.
ErrorCode	String	UnknownError	Código de error devuelto.
ErrorMessage	String	UnknownError	Mensaje de error devuelto.
Success	Boolean	true	Indica si la solicitud se completó correctamente.
OptimizeDetail	Object		Detalles de las sugerencias de optimización para sentencias SQL.
QueryKey	String	a57e54ec5433475ea3082d882fdb****	Clave para consultar los detalles de las sugerencias de optimización.
InstanceId	Integer	123321	ID de la instancia a la que pertenece la base de datos.
DbId	Integer	111222	ID de la base de datos.
SqlType	String	UPDATE	Tipo de sentencia SQL. Valores válidos: DELETE, UPDATE y ALTER_TABLE.
QualityResult	Object		Calidad de la sentencia SQL.
ErrorMessage	String	syntax error	Mensaje de error devuelto.
Results	Array of Results		Resultados de la revisión basados en reglas.
RuleName	String	SELECT_SUGGEST_ASSIGN_WHERE	Nombre de la regla. Para obtener más información, consulte Optimización de revisión de SQL.
Feedback	String	MUST_IMPROVE	Sugerencia de optimización para la sentencia SQL. Valores válidos: MUST_IMPROVE: La sentencia SQL debe mejorarse. POTENTIAL_ISSUE: La sentencia SQL contiene problemas potenciales. SUGGEST_IMPROVE: Se recomienda mejorar la sentencia SQL. USEDMSTOOLKIT: Se recomienda cambiar esquemas sin bloquear tablas. USEDMSDML_UNLOCK: Se recomienda cambiar datos sin bloquear tablas. TABLEINDEXSUGGEST: Se recomienda usar sentencias SQL con índices.
Comments	String	xxx especifica que las sentencias SQL deben contener la cláusula WHERE.	Comentario especificado al crear la regla de revisión de SQL. Para obtener más información, consulte Optimización de revisión de SQL.
Messages	Array of String	La tabla xxx no existe.	Resultados de la revisión.
Scripts	Array of Scripts		Script SQL para cambios de datos.
OpType	String	AddIndex	Propósito del script SQL. El valor es AddIndex.
Content	String	alter table xxx add index idx_xx(yyy);	Contenido del script SQL.
TableName	String	xxx	Nombre de la tabla.
RuleType	String	REVIEW	Tipo de regla de revisión de SQL. Valores válidos: REVIEW: Regla para revisar sentencias SQL según estándares. OPTIMIZE: Regla para proporcionar sugerencias de optimización.
OccurError	Boolean	false	Indica si ocurrió un error. Valores válidos: true: Ocurrió un error. false: No ocurrió ningún error.

Ejemplos

Solicitudes de ejemplo

http(s)://dms-enterprise.aliyuncs.com?Action=GetSQLReviewOptimizeDetail
&SQLReviewQueryKey=a57e54ec5433475ea3082d882fdb89c5
&Tid=1
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

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

<GetSQLReviewOptimizeDetailResponse>
    <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <Success>true</Success>
    <OptimizeDetail>
        <QueryKey>a57e54ec5433475ea3082d882fdb****</QueryKey>
        <InstanceId>123321</InstanceId>
        <DbId>111222</DbId>
        <SqlType>UPDATE</SqlType>
        <QualityResult>
            <ErrorMessage>syntax error</ErrorMessage>
            <Results>
                <RuleName>SELECT_SUGGEST_ASSIGN_WHERE</RuleName>
                <Feedback>MUST_IMPROVE</Feedback>
                <Comments>xxx specifies that SQL statements must contain the WHERE clause.</Comments>
                <Messages>xxx table does not exist.</Messages>
                <Scripts>
                    <OpType>AddIndex</OpType>
                    <Content>alter table xxx add index idx_xx(yyy);</Content>
                    <TableName>xxx</TableName>
                </Scripts>
                <RuleType>REVIEW</RuleType>
            </Results>
            <OccurError>false</OccurError>
        </QualityResult>
    </OptimizeDetail>
</GetSQLReviewOptimizeDetailResponse>

Formato JSON

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

{
  "RequestId" : "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode" : "UnknownError",
  "ErrorMessage" : "UnknownError",
  "Success" : true,
  "OptimizeDetail" : {
    "QueryKey" : "a57e54ec5433475ea3082d882fdb****",
    "InstanceId" : 123321,
    "DbId" : 111222,
    "SqlType" : "UPDATE",
    "QualityResult" : {
      "ErrorMessage" : "syntax error",
      "Results" : [ {
        "RuleName" : "SELECT_SUGGEST_ASSIGN_WHERE",
        "Feedback" : "MUST_IMPROVE",
        "Comments" : "xxx specifies that SQL statements must contain the WHERE clause.",
        "Messages" : [ "xxx table does not exist." ],
        "Scripts" : [ {
          "OpType" : "AddIndex",
          "Content" : "alter table xxx add index idx_xx(yyy);",
          "TableName" : "xxx"
        } ],
        "RuleType" : "REVIEW"
      } ],
      "OccurError" : false
    }
  }
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.