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

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	ListSQLReviewOriginSQL	Operação a executar. Defina o valor como ListSQLReviewOriginSQL.
OrderId	Long	Sim	123321	ID do ticket. Chame a operação CreateSQLReviewOrder para consultar esse ID.
OrderActionDetail	Object	Não		Parâmetros para filtrar as instruções SQL envolvidas no ticket.
FileId	Long	Não	123345	ID do arquivo.
SQLReviewResult	String	Não	MUST_IMPROVE	Sugestão de otimização da instrução SQL. Valores válidos: MUST_IMPROVE: Otimização obrigatória da instrução SQL. POTENTIAL_ISSUE: Problemas potenciais na instrução SQL. SUGGEST_IMPROVE: Recomendação de otimização da instrução SQL. USE_DMS_TOOLKIT: Recomendação de alteração de esquemas sem bloqueio de tabelas. USE_DMS_DML_UNLOCK: Recomendação de alteração de dados sem bloqueio de tabelas. TABLE_INDEX_SUGGEST: Recomendação de otimização de índices.
CheckStatusResult	String	Não	check_not_pass	Status de revisão da instrução SQL. Valores válidos: new: Análise pendente. unknown: Falha na análise da instrução SQL. check_not_pass: Reprovada na revisão. check_pass: Aprovada na revisão. force_pass: Status alterado manualmente para aprovado. force_not_pass: Status alterado manualmente para reprovado.
Page	Object	Não		Detalhes da paginação de retorno.
PageNumber	Integer	Não	1	Número da página a retornar.
PageSize	Integer	Não	20	Quantidade de entradas por página.
Tid	Long	Não	1	ID do locatário. Chame a operação GetUserActiveTenant ou ListUserTenants para obter esse ID.

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 em caso de falha na solicitação.
ErrorMessage	String	UnknownError	Mensagem de erro retornada em caso de falha na solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.
TotalCount	Integer	10	Total de instruções SQL.
OriginSQLList	Array of OriginSQLList		Informações das instruções SQL analisadas.
SQLId	Long	1111	ID da instrução SQL.
FileId	Long	123321	ID do arquivo.
FileName	String	test.sql	Nome do arquivo.
SQLContent	String	select id from table_name	Instrução SQL.
CheckStatus	String	check_pass	Status de revisão da instrução SQL. Valores válidos: new: Análise pendente. unknown: Falha na análise da instrução SQL. check_not_pass: Reprovada na revisão. check_pass: Aprovada na revisão. force_pass: Status alterado manualmente para aprovado. force_not_pass: Status alterado manualmente para reprovado.
StatusDesc	String	The SQL statement passed the review.	Descrição do status de revisão.
CheckedTime	String	2021-06-09 21:07:00	Horário da revisão da instrução SQL.
SqlHash	String	95adb6e77a0884d9e50232cb8c5c969d	Hash MD5 da instrução SQL.
ReviewSummary	String	{"POTENTIAL_ISSUE":1,"SUGGEST_IMPROVE":1}	Sugestão de otimização da instrução SQL em formato de string JSON. Valores válidos: MUST_IMPROVE: Otimização obrigatória da instrução SQL. POTENTIAL_ISSUE: Problemas potenciais na instrução SQL. SUGGEST_IMPROVE: Recomendação de otimização da instrução SQL. USEDMSTOOLKIT: Recomendação de alteração de esquemas sem bloqueio de tabelas. USEDMSDML_UNLOCK: Recomendação de alteração de dados sem bloqueio de tabelas. TABLEINDEXSUGGEST: Recomendação de otimização de índices.
SQLReviewQueryKey	String	a57e54ec5433475ea3082d882fdb89c5	Chave para consulta dos detalhes das sugestões de otimização. Utilize a operação GetSQLReviewOptimizeDetail com essa chave para obter tais detalhes.
SQLName	String	getByPk	Nome da instrução SQL.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas

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 erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.