

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

# Siapkan paket penggunaan untuk REST APIs di API Gateway
<a name="api-gateway-create-usage-plans"></a>

Sebelum membuat paket penggunaan, pastikan Anda telah menyiapkan kunci API Anda. Untuk informasi selengkapnya, lihat [Siapkan kunci API untuk REST APIs di API Gateway](api-gateway-setup-api-keys.md).

**Topics**
+ [Migrasi API Anda ke paket penggunaan default (jika diperlukan)](#api-gateway-usage-plan-migrate-to-default)
+ [Buat rencana penggunaan](#api-gateway-usage-plan-create)
+ [Tambahkan tahapan ke paket penggunaan](#api-gateway-usage-plan-add-stage)
+ [Menambahkan kunci API ke paket penggunaan](#api-gateway-usage-plan-add-key)

## Migrasi API Anda ke paket penggunaan default (jika diperlukan)
<a name="api-gateway-usage-plan-migrate-to-default"></a>

Jika Anda mulai menggunakan API Gateway *setelah* fitur paket penggunaan diluncurkan pada 11 Agustus 2016, Anda akan secara otomatis mengaktifkan paket penggunaan untuk Anda di semua Wilayah yang didukung.

Jika Anda mulai menggunakan API Gateway sebelum tanggal tersebut, Anda mungkin perlu bermigrasi ke paket penggunaan default. Anda akan diminta dengan opsi **Aktifkan Paket Penggunaan** sebelum menggunakan paket penggunaan untuk pertama kalinya di Wilayah yang dipilih. Saat mengaktifkan opsi ini, Anda memiliki paket penggunaan default yang dibuat untuk setiap tahap API unik yang terkait dengan kunci API yang ada. Dalam paket penggunaan default, tidak ada batas throttle atau kuota yang ditetapkan pada awalnya, dan asosiasi antara kunci API dan tahapan API disalin ke paket penggunaan. API berperilaku sama seperti sebelumnya. Namun, Anda harus menggunakan [https://docs.aws.amazon.com/apigateway/latest/api/API_UsagePlan.html](https://docs.aws.amazon.com/apigateway/latest/api/API_UsagePlan.html)`apiStages`properti untuk mengaitkan nilai tahap API tertentu (`apiId`dan`stage`) dengan kunci API yang disertakan (via [https://docs.aws.amazon.com/apigateway/latest/api/API_UsagePlanKey.html](https://docs.aws.amazon.com/apigateway/latest/api/API_UsagePlanKey.html)), alih-alih menggunakan [ApiKey](https://docs.aws.amazon.com/apigateway/latest/api/API_ApiKey.html)`stageKeys`properti.

Untuk memeriksa apakah Anda sudah bermigrasi ke paket penggunaan default, gunakan perintah [https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html](https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html)CLI. Dalam output perintah, `features` daftar menyertakan entri `"UsagePlans"` kapan rencana penggunaan diaktifkan.

Anda juga dapat memigrasikan APIs ke paket penggunaan default dengan menggunakan AWS CLI sebagai berikut:

**Untuk bermigrasi ke paket penggunaan default menggunakan AWS CLI**

1. Panggil perintah CLI ini:. [https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-account.html](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-account.html)

1. Untuk `cli-input-json` parameter, gunakan JSON berikut:

   ```
   [
       {
           "op": "add",
           "path": "/features",
           "value": "UsagePlans"
       }
   ]
   ```

## Buat rencana penggunaan
<a name="api-gateway-usage-plan-create"></a>

Prosedur berikut menjelaskan cara membuat rencana penggunaan.

------
#### [ Konsol Manajemen AWS ]

**Untuk membuat rencana penggunaan**

1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).

1. Di panel navigasi utama API Gateway, pilih **Paket penggunaan**, lalu pilih **Buat paket penggunaan**.  
![\[Entitas rencana penggunaan API\]](http://docs.aws.amazon.com/id_id/apigateway/latest/developerguide/images/api-gateway-new-console-usage-plan-keys-create-setup.png)

1. Untuk **Nama**, masukkan nama.

1.  (Opsional) Untuk **Deskripsi**, masukkan deskripsi. 

1. Secara default, paket penggunaan mengaktifkan pelambatan. Masukkan **Rate** dan **Burst** untuk paket penggunaan Anda. Pilih **Throttling** untuk mematikan throttling. 

1. Secara default, paket penggunaan mengaktifkan kuota untuk jangka waktu tertentu. Untuk **Permintaan**, masukkan jumlah total permintaan yang dapat dibuat pengguna dalam periode waktu paket penggunaan Anda. Pilih **Kuota** untuk mematikan kuota.

1. Pilih **Buat paket penggunaan**.

------
#### [ AWS CLI ]

[create-usage-plan](https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-usage-plan.html)Perintah berikut membuat paket penggunaan yang mengatur ulang pada awal bulan:

```
aws apigateway create-usage-plan \
    --name "New Usage Plan" \
    --description "A new usage plan" \
    --throttle burstLimit=10,rateLimit=5 \
    --quota limit=500,offset=0,period=MONTH
```

------
#### [ REST API ]

Hubungi [https://docs.aws.amazon.com/apigateway/latest/api/API_CreateUsagePlan.html](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateUsagePlan.html)untuk membuat paket penggunaan.

------

## Tambahkan tahapan ke paket penggunaan
<a name="api-gateway-usage-plan-add-stage"></a>

Prosedur berikut menjelaskan cara menambahkan tahapan ke rencana penggunaan.

------
#### [ Konsol Manajemen AWS ]

**Untuk menambahkan tahapan ke rencana penggunaan**

1. Pilih paket penggunaan Anda.

1.  Di bawah tab **Tahapan terkait**, pilih **Tambahkan tahap**.  
![\[Tambahkan tahap API ke paket penggunaan.\]](http://docs.aws.amazon.com/id_id/apigateway/latest/developerguide/images/api-gateway-new-console-usage-plan-keys-create-add-stage.png)

1.  Untuk **API**, pilih API. 

1.  Untuk **Stage**, pilih panggung. 

1. (Opsional) Untuk mengaktifkan pelambatan tingkat metode, lakukan hal berikut:

   1. **Pilih **pelambatan tingkat metode**, lalu pilih Tambahkan metode.**

   1. Untuk **Sumber Daya**, pilih sumber daya dari API Anda. 

   1. Untuk **Metode**, pilih metode dari API Anda. 

   1.  Masukkan **Rate** dan **Burst** untuk paket penggunaan Anda. 

1. Pilih **Tambahkan ke paket penggunaan**.

------
#### [ AWS CLI ]

[update-usage-plan](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-usage-plan.html)Perintah berikut menambahkan `Prod` tahap API ke paket penggunaan:

```
aws apigateway update-usage-plan \
    --usage-plan-id abc123 \
    --patch-operations op="add",path="/apiStages",value="a1b1c2:Prod"
```

------
#### [ REST API ]

Hubungi [https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateUsagePlan.html](https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateUsagePlan.html)untuk memperbarui paket penggunaan.

------

## Menambahkan kunci API ke paket penggunaan
<a name="api-gateway-usage-plan-add-key"></a>

Prosedur berikut menunjukkan cara menambahkan kunci API ke paket penggunaan.

------
#### [ Konsol Manajemen AWS ]

**Untuk menambahkan kunci ke paket penggunaan**

1. Di bawah tab **Kunci API Terkait**, pilih **Tambahkan kunci API**.   
![\[Entitas rencana penggunaan API\]](http://docs.aws.amazon.com/id_id/apigateway/latest/developerguide/images/api-gateway-new-console-usage-plan-keys-create-add-key.png)

1. 

   1.  Untuk mengaitkan kunci yang ada ke paket penggunaan Anda, pilih **Tambahkan kunci yang ada**, lalu pilih kunci yang ada dari menu tarik-turun.

   1. Untuk membuat kunci API baru, pilih **Buat dan tambahkan kunci baru**, lalu buat kunci baru. Untuk informasi selengkapnya tentang cara membuat kunci baru, lihat[Membuat kunci API](api-gateway-setup-api-keys.md#api-gateway-usage-plan-create-apikey).

1. Pilih **Tambahkan kunci API**.

------
#### [ AWS CLI ]

[create-usage-plan-key](https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-usage-plan-key.html)Perintah berikut mengaitkan kunci API yang ada dengan paket penggunaan:

```
aws apigateway create-usage-plan-key \
    --usage-plan-id a1b2c3 \
    --key-type "API_KEY" \
    --key-id aaa111bbb
```

------
#### [ REST API ]

Panggilan [https://docs.aws.amazon.com/apigateway/latest/api/API_CreateUsagePlanKey.html](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateUsagePlanKey.html)untuk mengaitkan kunci API yang ada dengan paket penggunaan.

Anda juga dapat langsung mengaitkan APIs kunci Anda dengan paket penggunaan saat Anda mengimpornya. Panggil [https://docs.aws.amazon.com/apigateway/latest/api/API_ImportApiKeys.html](https://docs.aws.amazon.com/apigateway/latest/api/API_ImportApiKeys.html)untuk menambahkan satu atau beberapa kunci API langsung ke paket penggunaan yang ditentukan. Payload permintaan harus berisi nilai kunci API, pengenal paket penggunaan terkait, flag Boolean untuk menunjukkan bahwa kunci diaktifkan untuk paket penggunaan, dan, mungkin, nama dan deskripsi kunci API. 

Contoh `apikey:import` permintaan berikut ini menambahkan tiga kunci API (seperti yang diidentifikasi oleh`key`,`name`, dan`description`) ke satu paket penggunaan (seperti yang diidentifikasi oleh`usageplanIds`): 

```
POST /apikeys?mode=import&format=csv&failonwarnings=fase HTTP/1.1
Host: apigateway.us-east-1.amazonaws.com
Content-Type: text/csv
Authorization: ...

key,name, description, enabled, usageplanIds
abcdef1234ghijklmnop8901234567, importedKey_1, firstone,  tRuE, n371pt 
abcdef1234ghijklmnop0123456789, importedKey_2, secondone, TRUE, n371pt
abcdef1234ghijklmnop9012345678, importedKey_3,          , true, n371pt
```

Akibatnya, tiga `UsagePlanKey` sumber daya dibuat dan ditambahkan ke`UsagePlan`.

Anda juga dapat menambahkan kunci API ke lebih dari satu paket penggunaan dengan cara ini. Untuk melakukan ini, ubah setiap nilai `usageplanIds` kolom menjadi string yang dipisahkan koma yang berisi pengidentifikasi rencana penggunaan yang dipilih, dan diapit dalam sepasang tanda kutip (atau). `"n371pt,m282qs"` `'n371pt,m282qs'`

------

**catatan**  
Kunci API dapat dikaitkan dengan lebih dari satu paket penggunaan. Rencana penggunaan dapat dikaitkan dengan lebih dari satu tahap. Namun, kunci API tertentu hanya dapat dikaitkan dengan satu paket penggunaan untuk setiap tahap API Anda.