CreatePolarClawCronJob - PolarDB: Central de Documentação do Alibaba Cloud

Cria uma tarefa agendada do PolarClaw.

Descrição da operação

Solicitação

Use esta API para criar um cron job. Você pode configurar o payload do job, a frequência de execução, o fuso horário, o canal de destino, os destinatários e um mecanismo de alerta de falha.

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.

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ApplicationId	string	Sim	O ID da aplicação.	pa-**************
Name	string	Sim	O nome exclusivo da tarefa.	daily-report
Schedule	object	Sim	A configuração de agendamento.	{"Kind":"cron","Expr":"0 9 * * *","Tz":"Asia/Shanghai"}
Kind	string	Não	O tipo de agendamento.	cron
Expr	string	Não	A expressão cron que especifica quando a tarefa é executada.	0 9 * * *
Tz	string	Não	O fuso horário do agendamento.	Asia/Shanghai
StaggerMs	integer	Não	A janela de jitter determinístico, em milissegundos.	0
EveryMs	integer	Não	O intervalo de execução da tarefa, em milissegundos.	100000
AnchorMs	integer	Não	O timestamp âncora para alinhar agendamentos baseados em intervalo, em milissegundos.	1777370572518
At	string	Não	O horário específico para uma execução única, especificado como um timestamp ISO 8601.	2026-04-10T09:00:00+08:00
SessionTarget	string	Sim	O destino da sessão. Valores válidos: `main`, `isolated` e `current`.	main
WakeMode	string	Sim	O modo de ativação do agente. Valores válidos: `now` e `next-heartbeat`.	now
Payload	object	Sim	A configuração do payload de execução.	{"Kind":"agentTurn","Message":"Generate the daily report."}
Kind	string	Não	O tipo de payload. Valores válidos: `agentTurn` e `systemEvent`.	systemEvent
Message	string	Não	O prompt para uma conversa com o agente, usado quando `Kind` é `agentTurn`.	Generate the daily report.
Text	string	Não	O texto para o evento de sistema, usado quando `Kind` é `systemEvent`.	Generate the daily report.
Model	string	Não	Especifica um modelo que substitui o modelo padrão do agente.	bailian/qwen3.5-plus
Fallbacks	array	Não	Uma lista de modelos de fallback a serem usados se o modelo primário falhar.
	string	Não	Um modelo de fallback.	bailian/qwen-max
Thinking	string	Não	O nível de raciocínio para a geração de resposta do agente. Valores válidos: `off`, `minimal`, `low`, `medium`, `high` e `xhigh`.	xhigh
TimeoutSeconds	integer	Não	O tempo limite de execução, em segundos.	10
LightContext	boolean	Não	Especifica se deve ser usado um contexto leve para a conversa com o agente.	false
Deliver	boolean	Não	Especifica se a saída do agente deve ser entregue a um canal.	true
Channel	string	Não	O ID do canal de entrega.	feishu
To	string	Não	O destino ou destinatário específico dentro do canal.	ou_***
BestEffortDeliver	boolean	Não	Especifica se deve ser usada a entrega de melhor esforço. Se `true`, falhas de entrega são ignoradas.	false
AgentId	string	Não	O ID do agente que executa a tarefa.	main
SessionKey	string	Não	A chave de roteamento de sessão, que determina a sessão de conversa para a tarefa.	agent:main:feishu:direct:***
Description	string	Não	Uma descrição da tarefa.	Daily report generation
Enabled	boolean	Não	Especifica se o cron job está ativado. Valor padrão: `true`.	true
DeleteAfterRun	boolean	Não	Especifica se o job deve ser excluído automaticamente após sua primeira execução. Útil para tarefas únicas. Valor padrão: `false`.	false
Delivery	object	Não	A configuração para entrega dos resultados de execução da tarefa.	{"Mode":"announce","Channel":"telegram"}
Mode	string	Não	O modo de entrega. Valores válidos: `none`, `announce` e `webhook`.	announce
Channel	string	Não	O canal de entrega.	feishu
AccountId	string	Não	O ID da conta para o canal de entrega.	default
To	string	Não	O destinatário da entrega.	ou_***
BestEffort	boolean	Não	Especifica se deve ser usada a entrega de melhor esforço. Se `true`, falhas de entrega são ignoradas.	false
FailureAlert	object	Não	A configuração de alerta de falha.	{"After":3,"Channel":"telegram"}
After	integer	Não	O número de falhas consecutivas necessárias para acionar um alerta.	3
Channel	string	Não	O canal para envio de alertas de falha.	feishu
AccountId	string	Não	O ID da conta para o canal de alerta.	default
To	string	Não	O destinatário do alerta de falha.	ou_***
CooldownMs	integer	Não	O período de cooldown, em milissegundos, entre alertas para o mesmo job.	5000
Mode	string	Não	O modo de envio de alertas. Valores válidos: `announce` e `webhook`.	announce
RunImmediately	boolean	Não	Especifica se o job deve ser executado uma vez imediatamente após a criação. Valor padrão: `false`.	false
Restart	boolean	Não	Especifica se o gateway deve ser reiniciado após a criação do job. Valor padrão: `true`.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema de resposta.
RequestId	string	O ID da solicitação.	6BD9CDE4-5E7B-4BF3-9BB8-83C73E******
Message	string	A mensagem de resposta.	successful
Code	integer	O código de status da resposta.	200
ApplicationId	string	O ID da aplicação.	pa-**************
Ok	boolean	Indica se a operação foi bem-sucedida.	true
Job	object	Detalhes do cron job criado.
Id	string	O ID do job (UUID).	e2c57423-12f0-45cc-a387-6155168b3201
Name	string	O nome do job.	test
Enabled	boolean	Indica se o cron job está ativado.	true
DeleteAfterRun	boolean	Indica se o cron job é excluído após sua primeira execução.	false
CreatedAtMs	integer	O timestamp de criação em milissegundos.	1777368967284
UpdatedAtMs	integer	O timestamp de atualização em milissegundos.	1777370572517
Schedule	object	A configuração de agendamento.
Kind	string	The schedule type. Valid values: `cron`, `every`, and `at`.	cron
Expr	string	The cron expression.	0 9 * * *
Tz	string	The IANA time zone.	Asia/Shanghai
EveryMs	integer	The interval in milliseconds.	1000
AnchorMs	integer	The anchor timestamp for interval alignment.	1777370572518
At	string	The ISO 8601 timestamp.	2026-04-10T09:00:00+08:00
SessionTarget	string	O destino da sessão. Valores válidos: `main`, `isolated` e `current`.	main
WakeMode	string	O modo de ativação. Valores válidos: `now` e `next-heartbeat`.	now
Payload	object	O payload de execução.
Kind	string	The payload type. Valid values: `agentTurn` and `systemEvent`.	agentTurn
Message	string	The agent prompt.	Generate the daily report.
Text	string	The system event text.	Generate the daily report.
Model	string	The overriding model.	bailian/qwen3.5-plus
TimeoutSeconds	integer	The execution timeout in seconds.	10
LightContext	boolean	Indicates whether to use a light context.	false
Deliver	boolean	Indicates whether to deliver the output to the delivery channel.	false
Channel	string	The delivery channel ID.	feishu
To	string	The recipient.	ou_***
BestEffortDeliver	boolean	Specifies whether to ignore delivery failures.	false
AgentId	string	O ID do agente executor.	main
SessionKey	string	A chave de sessão.	agent:main:feishu:direct:***
Description	string	A descrição do job.	test
Delivery	object	A configuração de entrega.
Mode	string	The delivery mode. Valid values: `none`, `announce`, and `webhook`.	announce
Channel	string	The delivery channel.	feishu
AccountId	string	The channel account ID.	default
To	string	The recipient.	ou_***
BestEffort	boolean	Specifies whether to ignore delivery failures.	false
State	object	O estado atual do job.
NextRunAtMs	integer	The next run timestamp in milliseconds.	1777424400000
LastRunAtMs	integer	The last run timestamp in milliseconds.	1777370544931
LastRunStatus	string	The last run status.	ok
ConsecutiveErrors	integer	The number of consecutive execution failures.	0
Runs	array<object>	O histórico de execuções.
	array<object>
Ts	integer	The run timestamp in milliseconds.	1777370572518
JobId	string	The associated job ID.	f83f5278-1abe-40a6-b10e-ad3ecdc05de2
Action	string	The action performed. Valid values: `finished`, `error`, and `skipped`.	finished
Status	string	The status of the run. Valid values: `ok`, `error`, and `skipped`.	ok
Summary	string	The run summary.	Generate the daily report.
Delivered	boolean	Specifies whether the results were delivered.	false
DeliveryStatus	string	The delivery status.	not-requested
SessionId	string	The associated session ID.	***
RunAtMs	integer	The actual execution timestamp in milliseconds.	1777370544931
DurationMs	integer	The execution duration in milliseconds.	27586
NextRunAtMs	integer	The next run timestamp in milliseconds.	1777424400000
Model	string	The model used for the run.	bailian/qwen3.5-plus
Provider	string	The model provider.	bailian
Usage	object	The token usage details.
InputTokens	integer	The number of input tokens.	30250
OutputTokens	integer	The number of output tokens.	30250
TotalTokens	integer	The total number of tokens.	60500
JobName	string	The job name.	test
RanImmediately	boolean	Indica se o job foi executado imediatamente após a criação.	false

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******",
  "Message": "successful",
  "Code": 200,
  "ApplicationId": "pa-**************",
  "Ok": true,
  "Job": {
    "Id": "e2c57423-12f0-45cc-a387-6155168b3201",
    "Name": "test",
    "Enabled": true,
    "DeleteAfterRun": false,
    "CreatedAtMs": 1777368967284,
    "UpdatedAtMs": 1777370572517,
    "Schedule": {
      "Kind": "cron",
      "Expr": "0 9 * * *",
      "Tz": "Asia/Shanghai",
      "EveryMs": 1000,
      "AnchorMs": 1777370572518,
      "At": "2026-04-10T09:00:00+08:00"
    },
    "SessionTarget": "main",
    "WakeMode": "now",
    "Payload": {
      "Kind": "agentTurn",
      "Message": "Generate the daily report.",
      "Text": "Generate the daily report.",
      "Model": "bailian/qwen3.5-plus",
      "TimeoutSeconds": 10,
      "LightContext": false,
      "Deliver": false,
      "Channel": "feishu",
      "To": "ou_***",
      "BestEffortDeliver": false
    },
    "AgentId": "main",
    "SessionKey": "agent:main:feishu:direct:***",
    "Description": "test",
    "Delivery": {
      "Mode": "announce",
      "Channel": "feishu",
      "AccountId": "default",
      "To": "ou_***",
      "BestEffort": false
    },
    "State": {
      "NextRunAtMs": 1777424400000,
      "LastRunAtMs": 1777370544931,
      "LastRunStatus": "ok",
      "ConsecutiveErrors": 0
    },
    "Runs": [
      {
        "Ts": 1777370572518,
        "JobId": "f83f5278-1abe-40a6-b10e-ad3ecdc05de2",
        "Action": "finished",
        "Status": "ok",
        "Summary": "Generate the daily report.",
        "Delivered": false,
        "DeliveryStatus": "not-requested",
        "SessionId": "***",
        "RunAtMs": 1777370544931,
        "DurationMs": 27586,
        "NextRunAtMs": 1777424400000,
        "Model": "bailian/qwen3.5-plus",
        "Provider": "bailian",
        "Usage": {
          "InputTokens": 30250,
          "OutputTokens": 30250,
          "TotalTokens": 60500
        },
        "JobName": "test"
      }
    ]
  },
  "RanImmediately": false
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.