Lấy hạn mức còn lại của bạn

Tham số

Lingara-Versionheaderstringtùy chọn

Phiên bản API dùng để trả lời yêu cầu này. Nếu không có, token truy cập nhận phiên bản mà ứng dụng khách của nó được gắn, còn yêu cầu không có token nhận phiên bản hiện tại. Phiên bản đang phát triển chỉ có thể dùng bằng cách nêu tên nó ở đây. Phiên bản không xác định được trả lời bằng 400 với mã api_version_unknown. GET /v1/versions liệt kê các phiên bản.

Phản hồi

200 Hạn mức của bạn

allowancearray of AllowanceRowbắt buộc

featurestringbắt buộc

windowstringbắt buộc

limitintegerbắt buộc

usedintegerbắt buộc

remainingintegerbắt buộc

reset_atinteger | nulltùy chọn

ledgerUsageLedger | nulltùy chọn

Số lệnh gọi và đơn vị của ứng dụng khách này kể từ nửa đêm UTC ngày đầu tháng. Chỉ có với ứng dụng khách tính phí theo mức dùng, vốn không tiêu hạn mức khi gọi. Có thể chậm hơn lệnh gọi mới nhất của bạn tối đa năm giây.

sincestringbắt buộc

callsintegerbắt buộc

unitsintegerbắt buộc

Lỗi

410application/json

Phiên bản API dùng để trả lời yêu cầu này đã bị ngừng. Hãy gửi một phiên bản được hỗ trợ trong Lingara-Version, hoặc gắn ứng dụng khách với một phiên bản khác.

4XXapplication/json

Yêu cầu đã bị từ chối. code cho biết lý do, và error diễn đạt lý do đó bằng lời.

503application/json · text/plain

Dịch vụ tạm thời không khả dụng; hãy thử lại sau số giây ghi trong Retry-After. Trong thời gian bảo trì, phần thân là văn bản thuần thay vì phong bì lỗi.

5XXapplication/json

Yêu cầu đã bị từ chối. code cho biết lý do, và error diễn đạt lý do đó bằng lời.

codestringbắt buộc

Lý do yêu cầu bị từ chối, dưới dạng một mã ổn định để rẽ nhánh: ví dụ insufficient_scope (403), rate_limited (429) và, với ứng dụng khách tính phí theo mức dùng, spend_cap_reached (402) và metered_billing_inactive (402).

errorstringbắt buộc

Ví dụ

curl "https://api.getlingara.com/v1/usage" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

const usage = await client.getUsage();
for (const row of usage.allowance) {
  console.log(row.feature, row.window, `${row.remaining} of ${row.limit} left`);
}

let usage = client.get_usage().await?;
for row in &usage.allowance {
    println!("{} {}: {} of {} left", row.feature, row.window, row.remaining, row.limit);
}

usage, err := client.GetUsage(ctx)
if err != nil {
	return err
}
for _, row := range usage.Value.Allowance {
	fmt.Printf("%s (%s): %d of %d left\n", row.Feature, row.Window, row.Remaining, row.Limit)
}

import com.getlingara.client.model.AllowanceRow;
import com.getlingara.client.model.Usage;

Usage usage = client.getUsage().body();
for (AllowanceRow row : usage.getAllowance()) {
  System.out.println(
      row.getFeature()
          + " ("
          + row.getWindow()
          + "): "
          + row.getRemaining()
          + " of "
          + row.getLimit()
          + " left");
}

val usage = client.getUsage().body
for (row in usage.allowance) {
    println("${row.feature} (${row.window}): ${row.remaining} of ${row.limit} left")
}

usage = client.get_usage.value
usage.allowance.each { |row| puts "#{row.feature} (#{row.window}): #{row.remaining} of #{row.limit} left" }
puts "#{usage.ledger.calls} calls this month" if usage.ledger

foreach ($client->getUsage()->value->getAllowance() as $row) {
    echo $row->getFeature(), ': ', $row->getRemaining(), ' of ', $row->getLimit(), ' left this ', $row->getWindow(), "\n";
}

Muốn dùng thư viện? Xem mục Thư viện.