Quota By Counter Keys - List By Service

Služba:

API Management

Verze rozhraní API:

2024-05-01

Zobrazí kolekci aktuálních období čítačů kvót přidružených ke klíči čítače nakonfigurovaným v zásadách pro zadanou instanci služby. Rozhraní API zatím nepodporuje stránkování.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}?api-version=2024-05-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
quotaCounterKey	path	True	string	Identifikátor klíče čítače kvóty. Toto je výsledek výrazu definovaného v atributu čítače klíče zásady kvóty podle klíče. Pokud například v zásadách zadáte counter-key="boo", zpřístupní se klíč čítače "boo". Pokud je ale definována jako counter-key="@("b"+"a")" bude přístupná klíčem "ba".
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	QuotaCounterCollection	Zobrazí kolekci hodnot čítače kvóty.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementGetQuotaCounterKeys

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/quotas/ba?api-version=2024-05-01

Ukázková odpověď

Stavový kód:

200

{
  "value": [
    {
      "counterKey": "ba",
      "periodKey": "0_P3Y6M4DT12H30M5S",
      "periodStartTime": "2014-08-04T04:24:35Z",
      "periodEndTime": "2018-02-08T16:54:40Z",
      "value": {
        "callsCount": 5,
        "kbTransferred": 2.5830078125
      }
    }
  ],
  "nextLink": ""
}

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
QuotaCounterCollection	Reprezentace seznamu čítačů kvót stránky
QuotaCounterContract	Podrobnosti o čítači kvóty
QuotaCounterValueContractProperties	Podrobnosti o hodnotě čítače kvóty

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

QuotaCounterCollection

Objekt

Reprezentace seznamu čítačů kvót stránky

Name	Typ	Description
count	integer (int64)	Celkový počet záznamů na všech stránkách
nextLink	string	Další odkaz na stránku, pokud existuje.
value	QuotaCounterContract[]	Hodnoty čítače kvóty.

QuotaCounterContract

Objekt

Podrobnosti o čítači kvóty

Name	Typ	Description
counterKey	string minLength: 1	Hodnota klíče čítače. Nesmí být prázdný.
periodEndTime	string (date-time)	Datum konce období čítače. Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
periodKey	string minLength: 1	Identifikátor období, pro které byl čítač shromážděn. Nesmí být prázdný.
periodStartTime	string (date-time)	Datum začátku období čítače. Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
value	QuotaCounterValueContractProperties	Vlastnosti hodnoty kvóty

QuotaCounterValueContractProperties

Objekt

Podrobnosti o hodnotě čítače kvóty

Name	Typ	Description
callsCount	integer (int32)	Počet volaného čítače
kbTransferred	number (double)	Data přenášená v kilobajtech.