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

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 da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListTopics	Operação a executar. Defina o valor como ListTopics.
BeginTime	String	Sim	2019-03-24T00:00:00+0800	Início do intervalo de tempo da consulta. Especifique o horário no formato yyyy-MM-dd'T'HH:mm:ssZ, em UTC.
EndTime	String	Sim	2019-03-25T23:00:00+0800	Fim do intervalo de tempo da consulta. Especifique o horário no formato yyyy-MM-dd'T'HH:mm:ssZ, em UTC.
TopicTypes	String	Não	ERROR,SLOW	Tipo do evento. Valores válidos: SLOW e ERROR. SLOW indica que a duração da tarefa excede significativamente a média dos ciclos anteriores. ERROR sinaliza falha na execução da tarefa. Separe múltiplos tipos por vírgulas (,).
TopicStatuses	String	Não	IGNORE,NEW,FIXING,RECOVER	Status do evento. Valores válidos: IGNORE, NEW, FIXING e RECOVER. IGNORE significa evento ignorado; NEW, novo evento; FIXING, evento em processamento; RECOVER, evento tratado. Separe múltiplos status por vírgulas (,).
NodeId	Long	Não	1234	ID do nó que acionou o evento. Se configurado, dispensa o parâmetro InstanceId.
InstanceId	Long	Não	12345	ID da instância do nó que acionou o evento. Se configurado, dispensa o parâmetro NodeId.
Owner	String	Não	952795****	ID da conta Alibaba Cloud do proprietário do evento.
PageNumber	Integer	Sim	1	Número da página a retornar. Valores válidos: 1 a 30. Valor padrão: 1.
PageSize	Integer	Sim	10	Quantidade de registros por página. Valor padrão: 10. Valor máximo: 100.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	Integer	200	Código de status HTTP retornado.
RequestId	String	0000-ABCD-EFG****	ID da solicitação. Use este ID para solucionar problemas.
ErrorMessage	String	The specified parameters are invalid.	Mensagem de erro retornada.
ErrorCode	String	1031203110005	Código de erro retornado.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.
Data	Object		Lista de eventos retornados.
PageNumber	Integer	1	Número da página retornada.
PageSize	Integer	10	Quantidade de registros retornados por página.
TotalCount	Integer	100	Total de eventos retornados.
Topics	Array of Topics		Lista de eventos.
TopicName	String	1234 error	Nome do evento.
ProjectId	Long	1234	ID do workspace ao qual o nó pertence.
NodeOwner	String	952795****	ID da conta Alibaba Cloud do proprietário do nó.
InstanceId	Long	12345	ID da instância que acionou o evento.
FixTime	Long	1553508465000	Timestamp de processamento do evento.
TopicType	String	ERROR	Tipo do evento. Valores válidos: SLOW e ERROR. SLOW indica duração da tarefa muito superior à média histórica. ERROR aponta falha na execução.
TopicStatus	String	NEW	Status do evento. Valores válidos: IGNORE, NEW, FIXING e RECOVER. IGNORE refere-se a eventos ignorados; NEW, a eventos recentes; FIXING, a eventos em tratamento; RECOVER, a eventos resolvidos.
HappenTime	Long	1553508465000	Timestamp de ocorrência do evento. Pode haver diferença entre o momento da ocorrência e o da detecção.
NodeName	String	Node name	Nome do nó.
TopicId	Long	1234	ID do evento.
AddTime	Long	1553524393000	Timestamp de detecção do evento.
NodeId	Long	1234	ID do nó que acionou o evento.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=ListTopics
&BeginTime=2019-03-24T00:00:00+0800
&EndTime=2019-03-25T23:00:00+0800
&TopicTypes=ERROR,SLOW
&TopicStatuses=IGNORE,NEW,FIXING,RECOVER
&NodeId=1234
&InstanceId=12345
&Owner=952795****
&PageNumber=1
&PageSize=10
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTopicsResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>The specified parameters are invalid.</ErrorMessage>
    <ErrorCode>1031203110005</ErrorCode>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <Topics>
            <TopicName>1234 error</TopicName>
            <ProjectId>1234</ProjectId>
            <NodeOwner>952795****</NodeOwner>
            <InstanceId>12345</InstanceId>
            <FixTime>1553508465000</FixTime>
            <TopicType>ERROR</TopicType>
            <TopicStatus>NEW</TopicStatus>
            <HappenTime>1553508465000</HappenTime>
            <NodeName>Node name</NodeName>
            <TopicId>1234</TopicId>
            <AddTime>1553524393000</AddTime>
            <NodeId>1234</NodeId>
        </Topics>
    </Data>
</ListTopicsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 error",
      "ProjectId" : 1234,
      "NodeOwner" : "952795****",
      "InstanceId" : 12345,
      "FixTime" : 1553508465000,
      "TopicType" : "ERROR",
      "TopicStatus" : "NEW",
      "HappenTime" : 1553508465000,
      "NodeName" : "Node name",
      "TopicId" : 1234,
      "AddTime" : 1553524393000,
      "NodeId" : 1234
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
429	Throttling.Api	The request for this resource has exceeded your available limit.	O número de solicitações para o recurso excedeu o limite permitido.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.	O volume diário de solicitações para o recurso ultrapassou o limite estabelecido.
429	Throttling.System	The DataWorks system is busy. Try again later.	O sistema do DataWorks está ocupado. Tente novamente mais tarde.
429	Throttling.User	Your request is too frequent. Try again later.	Muitas solicitações enviadas em curto período. Aguarde e tente novamente.
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.	A API do DataWorks não está disponível nesta região. Utilize outra região.
500	InternalError.System	An internal system error occurred. Try again later.	Ocorreu um erro interno no sistema. Tente novamente mais tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Falha interna detectada. Repita a operação posteriormente.

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