Mengonfigurasi kuota

OpenAPI | gRPC

Halaman ini menjelaskan cara mengonfigurasi kuota untuk API Anda. Secara umum, langkah-langkahnya adalah:

Tambahkan informasi tentang kuota ke file konfigurasi OpenAPI Anda.
Deploy file konfigurasi OpenAPI Anda.
Men-deploy Extensible Service Proxy (ESP).

Untuk mengetahui ringkasan fungsi yang disediakan oleh kuota, lihat Tentang kuota.

Prasyarat

Sebagai titik awal, halaman ini mengasumsikan bahwa Anda telah:

Cloud Endpoints yang Dikonfigurasi
Men-deploy konfigurasi Endpoint.
Men-deploy backend API.
Mengonfigurasi API Anda untuk menggunakan kunci API. Hal ini diperlukan agar Endpoint dapat mengidentifikasi project Google Cloud yang dikaitkan dengan aplikasi panggilan. Lihat Membagikan API yang dilindungi oleh kunci API untuk mengetahui informasi selengkapnya.

Menambahkan kuota ke dokumen OpenAPI

Prosedur berikut menjelaskan penambahan ekstensi yang diperlukan ke dokumen OpenAPI untuk menyiapkan kuota. Untuk mempermudah, halaman ini mengacu pada dokumen OpenAPI sebagai file openapi.yaml dan menyediakan ekstensi OpenAPI hanya dalam format YAML.

Anda menambahkan tiga bagian berikut ke file openapi.yaml:

x-google-management.metrics: Metrik bernama yang menghitung permintaan ke API Anda. Berikan nama yang menjelaskan penghitung. Nama dapat berupa kategori, seperti read-requests atau write-requests. Atau, jika Anda menentukan kuota untuk metode tertentu, Anda dapat memasukkan nama metodenya, misalnya, echo-api/echo_requests
x-google-management.quota.limits: Mewakili satu batas yang dapat diterapkan pada metrik yang telah diberi nama. Di sini, Anda mengonfigurasi jumlah permintaan yang diizinkan untuk metrik yang telah Anda tentukan. Saat ini, hanya batas per menit per project yang didukung.
x-google-quota.metricCosts: metricCosts memetakan metode ke metrik (many-to-many). Permintaan ke metode mengalokasikan penghitung untuk setiap metrik yang dipetakan. Saat mengaitkan metode dengan metrik, Anda selalu menentukan biaya untuk permintaan tersebut. Anda dapat mengonfigurasi biaya setiap metode secara independen. Hal ini memungkinkan berbagai metode untuk memakainya dengan kecepatan yang berbeda dari metrik bernama yang sama. Jika tidak memiliki persyaratan kuota yang kompleks, Anda dapat mengonfigurasi biaya setiap metrik ke 1.

Untuk mengonfigurasi kuota di API:

Buka file openapi.yaml project Anda di editor teks.
Jika Anda belum memilikinya, tambahkan ekstensi x-google-management di root file (tidak diindentasi atau bertingkat) sebelum bagian yang menentukan jalur.
Tambahkan definisi metrics yang diindentasi di bawah x-google-management.
```
x-google-management:
  metrics:
    - name: "YOUR_METRIC_NAME"
      displayName: "YOUR_METRIC-DISPLAY_NAME"
      valueType: INT64
      metricKind: DELTA
```
- Ganti YOUR_METRIC_NAME dengan nama yang menjelaskan penghitung permintaan API.
- Ganti YOUR_METRIC_DISPLAY_NAME dengan teks yang ditampilkan di halaman Endpoint > Layanan > Quotas untuk mengidentifikasi metrik.
- Kolom valueType harus INT64.
- Kolom metricKind harus DELTA.
Tambahkan kolom quota di tingkat yang sama dengan metrics, dan tambahkan kolom limits yang disusun bertingkat dalam bagian quota.
```
quota:
  limits:
    - name: "YOUR_LIMIT_NAME"
      metric: "YOUR_METRIC_NAME"
      unit: "1/min/{project}"
      values:
        STANDARD: VALUE_FOR_THE_LIMIT
```
- Ganti YOUR_LIMIT_NAME dengan nama yang menjelaskan batas.
- Mengganti YOUR_METRIC_NAME dengan metric.name yang ditentukan sebelumnya.
- Kolom unit harus "1/min/{project}". Ini adalah ID untuk batas per menit per project.
- Kolom values harus berisi STANDARD.
- Ganti VALUE_FOR_THE_LIMIT dengan nilai bilangan bulat. Ini adalah jumlah permintaan yang dapat diajukan aplikasi yang terkait dengan project Google Cloud konsumen dalam satu menit.
(Opsional) Tentukan metrik dan batas tambahan untuk setiap metrik.
Di bagian paths file openapi.yaml, tambahkan ekstensi x-google-quota yang diindentasi di bawah setiap metode yang ingin Anda terapkan kuotanya.
```
x-google-quota:
  metricCosts:
    YOUR_METRIC_NAME: YOUR_METRIC_COST
```
- Mengganti YOUR_METRIC_NAME dengan metric.name yang ditentukan sebelumnya.
- Ganti YOUR_METRIC_COST dengan bilangan bulat. Untuk setiap permintaan, penghitung permintaan untuk metrik bertambah dengan angka yang Anda tentukan untuk biaya.
Simpan file openapi.yaml.

Contoh konfigurasi kuota

Tiga contoh berikut menunjukkan cara mengonfigurasi kuota di API.

Contoh berikut menunjukkan cara mengonfigurasi kolom metric:

x-google-management:
  metrics:
    # Define a metric for read requests.
    - name: "read-requests"
      displayName: "Read requests"
      valueType: INT64
      metricKind: DELTA

Contoh berikut menunjukkan cara mengonfigurasi kolom quota dan limits dalam bagian quota:

x-google-management:
  metrics:
    # Define a metric for read requests.
    - name: "read-requests"
      displayName: "Read requests"
      valueType: INT64
      metricKind: DELTA
  quota:
    limits:
      # Define the limit or the read-requests metric.
      - name: "read-limit"
        metric: "read-requests"
        unit: "1/min/{project}"
        values:
          STANDARD: 1000

Contoh berikut menunjukkan cara mengonfigurasi ekstensi x-google-quota di bagian paths:

x-google-management:
  metrics:
    # Define a metric for read requests.
    - name: "read-requests"
      displayName: "Read requests"
      valueType: INT64
      metricKind: DELTA
  quota:
    limits:
      # Define the limit or the read-requests metric.
      - name: "read-limit"
        metric: "read-requests"
        unit: "1/min/{project}"
        values:
          STANDARD: 1000
paths:
  "/echo":
    post:
      description: "Echo back a given message."
      operationId: "echo"
      produces:
      - "application/json"
      responses:
        200:
          description: "Echo"
          schema:
            $ref: "#/definitions/echoMessage"
      parameters:
      - description: "Message to echo"
        in: body
        name: message
        required: true
        schema:
          $ref: "#/definitions/echoMessage"
      x-google-quota:
        metricCosts:
          "read-requests": 1
      security:
      - api_key: []

Lihat ekstensi OpenAPI untuk contoh selengkapnya dan deskripsi mendetail tentang ekstensi x-google-management dan x-google-quota.

Men-deploy file `openapi.yaml` dan ESP

Agar kuota dapat diterapkan, Anda harus:

Deploy file openapi.yaml ke Pengelolaan Layanan, yang akan mengubah konfigurasi di Endpoint.
Deploy ESP. Langkah-langkah untuk men-deploy ESP bervariasi berdasarkan backend tempat API Anda di-deploy.

Untuk langkah-langkah mendetail, lihat Men-deploy backend API.