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

# sam local start-api
<a name="sam-cli-command-reference-sam-local-start-api"></a>

Halaman ini memberikan informasi referensi untuk AWS Serverless Application Model `sam local start-api` subperintah Command Line Interface (AWS SAMCLI).
+ Untuk pengantar AWS SAMCLI, lihat [Apa itu AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Untuk dokumentasi tentang penggunaan AWS SAMCLI `sam local start-api` subperintah, lihat[Pengantar pengujian dengan sam local start-api](using-sam-cli-local-start-api.md).

`sam local start-api`Subperintah menjalankan AWS Lambda fungsi Anda secara lokal untuk menguji melalui host server HTTP lokal.

## Penggunaan
<a name="ref-sam-cli-local-start-api-usage"></a>

```
$ sam local start-api <options>
```

## Opsi
<a name="ref-sam-cli-local-start-api-options"></a>

`--add-host LIST`  <a name="ref-sam-cli-local-start-api-options-add-host"></a>
Meneruskan nama host ke pemetaan alamat IP ke file host wadah Docker. Parameter ini dapat dilewatkan beberapa kali.  

**Example**  
Contoh: `--add-host example.com:127.0.0.1`

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-local-start-api-options-beta-features"></a>
Izinkan atau tolak fitur beta.

`--config-env TEXT`  <a name="ref-sam-cli-local-start-api-options-config-env"></a>
Nama lingkungan yang menentukan nilai parameter default dalam file konfigurasi yang akan digunakan. Nilai default-nya adalah “default”. Untuk informasi selengkapnya tentang file konfigurasi, lihat [AWS SAMCLIberkas konfigurasi](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-local-start-api-options-config-file"></a>
Jalur dan nama file dari file konfigurasi yang berisi nilai parameter default yang akan digunakan. Nilai default-nya adalah “samconfig.toml” di root direktori proyek. Untuk informasi selengkapnya tentang file konfigurasi, lihat [AWS SAMCLIberkas konfigurasi](serverless-sam-cli-config.md).

`--container-env-vars`  <a name="ref-sam-cli-local-start-api-options-container-env-vars"></a>
Tidak wajib. Teruskan variabel lingkungan ke kontainer citra saat debugging lokal.

`--container-host TEXT`  <a name="ref-sam-cli-local-start-api-options-container-host"></a>
Host kontainer Lambda yang teremulasi secara lokal. Nilai default-nya adalah `localhost`. Jika Anda ingin menjalankan AWS SAMCLI penampung Docker di macOS, Anda dapat menentukan. `host.docker.internal` Jika Anda ingin menjalankan wadah pada host yang berbeda dari AWS SAMCLI, Anda dapat menentukan alamat IP dari host jarak jauh.

`--container-host-interface TEXT`  <a name="ref-sam-cli-local-start-api-options-container-host-interface"></a>
Alamat IP dari antarmuka jaringan host tempat kontainer port harus terikat. Nilai default-nya adalah `127.0.0.1`. Gunakan `0.0.0.0` untuk mengikat ke semua antarmuka.

`--debug`  <a name="ref-sam-cli-local-start-api-options-debug"></a>
Mengaktifkan logging debug untuk mencetak pesan debug yang dihasilkan oleh AWS SAMCLI dan menampilkan stempel waktu.

`--debug-args TEXT`  <a name="ref-sam-cli-local-start-api-options-debug-args"></a>
Argumen tambahan untuk diteruskan ke debugger.

`--debug-function`  <a name="ref-sam-cli-local-start-api-options-debug-function"></a>
Tidak wajib. Menentukan fungsi Lambda untuk diberlakukan opsi debug ketika `--warm-containers` ditentukan. Parameter ini berlaku untuk `--debug-port`, `--debugger-path`, dan `--debug-args`.

`--debug-port, -d TEXT`  <a name="ref-sam-cli-local-start-api-options-debug-port"></a>
Ketika ditentukan, mulai kontainer fungsi Lambda dalam modus debug dan ekspos port ini pada host lokal.

`--debugger-path TEXT`  <a name="ref-sam-cli-local-start-api-options-debugger-path"></a>
Jalan host ke debugger yang akan dipasang ke kontainer Lambda.

`--docker-network TEXT`  <a name="ref-sam-cli-local-start-api-options-docker-network"></a>
Nama atau ID dari jaringan Docker yang ada tempat Lambda Docker terhubung, bersama dengan jaringan bridge default. Jika tidak ditentukan, kontainer Lambda hanya terhubung ke jaringan Docker bridge default.

` --docker-volume-basedir, -v TEXT`  <a name="ref-sam-cli-local-start-api-options-docker-volume-basedir"></a>
Lokasi direktori dasar tempat AWS SAM file ada. Jika Docker berjalan pada mesin jarak jauh, Anda harus memasang jalur tempat AWS SAM file ada di mesin Docker, dan memodifikasi nilai ini agar sesuai dengan mesin jarak jauh.

`--env-vars, -n PATH`  <a name="ref-sam-cli-local-start-api-options-env-vars"></a>
JSON atau `.env` file yang berisi nilai untuk variabel lingkungan fungsi Lambda. Format file terdeteksi secara otomatis.

`--force-image-build`  <a name="ref-sam-cli-local-start-api-options-force-image-build"></a>
Menentukan apakah AWS SAM CLI harus membangun kembali gambar yang digunakan untuk memanggil fungsi dengan lapisan.

`--help`  <a name="ref-sam-cli-local-start-api-options-help"></a>
Menunjukkan pesan ini dan keluar.

`--hook-name TEXT`  <a name="ref-sam-cli-local-start-api-options-hook-name"></a>
Nama hook yang digunakan untuk memperluas AWS SAMCLI fungsionalitas.  
Nilai yang diterima:`terraform`.

`--host TEXT`  <a name="ref-sam-cli-local-start-api-options-host"></a>
Nama host lokal atau alamat IP untuk diikatkan (default: '127.0.0.1').

`--invoke-image TEXT`  <a name="ref-sam-cli-local-start-api-options-invoke-image"></a>
URI gambar kontainer yang ingin Anda gunakan untuk fungsi Lambda Anda. Secara default, AWS SAM tarik gambar kontainer dari Amazon ECR Public. Gunakan opsi ini untuk menarik citra dari lokasi lain.  
Anda dapat menentukan opsi ini beberapa kali. Setiap instans dari opsi ini dapat mengambil baik string atau pasangan kunci-nilai. Jika Anda menentukan string, itu adalah URI dari gambar kontainer yang akan digunakan untuk semua fungsi dalam aplikasi Anda. Misalnya, `sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8`. Jika Anda menentukan pasangan kunci-nilai, kuncinya adalah nama sumber daya, dan nilainya adalah URI citra kontainer untuk digunakan untuk sumber daya tersebut. Sebagai contoh, `sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.8 `. Dengan pasangan kunci-nilai, Anda dapat menentukan citra kontainer yang berbeda untuk sumber daya yang berbeda.

`--layer-cache-basedir DIRECTORY`  <a name="ref-sam-cli-local-start-api-options-layer-cache-basedir"></a>
Menentukan lokasi basedir tempat Layer yang digunakan templat Anda terunduh.

`--log-file, -l TEXT`  <a name="ref-sam-cli-local-start-api-options-log-file"></a>
Berkas log untuk mengirim log waktu aktif.

`--no-memory-limit`  <a name="ref-sam-cli-local-start-api-options-no-memory-limit"></a>
Menghapus batasan memori dalam wadah selama pemanggilan lokal, bahkan ketika memori dikonfigurasi dalam AWS SAM template.

`--parameter-overrides`  <a name="ref-sam-cli-local-start-api-options-parameter-overrides"></a>
String yang berisi penggantian CloudFormation parameter yang dikodekan sebagai pasangan kunci-nilai. Gunakan format yang sama dengan AWS Command Line Interface (AWS CLI). AWS SAMCLIFormatnya adalah kunci eksplisit dan kata kunci nilai, setiap penggantian dipisahkan oleh spasi. Berikut adalah dua contoh:  
+ `--parameter-overrides ParameterKey=hello,ParameterValue=world`
+ `--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana`

`--port, -p INTEGER`  <a name="ref-sam-cli-local-start-api-options-port"></a>
Nomor port lokal untuk didengarkan (default: '3000').

`--profile TEXT`  <a name="ref-sam-cli-local-start-api-options-profile"></a>
Profil spesifik dari file kredensyal Anda yang mendapat AWS kredensyal.

`--region TEXT`  <a name="ref-sam-cli-local-start-api-options-region"></a>
 AWS Wilayah untuk dikerahkan ke. Misalnya, us-east-1.

`--save-params`  <a name="ref-sam-cli-local-start-api-options-save-params"></a>
Simpan parameter yang Anda berikan pada baris perintah ke file AWS SAM konfigurasi.

`--shutdown`  <a name="ref-sam-cli-local-start-api-options-shutdown"></a>
Mengemulasi peristiwa shutdown setelah pemanggilan selesai, untuk menguji penanganan ekstensi perilaku shutdown.

`--skip-prepare-infra`  <a name="ref-sam-cli-local-start-api-options-skip-prepare-infra"></a>
Melewati tahap persiapan jika tidak ada perubahan infrastruktur yang dilakukan. Gunakan dengan `--hook-name` opsi.

`--skip-pull-image`  <a name="ref-sam-cli-local-start-api-options-skip-pull-image"></a>
Menentukan apakah CLI harus melewatkan menarik ke bawah citra Docker terbaru untuk waktu aktif Lambda.

`--ssl-cert-file PATH`  <a name="ref-sam-cli-local-start-api-options-ssl-cert-file"></a>
Jalur ke file sertifikat SSL (default: Tidak ada). Saat menggunakan opsi ini, `--ssl-key-file` opsi juga harus digunakan.

`--ssl-key-file PATH`  <a name="ref-sam-cli-local-start-api-options-static-dir"></a>
Jalur ke file kunci SSL (default: Tidak ada). Saat menggunakan opsi ini, `--ssl-cert-file` opsi juga harus digunakan.

`--static-dir, -s TEXT`  <a name="ref-sam-cli-local-start-api-options-static-dir"></a>
Setiap aset statis (misalnya,CSS/JavaScript/HTML) file yang terletak di direktori ini disajikan di`/`.

`--template, -t PATH`  <a name="ref-sam-cli-local-start-api-options-template"></a>
File AWS SAM template.  
Jika Anda menentukan opsi ini, hanya AWS SAM memuat templat dan sumber daya lokal yang ditunjukkannya.

`--terraform-plan-file`  <a name="ref-sam-cli-local-start-api-options-terraform-plan-file"></a>
Jalur relatif atau absolut ke file Terraform paket lokal Anda saat menggunakan AWS SAMCLI withTerraform Cloud. Opsi ini mengharuskan `--hook-name` diatur ke`terraform`.

`--warm-containers [EAGER | LAZY]`  <a name="ref-sam-cli-local-start-api-options-warm-containers"></a>
Tidak wajib. Menentukan bagaimana AWS SAMCLI mengelola kontainer untuk setiap fungsi.  
Tersedia dua opsi:  
   `EAGER`: Kontainer untuk semua fungsi dimuat saat pertama dimulai dan terus ada di antara pemanggilan.  
   `LAZY`: Kontainer hanya dimuat ketika setiap fungsi pertama kali dipanggil. Kontainer tersebut terus ada untuk pemanggilan tambahan.

## Contoh
<a name="sam-cli-command-reference-sam-local-start-api-examples"></a>

Contoh berikut memulai server lokal, memungkinkan Anda untuk menguji aplikasi Anda melalui API. Agar perintah ini berfungsi, aplikasi harus diinstal dan Docker harus berjalan.

```
$ sam local start-api --port 3000
```