

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

# Hanya tepi APIs untuk digunakan dengan AWS IoT SiteWise perangkat tepi
<a name="edge-local-apis"></a>

Selain AWS IoT SiteWise APIs yang tersedia di tepi, ada yang khusus tepi. Spesifik tepi tersebut dijelaskan di bawah APIs ini.

## Mengautentikasi
<a name="edge-local-apis-authenticate"></a>

Mendapat kredensyal 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/manage-gateways-ggv2.html#opshub-app) atau Linux](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/manage-gateways-ggv2.html#opshub-app).

### Sintaksis Permintaan
<a name="authenticate-request-syntax"></a>

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

### Parameter permintaan URI
<a name="authenticate-request-parameters"></a>

Permintaan tidak menggunakan parameter URI apa pun.

### Isi permintaan
<a name="authenticate-request-body"></a>

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 kredensil.  
Tipe: String  
Diperlukan: Ya

**AuthMechanism**  
Metode otentikasi untuk memvalidasi pengguna ini di host.  
Tipe: String  
Nilai valid: `ldap`, `linux`, `winnt`  
Wajib: Ya

### Sintaksis Respons
<a name="authenticate-response-syntax"></a>

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

### Elemen jawaban
<a name="authenticate-response-elements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Data berikut dikembalikan dalam format JSON.

**accessKeyId**  
ID kunci akses yang mengidentifikasi kredensil keamanan sementara.  
Kendala Panjang: Panjang minimum 16. Panjang maksimum 128.  
Pola: `[\w]*`

**secretAccessKey**  
Kunci akses rahasia yang dapat digunakan untuk menandatangani permintaan.  
Tipe: String

**sessionToken**  
Token yang harus diteruskan pengguna ke API layanan untuk menggunakan kredensyal sementara.  
Tipe: String

**region**  
Wilayah yang Anda targetkan untuk panggilan API.  
Jenis: KONSTAN - `edge`

### Kesalahan
<a name="authenticate-errors"></a>

**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