TestConnection - AWS Transfer Family
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanContohLihat Juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

TestConnection

Menguji apakah konektor SFTP Anda berhasil diatur. Kami sangat menyarankan Anda memanggil operasi ini untuk menguji kemampuan Anda mentransfer file antara AWS penyimpanan lokal dan server SFTP mitra dagang.

Sintaksis Permintaan

{
   "ConnectorId": "string"
}

Parameter Permintaan

Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.

Permintaan menerima data berikut dalam format JSON.

ConnectorId

Pengidentifikasi unik untuk konektor.

Jenis: String

Kendala Panjang: Panjang tetap 19.

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

Diperlukan: Ya

Sintaksis Respons

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

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

ConnectorId

Mengembalikan identifier dari objek konektor yang Anda uji.

Jenis: String

Kendala Panjang: Panjang tetap 19.

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

Status

Pengembalian OK untuk tes yang berhasil, atau ERROR jika tes gagal.

Jenis: String

StatusMessage

Kembali Connection succeeded jika tes berhasil. Atau, mengembalikan pesan kesalahan deskriptif jika tes gagal. Daftar berikut memberikan rincian pemecahan masalah, tergantung pada pesan kesalahan yang Anda terima.

  • Verifikasi bahwa nama rahasia Anda sejajar dengan yang ada di izin Peran Transfer.

  • Verifikasi URL server dalam konfigurasi konektor, dan verifikasi bahwa kredenal login berhasil bekerja di luar konektor.

  • Verifikasi bahwa rahasia itu ada dan diformat dengan benar.

  • Verifikasi bahwa kunci host tepercaya dalam konfigurasi konektor cocok dengan ssh-keyscan output.

Jenis: String

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InternalServiceError

Pengecualian ini dilemparkan ketika kesalahan terjadi dalam AWS Transfer Family layanan.

Kode Status HTTP: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

Kode Status HTTP: 400

ResourceNotFoundException

Pengecualian ini dilemparkan ketika sumber daya tidak ditemukan oleh layanan AWS Transfer Family.

Kode Status HTTP: 400

ServiceUnavailableException

Permintaan gagal karena layanan AWS Transfer Family tidak tersedia.

Kode Status HTTP: 500

Contoh

Contoh

Contoh berikut menguji koneksi ke server jarak jauh.

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

Contoh Respons

Jika berhasil, panggilan API mengembalikan detail berikut.

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

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: