TestConnection - AWS Transfer Family

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

TestConnection

測試您的SFTP連接器是否已成功設定。強烈建議您呼叫此操作,以測試您在本機 AWS 儲存體和交易合作夥伴的SFTP伺服器之間傳輸檔案的能力。

請求語法

{ "ConnectorId": "string" }

請求參數

如需所有動作的一般參數資訊,請參閱《Common Parameters》。

請求接受下列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

ERROR 如果測試失敗, 會傳回 OK 以取得成功測試。

類型:字串

StatusMessage

Connection succeeded 如果測試成功,則傳回 。或者,如果測試失敗, 會傳回描述性錯誤訊息。下列清單提供疑難排解詳細資訊,具體取決於您收到的錯誤訊息。

  • 確認您的秘密名稱與 Transfer Role 許可中的秘密名稱相符。

  • 在連接器組態 URL中驗證伺服器,並確認登入憑證在連接器之外成功運作。

  • 確認秘密存在且格式正確。

  • 確認連接器組態中的受信任主機金鑰符合ssh-keyscan輸出。

類型:字串

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

InternalServiceError

當 AWS Transfer Family 服務發生錯誤時,就會擲回此例外狀況。

HTTP 狀態碼:500

InvalidRequestException

當用戶端提交格式不正確的請求時,就會擲回此例外狀況。

HTTP 狀態碼:400

ResourceNotFoundException

當 AWS Transfer Family 服務找不到資源時,就會擲回此例外狀況。

HTTP 狀態碼:400

ServiceUnavailableException

請求失敗,因為 AWS Transfer Family 服務無法使用。

HTTP 狀態碼:500

範例

範例

下列範例會測試與遠端伺服器的連線。

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

回應範例

如果成功,API呼叫會傳回下列詳細資訊。

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

另請參閱

如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: