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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListAlertMessages	A operação a ser executada. Defina o valor como ListAlertMessages.
PageNumber	Integer	Sim	1	Número da página. Valores válidos: 1 a 30. Valor padrão: 1.
PageSize	Integer	Sim	10	Número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
BeginTime	String	Sim	2020-04-02T00:00:00+0800	Início do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601, no formato yyyy-MM-dd'T'HH:mm:ssZ. A hora deve estar em UTC.
EndTime	String	Sim	2020-04-04T00:00:00+0800	Fim do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601, no formato yyyy-MM-dd'T'HH:mm:ssZ. A hora deve estar em UTC.
RemindId	Long	Não	9527	ID da regra de alerta personalizada. Este parâmetro entra em vigor se o parâmetro AlertRuleTypes estiver definido como USER_DEFINE. Configure este parâmetro ou o parâmetro BaselineId.
AlertMethods	String	Não	SMS,MAIL,PHONE	Método de notificação. Valores válidos: MAIL SMS As notificações de alerta podem ser enviadas por mensagem de texto apenas nas regiões de Singapura, Malásia (Kuala Lumpur) e Alemanha (Frankfurt). Especifique vários métodos de notificação separados por vírgulas (,).
AlertUser	String	Não	123456	ID da conta Alibaba Cloud do destinatário do alerta.
AlertRuleTypes	String	Não	GLOBAL,USER_DEFINE,OTHER	Tipo da regra de alerta. Valores válidos: GLOBAL, USER_DEFINE e OTHER. GLOBAL indica uma regra de alerta global. USER_DEFINE indica uma regra de alerta personalizada pelo usuário. OTHER indica uma regra de alerta de outro tipo. Especifique vários tipos separados por vírgulas (,).
BaselineId	Long	Não	1234	ID da linha de base. Este parâmetro entra em vigor se o parâmetro AlertRuleTypes estiver definido como GLOBAL. Configure este parâmetro ou o parâmetro RemindId.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	Integer	200	Código de status HTTP.
RequestId	String	0000-ABCD-EFG****	ID da solicitação.
ErrorMessage	String	The specified parameters are invalid.	Mensagem de erro.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	Código de erro.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.
Data	Object		Informações sobre os alertas retornados.
PageNumber	String	1	Número da página.
PageSize	String	10	Número de entradas por página.
TotalCount	String	100	Número total de alertas retornados.
AlertMessages	Array of AlertMessages		Os alertas.
RemindId	Long	1234	ID da regra de alerta personalizada acionada. Retornado se o valor do parâmetro Source for REMIND_ALERT.
AlertMessageStatus	String	READY_TO_SEND	Status de envio da notificação. Valores válidos: READY_TO_SEND, SEND_FAIL, SEND_SUCCESS e SEND_OVERLIMIT. READY_TO_SEND indica que a notificação aguarda envio. SEND_FAIL indica falha no envio. SEND_SUCCESS indica que a notificação foi enviada. SEND_OVERLIMIT indica que o número de notificações enviadas excedeu o limite superior.
AlertUser	String	9527952795****	ID da conta Alibaba Cloud do destinatário do alerta.
AlertTime	Long	1553531401000	Carimbo de data/hora em que o alerta foi reportado.
AlertMethod	String	SMS	Método de notificação. Valores válidos: MAIL, SMS e PHONE. MAIL indica envio por e-mail. SMS indica envio por mensagem de texto. PHONE indica envio por chamada telefônica. Apenas o DataWorks Professional Edition e edições superiores suportam o método PHONE.
Source	String	REMIND_ALERT	Tipo do alerta. Valores válidos: REMIND_ALERT, TOPIC_ALERT, SLA_ALERT, NODE_CYCLE_ALERT e NODE_LONELY_ALERT. REMIND_ALERT indica um alerta personalizado. TOPIC_ALERT indica um alerta de evento. SLA_ALERT indica um alerta de linha de base. NODE_CYCLE_ALERT indica um alerta reportado para um loop de dependência de nó. NODE_LONELY_ALERT indica um alerta reportado para nós isolados.
Content	String	Errors on a node	Conteúdo do alerta.
RemindName	String	Name of the custom alert rule	Nome da regra de alerta personalizada acionada. Retornado se o valor do parâmetro Source for REMIND_ALERT.
AlertId	Long	1234	ID do alerta.
Instances	Array of Instances		Instâncias que acionaram a regra de alerta personalizada. Retornado se o valor do parâmetro Source for REMIND_ALERT. Caso contrário, este parâmetro fica vazio.
Status	String	NOT_RUN	Status da instância. Valores válidos: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE e SUCCESS. NOT_RUN indica que a instância não foi executada. WAIT_TIME indica que a instância aguarda execução. WAIT_RESOURCE indica que a instância aguarda recursos. RUNNING indica que a instância está em execução. CHECKING indica que a qualidade dos dados está sendo verificada para o nó onde a instância foi gerada. CHECKING_CONDITION indica que as condições de ramificação estão sendo verificadas para o nó onde a instância foi gerada. FAILURE indica falha na execução da instância. SUCCESS indica que a instância foi executada com êxito.
InstanceId	Long	12345	ID da instância.
NodeName	String	Node name	Nome do nó.
NodeId	Long	1234	ID do nó.
ProjectId	Long	1234	ID do workspace ao qual o nó pertence.
Topics	Array of Topics		Eventos que acionaram alertas. Retornado se o valor do parâmetro Source for TOPIC_ALERT. Caso contrário, este parâmetro fica vazio.
TopicName	String	9527 error	Nome do evento.
InstanceId	Long	12345	ID da instância que acionou o evento.
TopicId	Long	1234	ID do evento.
TopicOwner	String	9527952795****	ID da conta Alibaba Cloud do proprietário do evento.
NodeId	Long	1234	ID do nó que acionou o evento.
TopicStatus	String	FIXING	Status do evento. Valores válidos: IGNORE, NEW, FIXING e RECOVER. IGNORE indica que o evento foi ignorado. NEW indica um novo evento. FIXING indica que o evento está sendo tratado. RECOVER indica que o evento foi resolvido.
Nodes	Array of Nodes		Nós retornados para diferentes origens de alerta. Nós que formam um loop são retornados se o valor do parâmetro Source for NODE_CYCLE_ALERT. Nós isolados são retornados se o valor do parâmetro Source for NODE_LONELY_ALERT.
Owner	String	95279527952****	ID da conta Alibaba Cloud do proprietário do nó.
NodeName	String	Node name	Nome do nó.
NodeId	Long	1234	ID do nó.
ProjectId	Long	1234	ID do workspace ao qual o nó pertence.
SlaAlert	Object		Informações básicas sobre a instância de linha de base que acionou um alerta. Retornado se o valor do parâmetro Source for SLA_ALERT. Caso contrário, este parâmetro fica vazio.
Status	String	SAFE	Status da linha de base. Valores válidos: ERROR, SAFE, DANGEROUS e OVER. ERROR indica que nenhum nó está associado à linha de base ou que todos os nós associados estão suspensos. SAFE indica que os nós foram executados antes do início da duração do alerta. DANGEROUS indica que os nós ainda estão em execução após o término da duração do alerta, mas o tempo comprometido não chegou. OVER indica que os nós ainda estão em execução após o tempo comprometido.
BaselineOwner	String	952795279****	ID da conta Alibaba Cloud do proprietário da linha de base. Vários IDs são separados por vírgulas (,).
BaselineId	Long	1234	ID da linha de base.
BaselineName	String	Baseline name	Nome da linha de base.
Bizdate	Long	1553443200000	Carimbo de data/hora dos dados da instância de linha de base.
ProjectId	Long	1234	ID do workspace ao qual a linha de base pertence.
InGroupId	Integer	1	ID do ciclo da instância de linha de base. Valores válidos do ID de um ciclo por hora: 1 a 24. O ID de um ciclo diário é 1.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=ListAlertMessages
&PageNumber=1
&PageSize=10
&BeginTime=2020-04-02T00:00:00+0800
&EndTime=2020-04-04T00:00:00+0800
&RemindId=9527
&AlertMethods=SMS,MAIL,PHONE
&AlertUser=123456
&AlertRuleTypes=GLOBAL,USER_DEFINE,OTHER
&BaselineId=1234
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<ListAlertMessagesResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>The specified parameters are invalid.</ErrorMessage>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <AlertMessages>
            <RemindId>1234</RemindId>
            <AlertMessageStatus>READY_TO_SEND</AlertMessageStatus>
            <AlertUser>9527952795****</AlertUser>
            <AlertTime>1553531401000</AlertTime>
            <AlertMethod>SMS</AlertMethod>
            <Source>REMIND_ALERT</Source>
            <Content>Errors on a node</Content>
            <RemindName>Name of the custom alert rule</RemindName>
            <AlertId>1234</AlertId>
            <Instances>
                <Status>NOT_RUN</Status>
                <InstanceId>12345</InstanceId>
                <NodeName>Node name</NodeName>
                <NodeId>1234</NodeId>
                <ProjectId>1234</ProjectId>
            </Instances>
            <Topics>
                <TopicName>9527 error</TopicName>
                <InstanceId>12345</InstanceId>
                <TopicId>1234</TopicId>
                <TopicOwner>9527952795****</TopicOwner>
                <NodeId>1234</NodeId>
                <TopicStatus>FIXING</TopicStatus>
            </Topics>
            <Nodes>
                <Owner>95279527952****</Owner>
                <NodeName>Node name</NodeName>
                <NodeId>1234</NodeId>
                <ProjectId>1234</ProjectId>
            </Nodes>
            <SlaAlert>
                <Status>SAFE</Status>
                <BaselineOwner>952795279****</BaselineOwner>
                <BaselineId>1234</BaselineId>
                <BaselineName>Baseline name</BaselineName>
                <Bizdate>1553443200000</Bizdate>
                <ProjectId>1234</ProjectId>
                <InGroupId>1</InGroupId>
            </SlaAlert>
        </AlertMessages>
    </Data>
</ListAlertMessagesResponse>

Formato JSON

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "0000-ABCD-EFG****",
  "ErrorMessage" : "The specified parameters are invalid.",
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Success" : true,
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 100,
    "AlertMessages" : {
      "RemindId" : 1234,
      "AlertMessageStatus" : "READY_TO_SEND",
      "AlertUser" : "9527952795****",
      "AlertTime" : 1553531401000,
      "AlertMethod" : "SMS",
      "Source" : "REMIND_ALERT",
      "Content" : "Errors on a node",
      "RemindName" : "Name of the custom alert rule",
      "AlertId" : 1234,
      "Instances" : {
        "Status" : "NOT_RUN",
        "InstanceId" : 12345,
        "NodeName" : "Node name",
        "NodeId" : 1234,
        "ProjectId" : 1234
      },
      "Topics" : {
        "TopicName" : "9527 error",
        "InstanceId" : 12345,
        "TopicId" : 1234,
        "TopicOwner" : "9527952795****",
        "NodeId" : 1234,
        "TopicStatus" : "FIXING"
      },
      "Nodes" : {
        "Owner" : "95279527952****",
        "NodeName" : "Node name",
        "NodeId" : 1234,
        "ProjectId" : 1234
      },
      "SlaAlert" : {
        "Status" : "SAFE",
        "BaselineOwner" : "952795279****",
        "BaselineId" : 1234,
        "BaselineName" : "Baseline name",
        "Bizdate" : 1553443200000,
        "ProjectId" : 1234,
        "InGroupId" : 1
      }
    }
  }
}

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 superior.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.	O número de solicitações diárias para o recurso excedeu o limite superior.
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 foram enviadas em um curto período. Tente novamente mais tarde.
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. Tente outra região.
500	InternalError.System	An internal system error occurred. Try again later.	Ocorreu um erro interno do sistema. Tente novamente mais tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Ocorreu um erro interno do sistema. Tente novamente mais tarde.

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