Quota By Counter Keys - List By Service

Serviço:

API Management

Versão da API:

2024-05-01

Lista uma coleção de períodos atuais do contador de cotas associados à chave de contador configurada na política na instância de serviço especificada. A api ainda não suporta paginação.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
quotaCounterKey	path	True	string	Identificador de chave do contador de quotas. Este é o resultado da expressão definida no atributo counter-key da política de cota por chave. Por exemplo, se você especificar counter-key="boo" na política, ela estará acessível pela tecla de contador "boo". Mas se for definido como counter-key="@("b"+"a")", então será acessível pela tecla "ba"
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	QuotaCounterCollection	Lista uma coleção dos valores do contador de cota.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ApiManagementGetQuotaCounterKeys

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
QuotaCounterCollection	Representação da lista do Contador de Cotas Paginadas.
QuotaCounterContract	Detalhes do contador de quotas.
QuotaCounterValueContractProperties	Detalhes do valor do contador de quotas.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

QuotaCounterCollection

Object

Representação da lista do Contador de Cotas Paginadas.

Name	Tipo	Description
count	integer (int64)	Número total de registros em todas as páginas.
nextLink	string	Link da próxima página, se houver.
value	QuotaCounterContract[]	Valores do contador de quotas.

QuotaCounterContract

Object

Detalhes do contador de quotas.

Name	Tipo	Description
counterKey	string minLength: 1	O valor da chave do contador. Não deve estar vazio.
periodEndTime	string (date-time)	A data do fim do Período de Contador. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
periodKey	string minLength: 1	Identificador do Período para o qual o contador foi recolhido. Não deve estar vazio.
periodStartTime	string (date-time)	A data do início do Período do Contador. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
value	QuotaCounterValueContractProperties	Propriedades do valor da cota

QuotaCounterValueContractProperties

Object

Detalhes do valor do contador de quotas.

Name	Tipo	Description
callsCount	integer (int32)	Número de vezes que o Contador foi chamado.
kbTransferred	number (double)	Dados transferidos em kilobytes.