UpdateTaskFlowSchedule - : Central de Documentação do Alibaba Cloud

Use esta operação para atualizar as configurações de agendamento de um fluxo de tarefas em estado de edição. Configure agendamento temporizado, agendamento recorrente e agendamento por evento. O agendamento temporizado permite definir execuções únicas ou periódicas. O agendamento por evento possibilita configurar assinaturas para fluxos de tarefas e nós de fluxo de tarefas.

Após a atualização da configuração, o sistema republica e reimplanta o fluxo de tarefas. As novas instâncias do fluxo de tarefas seguem as novas definições de agendamento.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	UpdateTaskFlowSchedule	Operação a ser executada. Defina o valor como UpdateTaskFlowSchedule.
Tid	Long	Não	3***	ID do locatário. Nota O ID do locatário aparece ao passar o ponteiro sobre a foto do perfil no canto superior direito do console Data Management (DMS). Para mais informações, consulte a seção "Visualizar informações sobre o locatário atual" do tópico Gerenciar locatários do DMS.
DagId	Long	Sim	7***	ID do fluxo de tarefas.
ScheduleSwitch	Boolean	Sim	Disable	Especifica se o agendamento deve ser ativado. Enable Disable
CronBeginDate	String	Não	CronBeginDate_test	O fluxo de tarefas não será agendado antes deste momento.
CronEndDate	String	Não	CronEndDate_test	Hora de término do agendamento temporizado. O fluxo de tarefas não será agendado após este momento.
ScheduleParam	String	Sim	ScheduleParam_test	Configuração de agendamento por evento. Este parâmetro é uma string JSON.
CronStr	String	Não	CronStr_test	Agendamento temporizado: Cron.
TriggerType	String	Sim	Event	Modo de acionamento do fluxo de tarefas. Valores válidos: Cron: agendamento temporizado Event: acionado por evento
CronType	String	Não	HOUR	Tipo do ciclo de agendamento. Valores válidos: MINUTE: agendar por minuto HOUR: agendar por hora DAY: agendar por dia WEEK: agendar por semana MONTH: agendar por mês
TimeZoneId	String	Não	Asia/Shanghai	Fuso horário. Valor padrão: UTC+8 (Asia/Shanghai).

Parâmetros de agendamento

Agendamento temporizado: configure este parâmetro para execução única ou periódica.

Os seguintes parâmetros são obrigatórios:

ScheduleSwitch: True
TriggerType: Cron
CronBeginDate
CronEndDate
CronStr
CronType
ScheduleParam: o agendamento ocorre uma única vez ou periodicamente por dia, semana ou mês.

Exemplo:

Agendamento diário:

json
{
    "triggerType":"0",
    "dateTime":"00:00"
}

Agendamento semanal: "1" para domingo, "2" para segunda-feira, …"7" para sábado.

json
{
    "triggerType":"0",
    "dateWeek":[
        "1",
        "5"
    ],
    "weekTime":"00:00"
}

Agendamento mensal:

json
{
    "triggerType":"0",
    "dateMonth":"1",
    "MonthTime":"00:00"
}

Agendamento único:

json
{
    "triggerType":"1",
    "specificTime":"2022-09-02 00:00"
}

Parâmetros

CronStr: o agendamento do fluxo de tarefas baseia-se no valor de CronStr.
CronBeginDate e CronEndDate: no agendamento periódico, CronBeginDate, CronEndDate e CronStr definem o intervalo de execução. Se o momento especificado por CronStr estiver dentro do intervalo entre CronBeginDate e CronEndDate, a tarefa será acionada.
CronType: usado para validação. Configure este parâmetro de acordo com o ciclo definido em CronStr.
ScheduleParam: configure este parâmetro conforme o tipo de agendamento especificado em CronStr.

Agendamento por evento (acionado automaticamente entre fluxos de tarefas)

Os seguintes parâmetros são obrigatórios:

ScheduleSwitch: True
TriggerType: Event
ScheduleParam

Exemplo:

json
{
    "triggerType":"2" // Set the value to 2 for event scheduling.
    "deps":[ // Configure the subscription to task flows/nodes.
        {
            "eventType":1, // Subscription type: "0" for task flow and "1" for task node.
            "lisDagId":12345, // The task flow where the subscribed node resides.
            "lisNodeId":2134 // The ID of the subscribed node.
        },
        {
            "eventType":0,
            "lisDagId":12343 // The ID of the subscribed task flow.
        },
        {
            "eventType":0,
            "lisDagId":23456
        }
    ],
    "maxWait":21600 // The longest amount of time to wait for the preceding subscriptions to complete.
}

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	7BF38A13-C181-5B5E-97F1-8643F8A10093	ID da solicitação. Use este ID para localizar logs e solucionar problemas.
ErrorCode	String	InvalidParameterValid	Código de erro retornado caso a solicitação falhe.
ErrorMessage	String	InvalidParameterValid	Mensagem de erro retornada caso a solicitação falhe.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true: a solicitação foi bem-sucedida. false: a solicitação falhou.

Exemplos

Solicitações de exemplo

http(s)://dms-enterprise.aliyuncs.com/?Action=UpdateTaskFlowSchedule
&ScheduleSwitch=false
&CronBeginDate=CronBeginDate_test
&CronEndDate=CronEndDate_test
&ScheduleParam=ScheduleParam_test
&CronStr=CronStr_test
&TriggerType=Event
&CronType=HOUR
&TimeZoneId=Asia/Shanghai
&Common request parameters

Respostas de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateTaskFlowScheduleResponse>
    <RequestId>7BF38A13-C181-5B5E-97F1-8643F8A10093</RequestId>
    <ErrorCode>InvalidParameterValid</ErrorCode>
    <ErrorMessage>InvalidParameterValid</ErrorMessage>
    <Success>true</Success>
</UpdateTaskFlowScheduleResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "7BF38A13-C181-5B5E-97F1-8643F8A10093",
  "ErrorCode" : "InvalidParameterValid",
  "ErrorMessage" : "InvalidParameterValid",
  "Success" : true
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.