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

Consulta uma lista de regras de alerta personalizadas.

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
PageNumber	integer	Sim	O número da página a ser retornada. Valores válidos: 1 a 30. Valor padrão: 1.	1
PageSize	integer	Sim	O número de entradas a serem retornadas em cada página. Valor padrão: 10. Valor máximo: 100.	10
Founder	string	Não	O ID da conta Alibaba Cloud usada para criar as regras de alerta personalizadas.	9527952795****
NodeId	integer	Não	O ID do nó ao qual as regras de alerta personalizadas são aplicadas. Você pode usar o ID para pesquisar as regras de alerta personalizadas aplicadas ao nó.	1234
RemindTypes	string	Não	As condições que acionam um alerta para o nó. Valores válidos: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED e TIMEOUT. O valor FINISHED indica que o nó termina a execução. O valor UNFINISHED indica que o nó ainda está em execução no momento especificado. O valor ERROR indica que ocorre um erro quando o nó está em execução. O valor CYCLE_UNFINISHED indica que o nó não termina a execução no ciclo de agendamento especificado. O valor TIMEOUT indica que o nó atinge o tempo limite. Você pode especificar várias condições para uma regra de alerta personalizada. Se você especificar várias condições, separe-as com vírgulas (,).	FINISHED,ERROR
AlertTarget	string	Não	O ID da conta Alibaba Cloud usada para receber notificações de alerta.	9527952795****
SearchText	string	Não	A palavra-chave no nome de uma regra usada para pesquisar a regra. A pesquisa aproximada é suportada.	Fuzzy search for a rule name

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
HttpStatusCode	integer	O código de status HTTP retornado.	200
RequestId	string	O ID da solicitação. Você pode usar o ID para solucionar problemas.	0000-ABCD-EFG****
ErrorMessage	string	A mensagem de erro retornada.	The specified parameters are invalid.
ErrorCode	string	O código de erro retornado.	1031203110005
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Data	object	Os dados retornados.
PageNumber	integer	O número da página retornada.	1
PageSize	integer	O número de entradas retornadas por página.	10
TotalCount	integer	O número total de regras de alerta personalizadas.	100
Reminds	array<object>	A lista de regras de alerta personalizadas.
	object	A lista de regras de alerta personalizadas.
Founder	string	O ID da conta Alibaba Cloud usada pelo criador da regra.	952795****
RemindId	integer	O ID da regra de alerta personalizada.	1234
AlertUnit	string	O destinatário do alerta. Valores válidos: OWNER e OTHER. O valor OWNER indica o proprietário do nó. O valor OTHER indica um usuário especificado.	OWNER
RemindType	string	A condição que aciona um alerta. Valores válidos: FINISHED: finished, UNFINISHED: unfinished: finished, ERROR: error, CYCLE_UNFINISHED: cycle unfinished: unfinished: finished e TIMEOUT: execution timeout.	FINISHED
DndEnd	string	A hora de término do horário de silêncio. A hora está no formato hh:mm. Valores válidos de hh: [0,23]. Valores válidos de mm: [0,59].	08:00
DndStart	string	A hora de início do horário de silêncio. A hora está no formato hh:mm. Valores válidos de hh: [0,23]. Valores válidos de mm: [0,59].	00:00
RemindUnit	string	O tipo de objeto ao qual a regra de alerta personalizada é aplicada. Valores válidos: NODE, BASELINE, PROJECT e BIZPROCESS. O valor NODE indica um nó. O valor BASELINE indica uma linha de base. O valor PROJECT indica um workspace. O valor BIZPROCESS indica um fluxo de trabalho.	NODE
Useflag	boolean	Indica se a regra de alerta personalizada está ativada. Valores válidos: true e false.	true
RemindName	string	O nome da regra de alerta personalizada.	Rule name
AlertTargets	array	Os IDs das contas Alibaba Cloud usadas pelos destinatários do alerta.
	string	O ID da conta Alibaba Cloud usada pelo destinatário do alerta.	952795****
NodeIds	array	Os IDs dos nós aos quais a regra de alerta personalizada é aplicada. Este parâmetro é retornado se o valor do parâmetro RemindUnit for NODE.
	integer	O ID do nó ao qual a regra de alerta personalizada é aplicada. Este parâmetro é retornado se o valor do parâmetro RemindUnit for NODE.	1234
BizProcessIds	array	Os IDs dos fluxos de trabalho aos quais a regra de alerta personalizada é aplicada. Este parâmetro é retornado se o valor do parâmetro RemindUnit for BIZPROCESS.
	integer	O ID do fluxo de trabalho ao qual a regra de alerta personalizada é aplicada. Este parâmetro é retornado se o valor do parâmetro RemindUnit for BIZPROCESS.	9527
ProjectIds	array	Os IDs dos workspaces aos quais a regra de alerta personalizada é aplicada. Este parâmetro é retornado se o valor do parâmetro RemindUnit for PROJECT.
	integer	O ID do workspace ao qual a regra de alerta personalizada é aplicada. Este parâmetro é retornado se o valor do parâmetro RemindUnit for PROJECT.	1234
BaselineIds	array	Os IDs das linhas de base às quais a regra de alerta personalizada é aplicada. Este parâmetro é retornado se o valor do parâmetro RemindUnit for BASELINE.
	integer	O ID da linha de base à qual a regra de alerta personalizada é aplicada. Este parâmetro é retornado se o valor do parâmetro RemindUnit for BASELINE.	9527
AlertMethods	array	O método de notificação. Valores válidos: MAIL (e-mail), SMS (mensagem de texto) e PHONE (chamada telefônica). O valor MAIL indica que a notificação é enviada por e-mail. Apenas o DataWorks Professional Edition e edições mais avançadas suportam o método de notificação PHONE.
	string	O método de notificação. Valores válidos: MAIL (e-mail), SMS (mensagem de texto) e PHONE (chamada telefônica). O valor MAIL indica que a notificação é enviada por e-mail. Apenas o DataWorks Professional Edition e edições mais avançadas suportam o método de notificação PHONE.	SMS

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,
    "Reminds": [
      {
        "Founder": "952795****",
        "RemindId": 1234,
        "AlertUnit": "OWNER",
        "RemindType": "FINISHED",
        "DndEnd": "08:00",
        "DndStart": "00:00",
        "RemindUnit": "NODE",
        "Useflag": true,
        "RemindName": "Rule name",
        "AlertTargets": [
          "952795****"
        ],
        "NodeIds": [
          1234
        ],
        "BizProcessIds": [
          9527
        ],
        "ProjectIds": [
          1234
        ],
        "BaselineIds": [
          9527
        ],
        "AlertMethods": [
          "SMS"
        ]
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
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.
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.