API khusus tepi untuk digunakan dengan AWS IoT SiteWise perangkat tepi - AWS IoT SiteWise
Mengautentikasi

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

API khusus tepi untuk digunakan dengan AWS IoT SiteWise perangkat tepi

Selain AWS IoT SiteWise API yang tersedia di edge, ada yang khusus tepi. API edge-specifc tersebut dijelaskan di bawah ini.

Mengautentikasi

Mendapat kredensialnya dari gateway SiteWise Edge. Anda harus menambahkan pengguna lokal atau terhubung ke sistem Anda menggunakan LDAP atau kumpulan pengguna Linux. Untuk informasi selengkapnya tentang menambahkan pengguna, lihat kumpulan pengguna LDAP atau Linux.

Sintaksis Permintaan

POST /authenticate HTTP/1.1
Content-type: application/json
{
  "username": "string",
  "password": "string",
  "authMechanism": "string"
}

Parameter permintaan URI

Permintaan tidak menggunakan parameter URI apa pun.

Isi permintaan

Permintaan menerima data berikut dalam format JSON.

nama pengguna

Nama pengguna yang digunakan untuk memvalidasi panggilan permintaan.

Tipe: String

Diperlukan: Ya

password

Kata sandi pengguna yang meminta kredensi.

Tipe: String

Diperlukan: Ya

AuthMechanism

Metode otentikasi untuk memvalidasi pengguna ini di host.

Jenis: String

Nilai valid: ldap, linux, winnt

Diperlukan: Ya

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json
{
  "accessKeyId": "string",
  "secretAccessKey": "string",
  "sessionToken": "string",
  "region": "edge"
}

Elemen jawaban

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Data berikut dikembalikan dalam format JSON.

accessKeyId

ID kunci akses yang mengidentifikasi kredensi keamanan sementara.

Kendala Panjang: Panjang minimum 16. Panjang maksimum 128.

Pola: [\w]*

secretAccessKey

Kunci akses rahasia yang dapat digunakan untuk menandatangani permintaan.

Jenis: String

sessionToken

Token yang harus diteruskan pengguna ke API layanan untuk menggunakan kredenal sementara.

Jenis: String

region

Wilayah yang Anda targetkan untuk panggilan API.

Jenis: KONSTAN - edge

Kesalahan

IllegalArgumentException

Permintaan ditolak karena dokumen badan yang disediakan cacat. Pesan kesalahan menjelaskan kesalahan tertentu.

Kode Status HTTP: 400

AccessDeniedException

Pengguna tidak memiliki kredensi yang valid berdasarkan Penyedia Identitas saat ini. Pesan kesalahan menjelaskan Mekanisme otentikasi.

Kode Status HTTP: 403

TooManyRequestsException

Permintaan telah mencapai batas upaya otentikasi. Pesan kesalahan berisi jumlah waktu untuk menunggu sampai upaya otentikasi baru dilakukan.

Kode Status HTTP: 429