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 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 retornadas.	100
Reminds	array<object>	A lista de regras de alerta personalizadas.
	object
Founder	string	The ID of the Alibaba Cloud account used by the rule creator.	952795****
RemindId	integer	The custom alert rule ID.	1234
AlertUnit	string	The alert recipient. Valid values: OWNER and OTHER. The value OWNER indicates the node owner. The value OTHER indicates a specified user.	OWNER
RemindType	string	The condition that triggers an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT.	FINISHED
DndEnd	string	The end time of the quiet hours. The time is in the hh:mm format. Valid values of hh: [0,23]. Valid values of mm: [0,59].	08:00
DndStart	string	The start time of the quiet hours. The time is in the hh:mm format. Valid values of hh: [0,23]. Valid values of mm: [0,59].	00:00
RemindUnit	string	The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates a node. The value BASELINE indicates a baseline. The value PROJECT indicates a workspace. The value BIZPROCESS indicates a workflow.	NODE
Useflag	boolean	Indicates whether the custom alert rule is enabled. Valid values: true and false.	true
RemindName	string	The name of the custom alert rule.	Rule name
AlertTargets	array	The IDs of the Alibaba Cloud accounts used by alert recipients.
	string	The ID of the Alibaba Cloud account used by the alert recipient.	952795****
NodeIds	array	The IDs of the nodes to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.
	integer	The ID of the node to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.	1234
BizProcessIds	array	The IDs of the workflows to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.
	integer	The ID of the workflow to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.	9527
ProjectIds	array	The IDs of the workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.
	integer	The ID of the workspace to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.	1234
BaselineIds	array	The IDs of the baselines to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.
	integer	The ID of the baseline to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.	9527
AlertMethods	array	The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.
	string	The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.	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	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.	No permission, please authorize
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.