Quota By Counter Keys - List By Service

Service:

API Management

Version d'API:

2024-05-01

Répertorie une collection de périodes de compteur de quota actuelles associées à la clé de compteur configurée dans la stratégie sur l’instance de service spécifiée. L’API ne prend pas encore en charge la pagination.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
quotaCounterKey	path	True	string	Identificateur de clé du compteur de quota. Il s’agit du résultat de l’expression définie dans l’attribut de contre-clé de la stratégie de quota par clé. Par exemple, si vous spécifiez counter-key="boo » dans la stratégie, il est accessible par la clé de compteur « boo ». Mais s’il est défini comme counter-key="@(« b"+"a ») », il sera accessible par la clé « ba »
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	QuotaCounterCollection	Répertorie une collection des valeurs du compteur de quota.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementGetQuotaCounterKeys

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
QuotaCounterCollection	Représentation de liste des compteurs de quotas paginés.
QuotaCounterContract	Détails du compteur de quota.
QuotaCounterValueContractProperties	Détails de la valeur du compteur de quota.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

QuotaCounterCollection

Object

Représentation de liste des compteurs de quotas paginés.

Nom	Type	Description
count	integer (int64)	Nombre total d’enregistrements sur toutes les pages.
nextLink	string	Lien de page suivant le cas échéant.
value	QuotaCounterContract[]	Valeurs du compteur de quota.

QuotaCounterContract

Object

Détails du compteur de quota.

Nom	Type	Description
counterKey	string minLength: 1	Valeur clé du compteur. Ne doit pas être vide.
periodEndTime	string (date-time)	Date de la fin de la période de compteur. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.
periodKey	string minLength: 1	Identificateur de la période pour laquelle le compteur a été collecté. Ne doit pas être vide.
periodStartTime	string (date-time)	Date du début de la période de compteur. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.
value	QuotaCounterValueContractProperties	Propriétés de la valeur de quota

QuotaCounterValueContractProperties

Object

Détails de la valeur du compteur de quota.

Nom	Type	Description
callsCount	integer (int32)	Nombre de fois que counter a été appelé.
kbTransferred	number (double)	Données transférées en kilo-octets.