Λήψη του υπολοίπου του ορίου χρήσης σας

Παράμετροι

Lingara-Versionheaderstringπροαιρετικό

Η έκδοση API με την οποία απαντάται αυτό το αίτημα. Χωρίς αυτήν, ένα token πρόσβασης παίρνει την έκδοση στην οποία είναι δεσμευμένος ο πελάτης του και ένα αίτημα χωρίς token παίρνει την τρέχουσα έκδοση. Η έκδοση που βρίσκεται ακόμη υπό ανάπτυξη είναι προσβάσιμη μόνο αν την ονομάσετε εδώ. Μια άγνωστη έκδοση απαντάται με 400 και κωδικό api_version_unknown. Το GET /v1/versions παραθέτει τις εκδόσεις.

Αποκρίσεις

200 Το όριο χρήσης σας

allowancearray of AllowanceRowυποχρεωτικό

featurestringυποχρεωτικό

windowstringυποχρεωτικό

limitintegerυποχρεωτικό

usedintegerυποχρεωτικό

remainingintegerυποχρεωτικό

reset_atinteger | nullπροαιρετικό

ledgerUsageLedger | nullπροαιρετικό

Οι κλήσεις και οι μονάδες αυτού του πελάτη από τα μεσάνυχτα UTC της πρώτης του μήνα. Εμφανίζεται μόνο για πελάτη με χρέωση βάσει χρήσης, του οποίου οι κλήσεις δεν καταναλώνουν όριο χρήσης. Μπορεί να καθυστερεί έως πέντε δευτερόλεπτα σε σχέση με την τελευταία σας κλήση.

sincestringυποχρεωτικό

callsintegerυποχρεωτικό

unitsintegerυποχρεωτικό

Σφάλματα

410application/json

Η έκδοση API με την οποία απαντάται αυτό το αίτημα έχει καταργηθεί. Στείλτε μια υποστηριζόμενη έκδοση στο Lingara-Version ή συνδέστε τον πελάτη με άλλη έκδοση.

4XXapplication/json

Το αίτημα απορρίφθηκε. Το code λέει γιατί και το error το εξηγεί με λόγια.

503application/json · text/plain

Η υπηρεσία δεν είναι προσωρινά διαθέσιμη· δοκιμάστε ξανά μετά τον αριθμό δευτερολέπτων στο Retry-After. Κατά τη συντήρηση, το σώμα είναι απλό κείμενο αντί για τον φάκελο σφάλματος.

5XXapplication/json

Το αίτημα απορρίφθηκε. Το code λέει γιατί και το error το εξηγεί με λόγια.

codestringυποχρεωτικό

Γιατί απορρίφθηκε το αίτημα, ως σταθερός κωδικός για διακλάδωση: για παράδειγμα insufficient_scope (403), rate_limited (429) και, για πελάτη με χρέωση βάσει χρήσης, spend_cap_reached (402) και metered_billing_inactive (402).

errorstringυποχρεωτικό

Παράδειγμα

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";
}

Προτιμάτε μια βιβλιοθήκη; Δείτε την ενότητα Βιβλιοθήκες.