ListTopics - DataWorks: Central de Documentação do Alibaba Cloud

Consulta ou pesquisa uma lista de eventos.

Descrição da operação

Antes de começar: Ative a DataWorks Enterprise Edition ou Ultimate Edition antes de chamar esta operação. Se a edição não estiver ativada, o serviço retornará 403 Forbidden.Access.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
BeginTime	string	Sim	A hora de início para descoberta. Especifique a hora no formato UTC (yyyy-MM-dd'T'HH:mm:ssZ).	2019-03-24T00:00:00+0800
EndTime	string	Sim	A hora de término para descoberta. Especifique a hora no formato UTC (yyyy-MM-dd'T'HH:mm:ssZ).	2019-03-25T23:00:00+0800
TopicTypes	string	Não	O tipo do evento. Valores válidos: SLOW (lento) e ERROR (erro). Separe vários tipos de eventos com vírgulas (,).	ERROR,SLOW
TopicStatuses	string	Não	O status do evento. Valores válidos: IGNORE (ignorado), NEW (recém-descoberto), FIXING (em processamento) e RECOVER (recuperado). Separe vários status de eventos com vírgulas (,).	IGNORE,NEW,FIXING,RECOVER
NodeId	integer	Não	O ID do nó associado ao evento. Este parâmetro é mutuamente exclusivo com InstanceId.	1234
InstanceId	integer	Não	O ID da instância associada ao evento. Este parâmetro é mutuamente exclusivo com NodeId.	12345
Owner	string	Não	O UID da Alibaba Cloud do proprietário do evento.	952795****
PageNumber	integer	Sim	O número da página. Valor padrão: 1. Valor mínimo: 1. Valor máximo: 30.	1
PageSize	integer	Sim	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID exclusivo da solicitação. Você pode usar este ID para solucionar problemas.	0000-ABCD-EFG****
ErrorMessage	string	A mensagem de erro.	The specified parameters are invalid
ErrorCode	string	O código de erro.	1031203110005
Success	boolean	Indica se a chamada foi bem-sucedida.	true
Data	object	A lista de eventos retornada.
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número de entradas por página.	10
TotalCount	integer	O número total de eventos.	100
Topics	array<object>	A lista de eventos.
	object
TopicName	string	O nome do evento.	1234出错
ProjectId	integer	O ID do workspace ao qual o nó pertence.	1234
NodeOwner	string	O ID da conta Alibaba Cloud usada pelo proprietário do nó.	952795****
InstanceId	integer	O ID da instância do nó que aciona o evento.	12345
FixTime	integer	O timestamp em que o evento foi processado.	1553508465000
TopicType	string	O tipo do evento. Valores válidos: SLOW e ERROR. O valor SLOW indica que a duração da execução do nó no ciclo de agendamento atual é significativamente maior que a duração média da execução do nó nos ciclos de agendamento anteriores. O valor ERROR indica que o nó falhou durante a execução.	ERROR
TopicStatus	string	O status do evento. Valores válidos: IGNORE, NEW, FIXING e RECOVER. O valor IGNORE indica que o evento é ignorado. O valor NEW indica que o evento é um novo evento. O valor FIXING indica que o evento está sendo processado. O valor RECOVER indica que o evento foi processado.	NEW
HappenTime	integer	O timestamp em que o evento ocorreu. Pode haver uma diferença de tempo entre o momento em que o evento ocorreu e o momento em que o evento foi detectado.	1553508465000
NodeName	string	O nome do nó.	节点名称
TopicId	integer	O ID do evento.	1234
AddTime	integer	O timestamp em que o evento foi detectado.	1553524393000
NodeId	integer	O ID do nó que aciona o evento.	1234

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Topics": [
      {
        "TopicName": "1234出错",
        "ProjectId": 1234,
        "NodeOwner": "952795****",
        "InstanceId": 12345,
        "FixTime": 1553508465000,
        "TopicType": "ERROR",
        "TopicStatus": "NEW",
        "HappenTime": 1553508465000,
        "NodeName": "节点名称",
        "TopicId": 1234,
        "AddTime": 1553524393000,
        "NodeId": 1234
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Acesso negado. Autorize o acesso.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.