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

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

DescribeExecution

您可以使用 DescribeExecution 来检查指定工作流程的执行细节。

注意

此API调用仅返回正在进行的工作流程的详细信息。

如果您为未进行中的执行提供了 ID,或者如果执行与指定的工作流程 ID 不匹配,则会收到 ResourceNotFound 异常。

请求语法

{ "ExecutionId": "string", "WorkflowId": "string" }

请求参数

有关所有操作的通用参数的信息,请参阅通用参数

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

ExecutionId

用于执行工作流程的唯一标识符。

类型:字符串

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

模式:[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

必需:是

WorkflowId

工作流的唯一标识符。

类型:字符串

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

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

必需:是

响应语法

{ "Execution": { "ExecutionId": "string", "ExecutionRole": "string", "InitialFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Etag": "string", "Key": "string", "VersionId": "string" } }, "LoggingConfiguration": { "LoggingRole": "string", "LogGroupName": "string" }, "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Results": { "OnExceptionSteps": [ { "Error": { "Message": "string", "Type": "string" }, "Outputs": "string", "StepType": "string" } ], "Steps": [ { "Error": { "Message": "string", "Type": "string" }, "Outputs": "string", "StepType": "string" } ] }, "ServiceMetadata": { "UserDetails": { "ServerId": "string", "SessionId": "string", "UserName": "string" } }, "Status": "string" }, "WorkflowId": "string" }

响应元素

如果操作成功,服务将发回 HTTP 200 响应。

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

Execution

包含工作流程执行详细信息的结构。

类型:DescribedExecution 对象

WorkflowId

工作流的唯一标识符。

类型:字符串

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

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

错误

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

InternalServiceError

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

HTTP状态码:500

InvalidRequestException

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

HTTP状态码:400

ResourceNotFoundException

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

HTTP状态码:400

ServiceUnavailableException

请求失败,因为 Trans Amazon fer Family 服务不可用。

HTTP状态码:500

另请参阅

有关API在一种特定语言中使用此功能的更多信息 Amazon SDKs,请参阅以下内容: