GetSQLReviewOptimizeDetail - : Central de Documentação do Alibaba Cloud

Consulta os detalhes das sugestões de otimização. Esta operação aplica-se apenas a tickets de alteração de dados e revisão de SQL.

Para obter mais informações sobre o recurso de revisão de SQL, consulte Revisão de SQL.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	GetSQLReviewOptimizeDetail	Operação a ser executada. Defina o valor como GetSQLReviewOptimizeDetail.
SQLReviewQueryKey	String	Sim	a57e54ec5433475ea3082d882fdb****	Chave usada para consultar os detalhes das sugestões de otimização. Para obtê-la, chame a operação ListSQLReviewOriginSQL.
Tid	Long	Não	1	ID do locatário. Para consultar esse ID, chame a operação GetUserActiveTenant ou ListUserTenants.
RegionId	String	Não	cn-hangzhou	ID da região onde o DMS está ativado. Para obter mais informações sobre os valores válidos deste parâmetro, consulte Parâmetro RegionID. Nota Defina este parâmetro com o ID da região mais próxima do seu serviço.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931	ID da solicitação.
ErrorCode	String	UnknownError	Código de erro retornado.
ErrorMessage	String	UnknownError	Mensagem de erro retornada.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.
OptimizeDetail	Object		Detalhes das sugestões de otimização para instruções SQL.
QueryKey	String	a57e54ec5433475ea3082d882fdb****	Chave usada para consultar os detalhes das sugestões de otimização.
InstanceId	Integer	123321	ID da instância à qual o banco de dados pertence.
DbId	Integer	111222	ID do banco de dados.
SqlType	String	UPDATE	Tipo da instrução SQL. Valores válidos: DELETE, UPDATE e ALTER_TABLE.
QualityResult	Object		Qualidade da instrução SQL.
ErrorMessage	String	syntax error	Mensagem de erro retornada.
Results	Array of Results		Resultados da revisão baseados em regras.
RuleName	String	SELECT_SUGGEST_ASSIGN_WHERE	Nome da regra. Para mais informações, consulte Otimização de revisão de SQL.
Feedback	String	MUST_IMPROVE	Sugestão de otimização para a instrução SQL. Valores válidos: MUST_IMPROVE: a instrução SQL precisa ser melhorada. POTENTIAL_ISSUE: a instrução SQL contém problemas potenciais. SUGGEST_IMPROVE: recomenda-se melhorar a instrução SQL. USEDMSTOOLKIT: recomenda-se alterar esquemas sem bloquear tabelas. USEDMSDML_UNLOCK: recomenda-se alterar dados sem bloquear tabelas. TABLEINDEXSUGGEST: recomenda-se usar instruções SQL com índices.
Comments	String	xxx especifica que as instruções SQL devem conter a cláusula WHERE.	Comentário definido durante a criação da regra de revisão de SQL. Para mais informações, consulte Otimização de revisão de SQL.
Messages	Array of String	A tabela xxx não existe.	Resultados da revisão.
Scripts	Array of Scripts		Script SQL para alteração de dados.
OpType	String	AddIndex	Finalidade do script SQL. O valor é definido como AddIndex.
Content	String	alter table xxx add index idx_xx(yyy);	Conteúdo do script SQL.
TableName	String	xxx	Nome da tabela.
RuleType	String	REVIEW	Tipo da regra de revisão de SQL. Valores válidos: REVIEW: regra usada para revisar instruções SQL com base em padrões. OPTIMIZE: regra usada para fornecer sugestões de otimização.
OccurError	Boolean	false	Indica se ocorreu um erro. Valores válidos: true: ocorreu um erro. false: nenhum erro ocorreu.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.