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

Consulta os detalhes de uma regra de alerta de monitoramento personalizado.

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
RemindId	integer	Sim	O ID da regra de monitoramento personalizado.	1234

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O tipo de dados retornado.
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 se ocorrer um erro.	0000-ABCD-EFGH-IJK****
ErrorMessage	string	A mensagem de erro.	The specified parameters are invalid.
ErrorCode	string	O código de erro.	1031203110005
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Data	object	Os detalhes da regra de monitoramento personalizado.
MaxAlertTimes	integer	O número máximo de alertas.	3
RemindUnit	string	O tipo do objeto monitorado. Valores válidos: NODE (nó), BASELINE (linha de base), PROJECT (workspace) e BIZPROCESS (fluxo de negócios).	NODE
AlertInterval	integer	O intervalo mínimo de alerta, em segundos.	1800
Useflag	boolean	Indica se a regra de monitoramento personalizado está ativada. Valores válidos: true: ativada. false: desativada.	true
Founder	string	O UID da Alibaba Cloud do usuário que criou a regra de monitoramento personalizado.	9527951795****
RemindId	integer	O ID da regra de monitoramento personalizado.	1234
DndEnd	string	A hora de término do período de não perturbe, no formato hh:mm. O valor de hh varia de 0 a 23 e o valor de mm varia de 0 a 59.	08:00
RemindType	string	A condição de acionamento. Valores válidos: FINISHED (concluído), UNFINISHED (não concluído), ERROR (ocorreu um erro), CYCLE_UNFINISHED (época não concluída) e TIMEOUT (tempo limite).	FINISHED
AlertUnit	string	O tipo de destinatário do alerta. Para vários tipos de destinatários de alerta, consulte o parâmetro de resposta Receivers. Valores válidos: OWNER: proprietário da tarefa. OTHER: usuário especificado. SHIFT_SCHEDULE: escala de serviço.	OWNER
DndStart	string	A hora de início do período de não perturbe, no formato hh:mm. O valor de hh varia de 0 a 23 e o valor de mm varia de 0 a 59.	00:00
RemindName	string	O nome da regra.	Rule name
Detail	string	Se a condição de acionamento RemindType for FINISHED, um valor vazio será retornado. Se a condição de acionamento RemindType for UNFINISHED, o valor será retornado no formato {"hour":23,"minu":59}. O valor de hour varia de 0 a 47 e o valor de minu varia de 0 a 59. Se a condição de acionamento RemindType for ERROR, um valor vazio será retornado. Se a condição de acionamento RemindType for CYCLE_UNFINISHED, o valor será retornado no formato {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. A chave na string JSON é o número do ciclo, que varia de 1 a 288. O valor é a hora em que o ciclo deve ser concluído para o ciclo, no formato hh:mm. O valor de hh varia de 0 a 47 e o valor de mm varia de 0 a 59. Se a condição de acionamento RemindType for TIMEOUT, o valor será retornado em segundos, como 1800. Isso indica que um alerta é acionado se o nó for executado por mais de 30 minutos.	{"hour":23,"minu":59}
Robots	array<object>	As URLs de webhook dos chatbots do DingTalk.
	object	O tipo de dados retornado.
WebUrl	string	A URL de webhook do chatbot do DingTalk.	https://oapi.dingtalk.com/robot/send?access_token=******************************
AtAll	boolean	Especifica se deve mencionar todos os membros. Valores válidos: true: sim. false: não.	true
Nodes	array<object>	A lista de nós para monitoramento pela regra quando o tipo de objeto RemindUnit é NODE.
	object	O tipo de dados retornado.
Owner	string	O UID da Alibaba Cloud do proprietário do nó.	9527951795****
NodeName	string	O nome do nó.	Node name
NodeId	integer	O ID do nó.	1234
ProjectId	integer	O ID do workspace ao qual o nó pertence.	1234
Baselines	array<object>	A lista de linhas de base para monitoramento pela regra quando o tipo de objeto RemindUnit é BASELINE.
	object	O tipo de dados retornado.
BaselineName	string	O nome da linha de base.	Baseline name
BaselineId	integer	O ID da linha de base.	1234
Projects	array<object>	A lista de workspaces para monitoramento pela regra quando o tipo de objeto RemindUnit é PROJECT.
	object	O tipo de dados retornado.
ProjectId	integer	O ID do workspace.	1234
BizProcesses	array<object>	A lista de fluxos de negócios para monitoramento pela regra quando o tipo de objeto RemindUnit é BIZPROCESS.
	object	O tipo de dados retornado.
BizProcessName	string	O nome do fluxo de negócios.	Business process name
BizId	integer	O ID do fluxo de negócios.	9527
AlertTargets	array	Os destinatários do alerta. Para vários tipos de destinatários de alerta, consulte o parâmetro de resposta Receivers.
	string	Se AlertUnit for OWNER, um valor vazio será retornado. Se AlertUnit for OTHER, o UID da Alibaba Cloud do usuário especificado será retornado. Se AlertUnit for SHIFT_SCHEDULE, o ID da escala de serviço será retornado.	9527952795279527
AlertMethods	array	Os métodos de alerta.
	string	O método de alerta. Valores válidos: MAIL: e-mail. SMS: mensagem de texto. Regiões que suportam alertas por SMS: Singapura, Malásia (Kuala Lumpur) e Alemanha (Frankfurt).	SMS,MAIL
Webhooks	array	URL do WebHook.
	string	A URL de webhook do chatbot do WeCom ou Lark. AlertMethods deve incluir o método de alerta de webhook. Webhooks personalizados são suportados apenas no DataWorks Enterprise Edition.	https://open.feishu.cn/open-apis/bot/v2/hook/*******
Receivers	array<object>	As informações do destinatário do alerta.
	object	O tipo de destinatário do alerta.
AlertUnit	string	O tipo de destinatário do alerta. Para vários tipos de destinatários de alerta, consulte o parâmetro de resposta Receivers. Valores válidos: OWNER: proprietário da tarefa. OTHER: usuário especificado. SHIFT_SCHEDULE: escala de serviço.	OWNER
AlertTargets	array	O destinatário do alerta.
	string	Se AlertUnit for OWNER, um valor vazio será retornado. Se AlertUnit for OTHER, o UID da Alibaba Cloud do usuário especificado será retornado. Se AlertUnit for SHIFT_SCHEDULE, o ID da escala de serviço será retornado.	9527952795279527
AllowNodes	array	A lista de permissões de alerta.
	integer	O ID da tarefa na lista de permissões. As tarefas na lista de permissões são ignoradas durante o monitoramento.	123

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFGH-IJK****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": {
    "MaxAlertTimes": 3,
    "RemindUnit": "NODE",
    "AlertInterval": 1800,
    "Useflag": true,
    "Founder": "9527951795****",
    "RemindId": 1234,
    "DndEnd": "08:00",
    "RemindType": "FINISHED",
    "AlertUnit": "OWNER",
    "DndStart": "00:00",
    "RemindName": "Rule name",
    "Detail": "{\"hour\":23,\"minu\":59}",
    "Robots": [
      {
        "WebUrl": "https://oapi.dingtalk.com/robot/send?access_token=******************************",
        "AtAll": true
      }
    ],
    "Nodes": [
      {
        "Owner": "9527951795****",
        "NodeName": "Node name",
        "NodeId": 1234,
        "ProjectId": 1234
      }
    ],
    "Baselines": [
      {
        "BaselineName": "Baseline name",
        "BaselineId": 1234
      }
    ],
    "Projects": [
      {
        "ProjectId": 1234
      }
    ],
    "BizProcesses": [
      {
        "BizProcessName": "Business process name",
        "BizId": 9527
      }
    ],
    "AlertTargets": [
      "9527952795279527"
    ],
    "AlertMethods": [
      "SMS,MAIL"
    ],
    "Webhooks": [
      "https://open.feishu.cn/open-apis/bot/v2/hook/*******"
    ],
    "Receivers": [
      {
        "AlertUnit": "OWNER",
        "AlertTargets": [
          "9527952795279527"
        ]
      }
    ],
    "AllowNodes": [
      123
    ]
  }
}

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.	Você não tem as permissões necessárias. Conceda as permissões primeiro.
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.Resource	You have reached the limit for the resource. Please contact us by submitting a ticket.
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.