GetRequestDiagnosisPage - Database Autonomy Service: Central de Documentação do Alibaba Cloud

Consulta os registros de diagnóstico de SQL por página.

Descrição da operação

Antes de chamar esta operação, observe os seguintes itens:

Se você usar um SDK para chamar operações de API do Database Autonomy Service (DAS), deverá definir o ID da região como cn-shanghai.
Esta operação oferece suporte aos seguintes mecanismos de banco de dados:
- ApsaraDB RDS for MySQL.
- ApsaraDB RDS for PostgreSQL.
- ApsaraDB RDS for SQL Server.
- PolarDB for MySQL.
- PolarDB for PostgreSQL (Compatível com Oracle)
- ApsaraDB for MongoDB.

Nota

A versão secundária do mecanismo da instância do ApsaraDB RDS for PostgreSQL deve ser 20220130 ou posterior. Para obter mais informações sobre como verificar e atualizar a versão secundária do mecanismo de uma instância do ApsaraDB RDS for PostgreSQL, consulte Atualizar a versão secundária do mecanismo de uma instância do ApsaraDB RDS for PostgreSQL.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

hdm:GetRequestDiagnosisPage

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	rm-0iwhhl8gx0ld6****
NodeId	string	Não	O ID do nó. Nota Você deve especificar o ID do nó se a sua instância de banco de dados for uma instância do PolarDB for MySQL, PolarDB for PostgreSQL (Compatível com Oracle) ou ApsaraDB for MongoDB.	202****
PageNo	integer	Sim	O número da página. O valor deve ser um número inteiro positivo. Valor padrão: 1.	1
PageSize	integer	Sim	O número de entradas por página. O valor deve ser um número inteiro positivo. Valor padrão: 10.	10
StartTime	integer	Sim	O início do intervalo de tempo a ser consultado. Defina este parâmetro como um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1633071840000
EndTime	integer	Sim	O fim do intervalo de tempo a ser consultado. Defina este parâmetro como um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1634972640000

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
Message	string	A mensagem retornada. Nota Se a solicitação for bem-sucedida, Successful será retornado. Se a solicitação falhar, uma mensagem de erro que contém informações como um código de erro será retornada.	Successful
RequestId	string	O ID da solicitação.	800FBAF5-A539-5B97-A09E-C63AB2F7****
Data	object	Os dados retornados.
list	array<object>	Os registros de diagnóstico de SQL retornados.
	object
messageId	string	The unique ID of the diagnostics task.	61820b594664275c4429****
uuid	string	The unique ID of the diagnostics instance.	hdm_51fe9bc19ec413f4d530431af87a****
accountId	string	The user ID.	2093****
sqlId	string	The SQL template ID.	0c95dae3afef77be06572612df9b****
engine	string	The database engine. Valid values: MySQL PostgreSQL SQLServer PolarDBMySQL PolarDBOracle MongoDB	MySQL
dbSchema	string	The name of the database.	das
param	string	Additional information.	{"":""}
state	integer	The status of the diagnostics task. Valid values: 0: The diagnostics task is in progress. 1: A diagnostics error occurred. 2: The diagnostics task is complete. 3: An SQL error occurred. 4: An engine error occurred.	2
result	string	The result of the SQL diagnostics task. The result includes the following information: endTime: the end time of the SQL diagnostics task. errorCode: indicates whether the SQL diagnostics task is complete. Valid values: 0001: The SQL diagnostics task is complete. 0003: The SQL diagnostics task failed. errorMessage: the error message. estimateCost: the estimated cost. cpu: the estimated CPU utilization of the index. io: the estimated I/O usage of the index. rows: the estimated values of the rows returned for the index. improvement: the performance improvement ratio. indexAdvices: the index recommendations, which include the following information: columns: the index columns. ddlAddIndex: the DDL statement for the index. indexName: the name of the index. schemaName: the name of the database. tableName: the name of the table. unique: indicates whether the index is unique. ip: the IP address of the instance. messageId: the ID of the diagnostics task. port: the port used to connect to the instance. sqlTag: the SQL tag. startTime: the start time of the SQL diagnostics task. success: indicates whether the request was successful. support: indicates whether the SQL statement can be diagnosed. Valid values: true: The SQL statement can be diagnosed. false: The SQL statement cannot be diagnosed. tuningAdvices: the SQL rewrite suggestions.	{ "endTime":1636354256000, "errorCode":"0001", "errorMessage":"TFX成功", "estimateCost":{ "cpu":1.7878745150389268, "io":9.948402604746128, "rows":8.889372575194633 }, "improvement":12933.97, "indexAdvices":[ { "columns":[ "work_no" ], "ddlAddIndex":"ALTER TABLE `test`.`work_order` ADD INDEX `idx_workno` (`work_no`)", "indexName":"idx_workno", "schemaName":"test", "tableName":"work_order", "unique":false } ], "ip":"**.mysql.rds.aliyuncs.com", "messageId":"6188c8cb2f1365b16aee**", "port":3306, "sqlTag":"{\"PRED_EQUAL\":\"Y\",\"CNT_QB\":\"1\",\"CNT_TB\":\"1\"}", "startTime":1636354252000, "success":true, "support":true, "tuningAdvices":[ ] }
gmtCreate	string	The time when the SQL diagnostics task was created. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1633071840000
gmtModified	string	The time when the SQL diagnostics task was modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1633071850000
pageNo	integer	O número da página. O valor deve ser um número inteiro positivo. Valor padrão: 1.	1
pageSize	integer	O número de entradas por página. O valor deve ser um número inteiro positivo. Valor padrão: 10.	10
total	integer	O número total de entradas retornadas.	100
extra	string	Informações adicionais.	{"":""}
Code	string	O código de status HTTP retornado.	200
Success	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "Successful",
  "RequestId": "800FBAF5-A539-5B97-A09E-C63AB2F7****",
  "Data": {
    "list": [
      {
        "messageId": "61820b594664275c4429****",
        "uuid": "hdm_51fe9bc19ec413f4d530431af87a****",
        "accountId": "2093****",
        "sqlId": "0c95dae3afef77be06572612df9b****",
        "engine": "MySQL",
        "dbSchema": "das",
        "param": "{\"\":\"\"}",
        "state": 2,
        "result": "{     \"endTime\":1636354256000,     \"errorCode\":\"0001\",     \"errorMessage\":\"TFX成功\",     \"estimateCost\":{         \"cpu\":1.7878745150389268,         \"io\":9.948402604746128,         \"rows\":8.889372575194633     },     \"improvement\":12933.97,     \"indexAdvices\":[         {             \"columns\":[                 \"work_no\"             ],             \"ddlAddIndex\":\"ALTER TABLE `test`.`work_order` ADD INDEX `idx_workno` (`work_no`)\",             \"indexName\":\"idx_workno\",             \"schemaName\":\"test\",             \"tableName\":\"work_order\",             \"unique\":false         }     ],     \"ip\":\"****.mysql.rds.aliyuncs.com\",     \"messageId\":\"6188c8cb2f1365b16aee****\",     \"port\":3306,     \"sqlTag\":\"{\\\"PRED_EQUAL\\\":\\\"Y\\\",\\\"CNT_QB\\\":\\\"1\\\",\\\"CNT_TB\\\":\\\"1\\\"}\",     \"startTime\":1636354252000,     \"success\":true,     \"support\":true,     \"tuningAdvices\":[      ] }",
        "gmtCreate": "1633071840000",
        "gmtModified": "1633071850000"
      }
    ],
    "pageNo": 1,
    "pageSize": 10,
    "total": 100,
    "extra": "{\"\":\"\"}"
  },
  "Code": "200",
  "Success": "true"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.