Atualizar um agendamento - : Central de Documentação do Alibaba Cloud

Atualiza a configuração de um Forward Schedule existente.

Cabeçalhos da requisição

Cabeçalho	Obrigatório	Descrição
`Authorization`	Sim	`Bearer <PAT>`
`Content-Type`	Sim	`application/json`
`Idempotency-Key`	Não	Chave de idempotência opcional para requisições com efeitos colaterais.

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição
`schedule_id`	string	Sim	ID do Forward Schedule a atualizar.

Corpo da requisição

Parâmetro	Tipo	Obrigatório	Descrição
`name`	string	Não	Novo nome do agendamento.
`description`	string	Não	Nova descrição do agendamento.
`template_id`	string	Não	ID do novo Forward Template a associar.
`initial_events`	array	Não	Substitui a lista inicial de eventos.
`execution`	object	Não	Atualize a política de execução via merge.
`trigger_policy`	object\	null	Não	Atualize a política de acionamento. O valor `null` altera o modo para manual.
`environment_id`	string	Não	ID do novo ambiente de execução.
`metadata`	object	Não	Atualize os metadados via merge. Valores `null` removem as chaves correspondentes.

Exemplo de requisição

curl -s -X POST 'https://api.qoder.com.cn/api/v1/forward/schedules/sched_019f00112233445566778899aabbccdd' \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekday tech brief",
    "trigger_policy": {
      "type": "cron",
      "expression": "0 9 * * 1-5",
      "timezone": "Asia/Shanghai"
    }
  }'

Exemplo de resposta

HTTP 200 OK

{
  "id": "sched_019f00112233445566778899aabbccdd",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_support",
  "name": "Weekday tech brief",
  "description": "Generate a daily technology news summary",
  "status": "active",
  "paused_reason": null,
  "initial_events": [
    {
      "type": "user.message",
      "content": "Summarize current technology news in five bullet points."
    }
  ],
  "execution": {
    "session_mode": "new_session",
    "max_concurrent_runs": 1,
    "max_attempts": 1,
    "timeout_ms": 300000
  },
  "trigger_policy": {
    "type": "cron",
    "expression": "0 9 * * 1-5",
    "timezone": "Asia/Shanghai",
    "upcoming_runs_at": ["2026-06-23T01:00:00Z"]
  },
  "environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c",
  "sinks": [],
  "metadata": {},
  "archived_at": null,
  "created_at": "2026-06-22T10:00:00Z",
  "updated_at": "2026-06-22T10:30:00Z"
}

Campos da resposta

Retorna o objeto Schedule atualizado.

Erros

HTTP	Tipo	Código	Gatilho
400	`invalid_request_error`	`invalid_trigger_policy`	Política de acionamento inválida.
400	`invalid_request_error`	`unsupported_sinks_input`	Corpo da requisição contém `sinks`.
404	`not_found_error`	`schedule_not_found`	Agendamento não existe.
409	`invalid_request_error`	`schedule_archived`	Agendamento arquivado.

Observações

Requisições HTTP de atualização não permitem modificar sinks.
O modo reuse_session indica que o Forward gerencia uma Session de execução fixa para este Schedule; chamadores não podem fornecer um session_id arbitrário existente.

Cabeçalhos da requisição

Parâmetros de caminho

Corpo da requisição

Exemplo de requisição

Exemplo de resposta

Campos da resposta

Erros

Observações

APIs relacionadas