All Products
Search

This Product

    CloudFlow:GetExecutionHistory

    Document Center

    CloudFlow:GetExecutionHistory

    Last Updated:Jul 30, 2024

    Queries the details about each step in an execution process.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    fnf:GetExecutionHistorycreate
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    FlowNamestringYes

    The name of the workflow.

    		flow
    ExecutionNamestringYes

    The name of the execution.

    		exec
    NextTokenstringNo

    The name of the event to start the query. You can obtain the value from the response data.

    		flow_xxx
    LimitintegerNo

    The number of workflows that you want to query. Valid values: 1-999. Default value: 60.

    		1

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    NextTokenstring

    You do not need to specify this parameter for the first request. The returned value of ScheduleEventId is used as the token for the next query. No value is returned for the last query.

    		3
    RequestIdstring

    The request ID.

    		testRequestId
    Eventsarray<object>

    The events.

    object
    Typestring

    The type of the execution step. Valid values:

    • StepEntered
    • StepStarted
    • StepSucceeded
    • StepFailed
    • StepExited
    • BranchEntered
    • BranchExited
    • IterationEntered
    • IterationExited
    • TaskScheduled
    • TaskStarted
    • TaskSubmitted
    • TaskSubmitFailed
    • TaskSucceeded
    • TaskFailed
    • TaskTimedOut
    • ExecutionStarted
    • ExecutionStopped
    • ExecutionSucceeded
    • ExecutionFailed
    • ExecutionTimedOut
    		TaskSucceeded
    EventIdlong

    The ID of the execution step.

    		2
    Timestring

    The time when the event was updated.

    		2019-01-01T01:01:01.001Z
    ScheduleEventIdlong

    The ID of the scheduling step.

    		1
    EventDetailstring

    The details about the execution step.

    		{}
    StepNamestring

    The name of the execution step.

    		passStep

    Examples

    Sample success responses

    JSONformat

    {
  "NextToken": "3",
  "RequestId": "testRequestId",
  "Events": [
    {
      "Type": "TaskSucceeded",
      "EventId": 2,
      "Time": "2019-01-01T01:01:01.001Z",
      "ScheduleEventId": 1,
      "EventDetail": "{}",
      "StepName": "passStep"
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ActionNotSupportedThe requested API operation '%s' is incorrect. Please check.-
    400APIVersionNotSupportedThe requested API version '%s' is not supported yet. Please check.-
    400EntityTooLargeThe payload size exceeds maximum allowed size (%s bytes).The payload size exceeds maximum allowed size (%s bytes).
    400InvalidArgumentParameter error.Parameter error.
    400MissingRequiredHeaderThe HTTP header '%s' must be specified.The HTTP header '%s' must be specified.
    400MissingRequiredParamsThe HTTP query '%s' must be specified.The HTTP query '%s' must be specified.
    403AccessDeniedThe resources doesn't belong to you.-
    403InvalidAccessKeyIDThe AccessKey ID %s is invalid.The AccessKey ID %s is invalid.
    403RequestTimeTooSkewedThe difference between the request time %s and the current time %s is too large.The difference between the request time %s and the current time %s is too large.
    403SignatureNotMatchThe request signature we calculated does not match the signature you provided. Check your access key and signing method.The calculated signature of the request does not match the signature you provided. Check your AccessKey Secret and signing algorithm.
    404ExecutionNotExistsExecution %s for flow %s does not exist.Execution %s for flow %s does not exist.
    404FlowNotExistsFlow %s does not exist.Flow %s does not exist.
    415UnsupportedMediaTypeThe content type must be "application/json".The content type must be "application/json".
    500InternalServerErrorAn internal error has occurred. Please retry.An internal error has occurred. Please retry.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-03-21The Error code has changed. The request parameters of the API has changedView Change Details