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

Consulta uma lista de calendários de agendamento.

Descrição da operação

O DataWorks Enterprise Edition é obrigatório.

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
ProjectId	integer	Não	O ID do workspace. Consulta os calendários aplicáveis a este workspace, incluindo aqueles aplicáveis a todos os workspaces. Se este parâmetro não for especificado, os calendários do locatário atual serão consultados.	1000
Name	string	Não	O nome do calendário de agendamento. Há suporte para correspondência parcial.	calendar
Owner	string	Não	O ID da conta do proprietário. Há suporte para correspondência exata.	123456789
SortBy	string	Não	A regra de ordenação. O formato é "Campo Direção", separado por um espaço. Campo: ModifyTime, Name ou Id. Direção: Asc para ordem crescente ou Desc para ordem decrescente. Se este parâmetro não for especificado, Asc será usado. Valor padrão: ModifyTime Desc.	ModifyTime Desc
PageNumber	integer	Não	O número da página. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de itens por página. Valor padrão: 10. Valores válidos: 1 a 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
PagingInfo	object	As informações de paginação.
Calendars	array<object>	A lista de calendários de agendamento.
	array<object>	O calendário de agendamento.
AllProjects	boolean	Indica se o calendário é aplicável a todos os workspaces.	true
Description	string	A descrição do calendário de agendamento.	Weekday scheduling calendar
EndDate	string	A data de término do período de validade do calendário. Formato: `yyyy-mm-dd`. Este parâmetro é retornado apenas para calendários fortemente restritos.	2026-10-09
ExpirationReminder	string	O lembrete de expiração. Este parâmetro é retornado apenas para calendários fortemente restritos. Valores válidos: OneMonthBefore: Um mês de antecedência. OneWeekBefore: Uma semana de antecedência. ThreeDaysBefore: Três dias de antecedência. Valores válidos: OneMonthBefore : Um mês de antecedência. ThreeDaysBefore : Três dias de antecedência. OneWeekBefore : Uma semana de antecedência.	OneMonthBefore
FallbackPolicy	string	A política de agendamento padrão para datas que não estão configuradas. Este parâmetro é retornado apenas para calendários fracamente restritos. Valores válidos: Normal: Agendamento normal. Pause: Pausar agendamento. Skip: Dry run. Valores válidos: Pause : Pausar agendamento. Skip : Dry run. Normal : Agendamento normal.	Normal
Id	integer	O ID do calendário de agendamento.	12345
ModifyTime	integer	A hora em que o calendário foi modificado. O valor é um carimbo de data/hora UNIX em milissegundos.	1640000000000
Name	string	O nome do calendário de agendamento.	work_calendar
OverduePolicy	string	A política de agendamento após a expiração do calendário. Este parâmetro é retornado apenas para calendários fortemente restritos. Valores válidos: Normal: Agendamento normal. Pause: Pausar agendamento. Skip: Dry run. Valores válidos: Pause : Pausar agendamento. Skip : Dry run. Normal : Agendamento normal.	Skip
Owner	string	O ID da conta do proprietário.	123456789
ProjectIds	array	A lista de IDs de workspaces aplicáveis. Um array vazio é retornado se AllProjects estiver definido como true.
	integer	O ID do workspace.	1000
SchedulePolicy	object	A política de agendamento de datas.
NormalDates	array	A lista de datas de agendamento normal.
	string	A data de agendamento normal. Formato: `yyyy-mm-dd`.	2026-10-08
SkipDates	array	A lista de datas de não agendamento. As tarefas realizam dry runs nessas datas.
	string	A data de não agendamento. Formato: `yyyy-mm-dd`.	2026-10-08
StartDate	string	A data de início do período de validade do calendário. Formato: `yyyy-mm-dd`. Este parâmetro é retornado apenas para calendários fortemente restritos.	2026-10-08
Type	string	O tipo de calendário. Valores válidos: StrongConstraint: Calendário fortemente restrito. WeakConstraint: Calendário fracamente restrito. Valores válidos: WeakConstraint : Calendário fracamente restrito. StrongConstraint : Calendário fortemente restrito.	StrongConstraint
Version	integer	O número da versão.	1
PageNumber	integer	O número da página.	1
PageSize	integer	O número de itens por página.	10
TotalCount	integer	O número total de itens.	10
RequestId	string	O ID da solicitação.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "PagingInfo": {
    "Calendars": [
      {
        "AllProjects": true,
        "Description": "Weekday scheduling calendar",
        "EndDate": "2026-10-09",
        "ExpirationReminder": "OneMonthBefore",
        "FallbackPolicy": "Normal",
        "Id": 12345,
        "ModifyTime": 1640000000000,
        "Name": "work_calendar",
        "OverduePolicy": "Skip",
        "Owner": "123456789",
        "ProjectIds": [
          1000
        ],
        "SchedulePolicy": {
          "NormalDates": [
            "2026-10-08"
          ],
          "SkipDates": [
            "2026-10-08"
          ]
        },
        "StartDate": "2026-10-08",
        "Type": "StrongConstraint",
        "Version": 1
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 10
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

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.