All Products
Search

This Product

    CloudFlow:GetExecutionHistory

    Document Center

    CloudFlow:GetExecutionHistory

    Last Updated:Apr 11, 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

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    FlowNamestringYes

    The name of the flow. The name must be unique within the region and cannot be modified after the flow is created. The name must meet the following conventions:

    • The name can contain letters, digits, underscores (_), and hyphens (-).
    • The name must start with a letter or an underscore (_).
    • The name is case-sensitive.
    • The name must be 1 to 128 characters in length.
    		flow
    ExecutionNamestringYes

    The name of the execution, which is unique within a flow. The name must meet the following conventions:

    • The name can contain letters, digits, underscores (_), and hyphens (-).
    • The name must start with a letter or an underscore (_).
    • The name is case-sensitive.
    • The name must be 1 to 128 characters in length.
    		exec
    NextTokenstringNo

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

    		flow_xxx
    LimitintegerNo

    The maximum number of steps to be queried. Valid values: 1 to 1000.

    		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
    Eventsobject []

    The events.

    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 changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 415
      delete Error Codes: 500
    Input ParametersThe request parameters of the API has changed.
      delete Input Parameters: RequestId