本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
ListExecutions
列出指定工作流程的执行进度。
注意
如果找不到指定的工作流程 ID,则 ListExecutions
返回 ResourceNotFound
异常。
请求语法
{
"MaxResults": number
,
"NextToken": "string
",
"WorkflowId": "string
"
}
请求参数
有关所有操作的通用参数的信息,请参阅通用参数。
请求接受采用 JSON 格式的以下数据。
- MaxResults
-
指定要返回的最大记录数。
类型:整数
有效范围:最小值为 1。最大值为 1000。
必需:否
- NextToken
-
ListExecutions
在输出中返回NextToken
参数。然后,您可以在后续命令中传递NextToken
参数以继续列出其他工作流程。例如,这对分页很有用。如果您的工作流程有 100 项执行,则可能只想列出前 10 项执行。如果是,请通过指定
max-results
调用 API: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
-
以
ListedExecution
数组形式返回每次执行的详细信息。类型:ListedExecution 对象数组
- NextToken
-
ListExecutions
在输出中返回NextToken
参数。然后,您可以在后续命令中传递NextToken
参数以继续列出其他工作流程。类型:字符串
长度限制:长度下限为 1。长度上限为 6144。
- WorkflowId
-
工作流的唯一标识符。
类型:字符串
长度限制:固定长度为 19。
模式:
w-([a-z0-9]{17})
错误
有关所有操作的常见错误信息,请参阅常见错误。
- InternalServiceError
-
当 Amazon Transfer Family 服务中发生错误时,会引发此异常。
HTTP 状态代码:500
- InvalidNextTokenException
-
传递的
NextToken
参数无效。HTTP 状态代码:400
- InvalidRequestException
-
当客户端提交格式错误的请求时,会引发此异常。
HTTP 状态代码:400
- ResourceNotFoundException
-
当 Transfer Family 服务找不到资源时,就会 Amazon引发此异常。
HTTP 状态代码:400
- ServiceUnavailableException
-
请求失败,因为 Trans Amazon fer Family 服务不可用。
HTTP 状态代码:500
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: