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

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

TestConnection

测试您的SFTP连接器是否设置成功。我们强烈建议您调用此操作来测试您在本地 Amazon 存储和贸易伙伴SFTP服务器之间传输文件的能力。

请求语法

{ "ConnectorId": "string" }

请求参数

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

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

ConnectorId

连接器的唯一标识符。

类型:字符串

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

模式:c-([0-9a-f]{17})

必需:是

响应语法

{ "ConnectorId": "string", "Status": "string", "StatusMessage": "string" }

响应元素

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

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

ConnectorId

返回您正在测试的连接器对象的标识符。

类型:字符串

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

模式:c-([0-9a-f]{17})

Status

如果测试成功,则会返回 OK,如果测试失败,则会返回 ERROR

类型:字符串

StatusMessage

如果测试成功,则返回 Connection succeeded。或者,如果测试失败,则返回描述性错误消息。以下列表根据您收到的错误消息提供了疑难解答的详细信息。

  • 确认您的密钥名称与传输角色权限中的密钥名称一致。

  • 在连接器配置URL中验证服务器,并验证登录凭据在连接器之外是否成功运行。

  • 验证密钥是否存在且格式正确。

  • 验证连接器配置中的可信主机密钥是否与 ssh-keyscan 输出相匹配。

类型:字符串

错误

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

InternalServiceError

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

HTTP状态码:500

InvalidRequestException

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

HTTP状态码:400

ResourceNotFoundException

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

HTTP状态码:400

ServiceUnavailableException

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

HTTP状态码:500

示例

示例

以下示例测试与远程服务器的连接。

aws transfer test-connection --connector-id c-abcd1234567890fff

示例响应

如果成功,则API调用将返回以下详细信息。

{ "Status": "OK", "StatusMessage": "Connection succeeded" }

另请参阅

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