ListExecutions - Amazon Transfer Family
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ListExecutions

列出指定工作流程的所有执行。

请求语法

{ "MaxResults": number, "NextToken": "string", "WorkflowId": "string" }

请求参数

有关由所有操作共享的参数的信息,请参阅Common Parameters (常用参数)。

请求接受采用 JSON 格式的以下数据。

MaxResults

指定返回的最大执行数。

类型:整数

有效范围:最小值为 1。最大值为 1 000。

必需:否

NextToken

ListExecutions返回输出中的NextToken参数。然后,您可以在后续命令中传递该NextToken参数,以继续列出其他执行情况。

例如,这对于分页很有用。如果您的工作流程有 100 次执行,则可能只想列出前 10 次执行。如果是,请通过指定以下内容来调用 APImax-results

aws transfer list-executions --max-results 10

这将返回前 10 次执行的详细信息,以及指向第 11 次执行的指针 (NextToken)。现在,你可以再次调用 API,提供你收到的NextToken值:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

此调用返回接下来的 10 次处决,即第 11 次到第 20 次执行。然后,您可以重复调用,直到返回所有 100 次执行的详细信息为止。

类型:字符串

长度限制:最小长度为 1。长度上限为 6144。

必需:否

WorkflowId

工作流的唯一标识符。

类型:字符串

长度限制:固定长度为 19。

模式:^w-([a-z0-9]{17})$

必需:是

响应语法

{ "Executions": [ { "ExecutionId": "string", "InitialFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Etag": "string", "Key": "string", "VersionId": "string" } }, "ServiceMetadata": { "UserDetails": { "ServerId": "string", "SessionId": "string", "UserName": "string" } }, "Status": "string" } ], "NextToken": "string", "WorkflowId": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

Executions

返回每次执行的详细信息。

  • NextToken: 从对多个 API 的调用中返回,您可以使用将其传递给后续命令来继续列出其他执行结果。

  • StartTime: 时间戳,表示执行何时开始。

  • 执行:执行的详细信息,包括执行 ID、初始文件位置和服务元数据。

  • 状态:以下值之一:IN_PROGRESSCOMPLETEDEXCEPTIONHANDLING_EXEPTION

类型:ListedExecution 对象数组

NextToken

ListExecutions返回输出中的NextToken参数。然后,您可以在后续命令中传递该NextToken参数,以继续列出其他执行情况。

类型:字符串

长度限制:最小长度为 1。长度上限为 6144。

WorkflowId

工作流的唯一标识符。

类型:字符串

长度限制:固定长度为 19。

模式:^w-([a-z0-9]{17})$

错误

有关所有操作常见错误的信息,请参阅常见错误

InternalServiceError

当 Transfer Family 服务中发生错误时,会Amazon引发此异常。

HTTP 状态代码:500

InvalidNextTokenException

传递的NextToken参数无效。

HTTP 状态代码:400

InvalidRequestException

当客户端提交格式错误的请求时,会引发此异常。

HTTP 状态代码:400

ResourceNotFoundException

当 Transfer Family 服务找不到资源时,会Amazon引发此异常。

HTTP 状态代码:400

ServiceUnavailableException

由于 Transfer FamAmazon ily 服务不可用,请求失败。

HTTP 状态代码:500

另请参阅

有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: