Quota By Period Keys - Get

Obtém o valor do contador de cota associado à chave de contador na política para o período específico na instância de serviço.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods/{quotaPeriodKey}?api-version=2020-06-01-preview

Parâmetros de URI

Name In Required Type Description
quotaCounterKey
path True
  • string

Identificador de chave do contador de cota. Esse é 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 será acessível pela chave do contador "boo". Mas se estiver definido como counter-key="@("b"+"a")", ele poderá ser acessado pela chave "ba"

quotaPeriodKey
path True
  • string

Identificador de chave do período de cota.

resourceGroupName
path True
  • string

O nome do grupo de recursos.

serviceName
path True
  • string

O nome do serviço API Management serviço.

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

subscriptionId
path True
  • string

Credenciais de assinatura que identificam exclusivamente Microsoft Azure assinatura. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão da API a ser usada com a solicitação do cliente.

Respostas

Name Type Description
200 OK

O corpo da resposta contém os detalhes do contador cota para o período especificado.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory fluxo OAuth2.

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementGetQuotaCounterKeysByQuotaPeriod

Sample Request

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

Sample Response

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

Definições

ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta de erro.

QuotaCounterContract

Detalhes do contador de cotas.

QuotaCounterValueContractProperties

Detalhes do valor do contador de cotas.

ErrorFieldContract

Contrato de campo de erro.

Name Type Description
code
  • string

Código de erro no nível da propriedade.

message
  • string

Representação acessível por humanos de erro no nível da propriedade.

target
  • string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Name Type Description
error.code
  • string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.

error.details

A lista de campos inválidos enviado na solicitação, no caso de erro de validação.

error.message
  • string

Representação legível ao olho humano do erro.

QuotaCounterContract

Detalhes do contador de cotas.

Name Type Description
counterKey
  • string

O valor Key do Contador. Não deve ficar vazio.

periodEndTime
  • string

A data do final do Período do Contador. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

periodKey
  • string

Identificador do Período para o qual o contador foi coletado. Não deve ficar vazio.

periodStartTime
  • string

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 pelo padrão ISO 8601.

value

Propriedades do valor da cota

QuotaCounterValueContractProperties

Detalhes do valor do contador de cotas.

Name Type Description
callsCount
  • integer

Número de vezes que Counter foi chamado.

kbTransferred
  • number

Dados transferidos em KiloBytes.