GetSQLReviewOptimizeDetail - - Centre de documentation Alibaba Cloud

Récupère les détails des suggestions d'optimisation. Cette opération s'applique uniquement aux tickets de modification des données et de révision SQL.

Pour plus d'informations sur la fonctionnalité de révision SQL, consultez la rubrique Révision SQL.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	GetSQLReviewOptimizeDetail	Opération à effectuer. Définissez la valeur sur GetSQLReviewOptimizeDetail.
SQLReviewQueryKey	String	Oui	a57e54ec5433475ea3082d882fdb****	Clé permettant de récupérer les détails des suggestions d'optimisation. Appelez l'opération ListSQLReviewOriginSQL pour obtenir cette clé.
Tid	Long	Non	1	ID du locataire (tenant). Appelez l'opération GetUserActiveTenant ou ListUserTenants pour obtenir l'ID du locataire.
RegionId	String	Non	cn-hangzhou	ID de la région où DMS est activé. Pour connaître les valeurs valides de ce paramètre, consultez la rubrique Paramètre RegionID. Remarque Définissez ce paramètre sur l'ID de la région la plus proche de votre service.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931	ID de la requête.
ErrorCode	String	UnknownError	Code d'erreur renvoyé.
ErrorMessage	String	UnknownError	Message d'erreur renvoyé.
Success	Boolean	true	Indique si la requête a abouti.
OptimizeDetail	Object		Détails des suggestions d'optimisation pour les instructions SQL.
QueryKey	String	a57e54ec5433475ea3082d882fdb****	Clé permettant de récupérer les détails des suggestions d'optimisation.
InstanceId	Integer	123321	ID de l'instance à laquelle appartient la base de données.
DbId	Integer	111222	ID de la base de données.
SqlType	String	UPDATE	Type de l'instruction SQL. Valeurs valides : DELETE, UPDATE et ALTER_TABLE.
QualityResult	Object		Qualité de l'instruction SQL.
ErrorMessage	String	syntax error	Message d'erreur renvoyé.
Results	Array of Results		Résultats de la révision basés sur les règles.
RuleName	String	SELECT_SUGGEST_ASSIGN_WHERE	Nom de la règle. Pour plus d'informations, consultez la rubrique Optimisation de la révision SQL.
Feedback	String	MUST_IMPROVE	Suggestion d'optimisation pour l'instruction SQL. Valeurs valides : MUST_IMPROVE : L'instruction SQL doit être améliorée. POTENTIAL_ISSUE : L'instruction SQL présente des problèmes potentiels. SUGGEST_IMPROVE : Il est recommandé d'améliorer l'instruction SQL. USEDMSTOOLKIT : Il est recommandé de modifier les schémas sans verrouiller les tables. USEDMSDML_UNLOCK : Il est recommandé de modifier les données sans verrouiller les tables. TABLEINDEXSUGGEST : Il est recommandé d'utiliser des instructions SQL exploitant les index.
Comments	String	xxx specifies that SQL statements must contain the WHERE clause.	Commentaire spécifié lors de la création de la règle de révision SQL. Pour plus d'informations, consultez la rubrique Optimisation de la révision SQL.
Messages	Array of String	xxx table does not exist.	Résultats de la révision.
Scripts	Array of Scripts		Script SQL pour les modifications de données.
OpType	String	AddIndex	Objectif du script SQL. La valeur est définie sur AddIndex.
Content	String	alter table xxx add index idx_xx(yyy);	Contenu du script SQL.
TableName	String	xxx	Nom de la table.
RuleType	String	REVIEW	Type de la règle de révision SQL. Valeurs valides : REVIEW : règle utilisée pour réviser les instructions SQL selon les normes. OPTIMIZE : règle utilisée pour fournir des suggestions d'optimisation.
OccurError	Boolean	false	Indique si une erreur s'est produite. Valeurs valides : true : Une erreur s'est produite. false : Aucune erreur ne s'est produite.

Exemples

Exemple de requête

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

Exemple de réponse en cas de succès

Format 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>

Format 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
    }
  }
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs de l'API.