CloudFlow:Integrate CloudFlow with Function Compute

Concepts clés

Type: StateMachine
Name: MyWorkflow
SpecVersion: v1
StartAt: an example of function invocation
States:
  - Name: an example of function invocation
    Type: Task
    TaskMode: RequestComplete
    Action: FC:InvokeFunction
    Parameters:
      resourceArn: xxx
      invocationType: xxx
      body: xxx
    End: true

Type: StateMachine
Name: MyWorkflow
SpecVersion: v1
StartAt: an example of synchronous function invocation
States:
  - Name: an example of synchronous function invocation
    Type: Task
    Action: FC:InvokeFunction
    TaskMode: RequestComplete
    Parameters:
      resourceArn: acs:fc:::services/myService1.LATEST/functions/myFunction1
      invocationType: Sync
      body:
        testKey: the content of the testKey parameter in the event of the function
    Next: an example of asynchronous function invocation
  - Name: an example of asynchronous function invocation
    Type: Task
    Action: FC:InvokeFunction
    TaskMode: RequestComplete
    Parameters:
      resourceArn: acs:fc:::services/myService2.LATEST/functions/myFunction2
      invocationType: Async
      body:
        key1: value1
        key2: value2
    End: true

RequestComplete

Le flux invoque la fonction et attend la réponse de l'API. Une fois que le système a répondu et renvoyé le résultat, le flux avance vers l'état suivant. Ce mode fonctionne avec les invocations synchrones, asynchrones et les tâches asynchrones.

Pour plus d'informations, consultez RequestComplete.

WaitForSystemCallback

Le flux envoie la requête d'invocation, puis attend que Function Compute envoie une notification de rappel système. Le flux n'avance qu'après réception de ce rappel. Ce mode fonctionne uniquement avec les invocations asynchrones et les tâches asynchrones.

Pour plus d'informations, consultez WaitForSystemCallback.

WaitForCustomCallback

Le flux invoque la fonction, puis se met en pause. Il n'avance que lorsque votre programme appelle l'API de rappel CloudFlow pour signaler le résultat de la tâche. Ce mode fonctionne uniquement avec les invocations asynchrones et les tâches asynchrones.

Pour utiliser ce mode, ajoutez un champ callbackToken au paramètre body et référencez l'expression $Context.Current.TaskToken. Ce jeton est l'identifiant que votre programme doit inclure lors du signalement du résultat de la tâche au flux.

Type: StateMachine
Name: MyWorkflow
SpecVersion: v1
StartAt: invoke-with-callback
States:
  - Name: invoke-with-callback
    Type: Task
    Action: FC:InvokeFunction
    TaskMode: WaitForCustomCallback
    Parameters:
      resourceArn: acs:fc:::services/myService1.LATEST/functions/myFunction1
      invocationType: Async
      body:
        callbackToken.$: $Context.Current.TaskToken
        key1: value1
    End: true

Dans cet exemple, le flux transmet le jeton de tâche à la fonction via callbackToken. La fonction (ou un processus en aval) appelle l'API ReportTaskSucceeded ou ReportTaskFailed avec ce jeton pour notifier CloudFlow du résultat.

Pour plus d'informations, consultez WaitForCustomCallback.

Pour plus de détails sur les types d'invocation de fonction, consultez Invocations synchrones, Invocations asynchrones et Gestion des tâches asynchrones.

Type: StateMachine
Name: MyWorkflow
SpecVersion: v1
StartAt: an example of function invocation
States:
  - Name: an example of function invocation
    Type: Task
    TaskMode: RequestComplete
    Action: FC:InvokeFunction
    Parameters:
      resourceArn: acs:fc:::services/myService1.LATEST/functions/myFunction1
      invocationType: Sync
      body:
        argument1.$: $Input.input.BucketName
        argument2.$: $Input.input.TaskId
    End: true

Mode RequestComplete

Le flux encapsule la valeur de retour de la fonction dans un objet JSON avec un champ Body :

{
    "Body": "function invocation result"
}

Accédez à la valeur de retour avec $Output.Body dans les définitions d'états suivants. Si la valeur de retour est un objet JSON, désérialisez-la à l'aide de la fonction intégrée du workflow, puis accédez à ses membres comme à un objet JSON standard.

L'exemple suivant invoque une fonction, puis utilise un état Choice pour effectuer une branche conditionnelle basée sur une valeur issue de la sortie de la fonction :

Type: StateMachine
Name: MyWorkflow
SpecVersion: v1
Description: ' '
StartAt: Example 1 of function invocation
States:
  - Name: Example 1 of function invocation
    Type: Task
    TaskMode: RequestComplete
    Action: FC:InvokeFunction
    Parameters:
      resourceArn: acs:fc:::services/myService1.LATEST/functions/myFunction1
      invocationType: Sync
      body:
        argument1.$: $Input.Records
        argument2.$: $Input.BucketName
    Next: conditional statement
  - Type: Choice
    Name: conditional statement
    Branches:
      - Condition: $Input.ObjectSize >= $Input.Threshold
        Next: Example 2 of function invocation
    Default: No action is performed.
  - Type: Pass
    Name: No action is performed.
    End: true
  - Name: Example 2 of function invocation
    Type: Task
    TaskMode: RequestComplete
    Action: FC:InvokeFunction
    Parameters:
      resourceArn: acs:fc:::services/myService2.LATEST/functions/myFunction2
      invocationType: Sync
      body:
        argument1.$: $Input.BucketName
        argument2.$: $Input.TaskId
    End: true

Modes WaitForSystemCallback et WaitForCustomCallback

Dans ces modes, le système externe appelle l'API ReportTaskSucceeded ou ReportTaskFailed pour signaler le résultat. Le flux transmet le résultat tel quel, sans l'encapsuler. Par exemple, si la fonction renvoie {"message": "hello"}, le résultat dans le flux est :

{
    "message": "hello"
}

Accédez directement à la valeur de retour avec l'expression $Output.