Quota By Counter Keys - List By Service

Zobrazuje kolekci aktuálních období čítačů kvót přidružených k čítači, který je nakonfigurovaný 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=2021-01-01-preview

Parametry identifikátoru URI

Name In Required Type Description
quotaCounterKey
path True
  • string

Identifikátor klíče čítače kvóty Jedná se o výsledek výrazu definovaného v atributu Counter-Key zásady kvót-by-Key. Pokud například v zásadách zadáte Counter-Key = "Boo", bude přístupný pomocí klíče "Boo". Pokud je ale definovaný jako Counter-Key = "@ (" b "+" a ")", bude přístupný pro klíč "BA".

resourceGroupName
path True
  • string

Název skupiny prostředků.

serviceName
path True
  • string

Název služby API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří část identifikátoru URI pro každé volání služby.

api-version
query True
  • string

Verze rozhraní API, která se má použít s požadavkem klienta

Odpovědi

Name Type Description
200 OK

Zobrazuje kolekci hodnot čítačů kvót.

Other Status Codes

Chybová odezva popisující, proč se operace nezdařila

Zabezpečení

azure_auth

Azure Active Directory tok OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Příklady

ApiManagementGetQuotaCounterKeys

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/quotas/ba?api-version=2021-01-01-preview

Sample Response

{
  "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

ErrorFieldContract

Kontrakt pole chyby.

ErrorResponse

Chybná odpověď.

QuotaCounterCollection

Reprezentace seznamu čítače stránkovaného kvótu.

QuotaCounterContract

Podrobnosti čítače kvót.

QuotaCounterValueContractProperties

Podrobnosti o hodnotě čítače kvót.

ErrorFieldContract

Kontrakt pole chyby.

Name Type Description
code
  • string

Kód chyby úrovně vlastnosti

message
  • string

Uživatelsky čitelné reprezentace chyby na úrovni vlastností.

target
  • string

Název vlastnosti

ErrorResponse

Chybná odpověď.

Name Type Description
error.code
  • string

Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.

error.details

Seznam neplatných polí odesílaných v žádosti v případě chyby ověřování.

error.message
  • string

Reprezentace chyby v čitelném člověku

QuotaCounterCollection

Reprezentace seznamu čítače stránkovaného kvótu.

Name Type Description
count
  • integer

Celkový počet záznamů v počtu všech stránek.

nextLink
  • string

Odkaz na další stránku, pokud existuje.

value

Hodnoty čítače kvót.

QuotaCounterContract

Podrobnosti čítače kvót.

Name Type Description
counterKey
  • string

Hodnota klíče čítače. Nesmí být prázdný.

periodEndTime
  • string

Datum konce období čítače. Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle specifikace standardu ISO 8601.

periodKey
  • string

Identifikátor období, pro které bylo počítadlo shromážděno. Nesmí být prázdný.

periodStartTime
  • string

Datum začátku období čítače. Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle specifikace standardu ISO 8601.

value

Vlastnosti hodnoty kvóty

QuotaCounterValueContractProperties

Podrobnosti o hodnotě čítače kvót.

Name Type Description
callsCount
  • integer

Počet volání čítače.

kbTransferred
  • number

Data přenesená v kilobajtech.