本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
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
-
返回
OK
測試成功,或者ERROR
如果測試失敗。類型:字串
- StatusMessage
-
Connection succeeded
如果測試成功返回。或者,如果測試失敗,則傳回描述性錯誤訊息。下列清單提供疑難排解詳細資料,視您收到的錯誤訊息而定。-
確認您的密碼名稱與「轉移角色」權限中的名稱一致。
-
驗證連接器組態中的伺服器 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" }
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: