Quota By Counter Keys - List By Service

Служба:

API Management

Версия API:

2024-05-01

Выводит коллекцию текущих периодов счетчика квот, связанных с ключом счетчика, настроенным в политике в указанном экземпляре службы. Api пока не поддерживает разбиение по страницам.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
quotaCounterKey	path	True	string	Идентификатор ключа счетчика квот. Это результат выражения, определенного в атрибуте счетчика политики по ключу. Например, если в политике указан параметр counter-key="boo", он доступен с помощью ключа счетчика boo. Но если он определен как counter-key="@("b"+"a")", он будет доступен с помощью ключа ba.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Имя службы управления API.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	QuotaCounterCollection	Содержит коллекцию значений счетчика квот.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementGetQuotaCounterKeys

Образец запроса

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
QuotaCounterCollection	Представление списка счетчиков квот на страницы.
QuotaCounterContract	Сведения о счетчике квот.
QuotaCounterValueContractProperties	Сведения о значении счетчика квот.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

QuotaCounterCollection

Object

Представление списка счетчиков квот на страницы.

Имя	Тип	Описание
count	integer (int64)	Общее число записей на всех страницах.
nextLink	string	Следующая ссылка на страницу, если она есть.
value	QuotaCounterContract[]	Значения счетчика квот.

QuotaCounterContract

Object

Сведения о счетчике квот.

Имя	Тип	Описание
counterKey	string minLength: 1	Значение ключа счетчика. Не должно быть пустым.
periodEndTime	string (date-time)	Дата окончания периода счетчика. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ, как указано в стандарте ISO 8601.
periodKey	string minLength: 1	Идентификатор периода, для которого был собран счетчик. Не должно быть пустым.
periodStartTime	string (date-time)	Дата начала счетчика. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ, как указано в стандарте ISO 8601.
value	QuotaCounterValueContractProperties	Свойства значения квоты

QuotaCounterValueContractProperties

Object

Сведения о значении счетчика квот.

Имя	Тип	Описание
callsCount	integer (int32)	Число вызовов счетчика.
kbTransferred	number (double)	Данные, передаваемые в килобайтах.