All Products
Search
Document Center

CloudFlow:ListExecutions

Last Updated:Jul 30, 2024

Queries all historical executions of a flow.

Operation description

Usage notes

After you delete a flow, you cannot query its historical executions, even if you create a flow of the same name.

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:ListExecutionsget
  • All Resources
    *
    none
none

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
NextTokenstringNo

The name of the execution to start the query. You can obtain the value from the response data. You do not need to specify this parameter for the first request.

flow_xxx
LimitintegerNo

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

1
StatusstringNo

The status of the execution that you want to filter. Valid values:

  • Starting
  • Running
  • Stopped
  • Succeeded
  • Failed
  • TimedOut
Succeeded
StartedTimeBeginstringNo

The beginning of the time range to query executions. Specify the value in the UTC RFC3339 format.

2020-12-02T02:39:20.402Z
StartedTimeEndstringNo

The end of the time range to query executions. Specify the value in the UTC RFC3339 format.

2020-12-02T02:23:54.817Z
ExecutionNamePrefixstringNo

The name prefix of the execution.

run

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NextTokenstring

The start key for the next query. This parameter is not returned if all results have been returned.

exec2
RequestIdstring

The request ID.

testRequestId
Executionsarray<object>

The information about executions.

object
Statusstring

The status of the execution.

Succeeded
StoppedTimestring

The time when the execution stopped.

2019-01-01T01:01:01.001Z
StartedTimestring

The time when the execution started.

2019-01-01T01:01:01.001Z
FlowDefinitionstring

The definition of the flow.

version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass
Outputstring

The output of the execution, which is in the JSON format

{"key":"value"}
FlowNamestring

The name of the flow.

flow
Namestring

The name of the execution.

exec
Inputstring

The input of the execution, which is in the JSON format.

{"key":"value"}

Examples

Sample success responses

JSONformat

{
  "NextToken": "exec2",
  "RequestId": "testRequestId",
  "Executions": [
    {
      "Status": "Succeeded",
      "StoppedTime": "2019-01-01T01:01:01.001Z",
      "StartedTime": "2019-01-01T01:01:01.001Z",
      "FlowDefinition": "version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n  - type: pass\\n    name: mypass",
      "Output": "{\"key\":\"value\"}",
      "FlowName": "flow",
      "Name": "exec",
      "Input": "{\"key\":\"value\"}"
    }
  ]
}

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.
404FlowNotExistsFlow %s does not exist.Flow %s does not exist.
412PreconditionFailedThe resource to be modified has been changed.The resource to be modified has been changed. Please try again later.
415UnsupportedMediaTypeThe content type must be "application/json".The content type must be "application/json".
429ResourceThrottledThe request is throttled. Please try again later.The request is throttled. Please try again later.
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