Listar schedules - : Central de Documentação do Alibaba Cloud

Lista os Forward schedules de uma Identity com paginação por cursor.

Cabeçalhos da requisição

Cabeçalho	Obrigatório	Descrição
`Authorization`	Sim	`Bearer <PAT>`

Parâmetros de consulta

Parâmetro	Tipo	Obrigatório	Padrão	Descrição
`identity_id`	string	Sim		ID da Forward Identity proprietária do Schedule.
`template_id`	string	Não	-	Filtra pelo ID do Forward Template.
`status`	string	Não	-	Filtra por `active` ou `paused`.
`include_archived`	boolean	Não	`false`	Inclui schedules arquivados.
`limit`	integer	Não	20	Itens por página. Máximo de 100.
`after_id`	string	Não	-	Cursor para registros posteriores ao ID do Schedule especificado.
`before_id`	string	Não	-	Cursor para registros anteriores ao ID do Schedule especificado.

Exemplo de requisição

curl -s -X GET 'https://api.qoder.com.cn/api/v1/forward/schedules?identity_id=idn_019eabc123&limit=20' \
  -H "Authorization: Bearer $QODER_PAT"

Exemplo de resposta

HTTP 200 OK

{
  "data": [
    {
      "id": "sched_019f00112233445566778899aabbccdd",
      "identity_id": "idn_019eabc123",
      "template_id": "tmpl_support",
      "name": "Daily 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 * * *",
        "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:00:00Z"
    }
  ],
  "first_id": "sched_019f00112233445566778899aabbccdd",
  "last_id": "sched_019f00112233445566778899aabbccdd",
  "has_more": false
}

Campos da resposta

Campo	Tipo	Descrição
`data`	array	Objetos Schedule completos na página atual.
`first_id`	string	null	ID do primeiro registro nesta página.
`last_id`	string	null	ID do último registro nesta página.
`has_more`	boolean	Indica se há mais registros disponíveis.

Erros

HTTP	Tipo	Código	Gatilho
400	`invalid_request_error`	`invalid_identity`	O parâmetro `identity_id` está ausente ou é inválido.
400	`invalid_request_error`	`invalid_pagination`	Os parâmetros de paginação são inválidos.
401	`authentication_error`	`authentication_required`	PAT inválido ou expirado.

Observações

Os resultados são retornados em ordem decrescente de criação.
Registros arquivados aparecem apenas quando include_archived=true.

Cabeçalhos da requisição

Parâmetros de consulta

Exemplo de requisição

Exemplo de resposta

Campos da resposta

Erros

Observações

APIs relacionadas