3 Query the Summary of an Optimization

Description: Query the summary of an optimization by optimization ID (analysisId).

3.1. Interface URL

 Post http://${server-host}:${server-port}/api/v1/getAnalysisSummary  

3.2. Request Parameters

Field	Type	Required	Description
userKey	String	Y	Activation code
analysisId	String	Y	Optimization ID (analysisId) returned when creating optimization

Request Example

{  
    "userKey":  "CB698418-88B25371-67F15F01-XXXXXXXX",  
    "analysisId":  "1730503067658043394"  
}  

3.3. Response

Field	Type	Description
code	int	Status code
message	String	Description
data	Object	Data

Data structure of data

Field	Type	Description
status	String	Optimization execution status
analysisId	String	Optimization ID
numberOfQuery	int	Number of SQL statements
numberOfSyntaxError	int	Number of syntax errors
numberOfRewrite	int	Number of rewrite optimizations
numberOfRewrittenQuery	int	Number of rewritten SQL statements
numberOfViolations	int	Number of violated rules
numberOfViolatedQuery	int	Number of queries that violated rules
numberOfIndex	int	Number of recommended indices
numberOfQueryIndex	int	Number of queries using recommended indices
performanceImprove	double	Performance improvement percentage
summaryMarkdown	String	Summary markdown
analysisRuleInfo	Object	Analysis rule violation information
ruleName	String	Rule name
stmtNameStr	String	Statement name defined in rule
analysisIndexInfo	Array	Analysis recommended index DDL list
summaryStatementInfo	Object	Analysis statement information list
analysisStmtId	String	Statement ID (used to query analysis statement details)
stmtName	String	Statement name
stmtText	String	Statement SQL text
costBefore	double	Cost before optimization
costAfter	double	Cost after optimization
numberOfRewrite	int	Number of statement rewrite optimizations
numberOfViolations	int	Number of rule violations in statement
numberOfSyntaxError	int	Number of syntax errors in statement
numberOfIndex	int	Number of indices recommended for statement
numberOfHitIndex	int	Number of valid indices for statement
performance	double	Statement performance improvement percentage
contributingIndices	String	Names of contributing indices

Response Example

{  
    "resultCode": 200,  
    "resultMsg": "Success",
    "resultBody": {  
        "status": "success1",
        "basicSummary": {  
            "analysisSummaryId": "1730522775702663170",
            ...  
        }
        ...
    }
}