Quota By Period Keys - Get

Obtém o valor do contador de quotas associado à contra-chave na política para o período específico em 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 do URI

Name In Required Type Description
quotaCounterKey
path True
  • string

Identificador de chave de contador de quotas. Este é o resultado da expressão definida no atributo contra-chave da política quota-a-chave. Por exemplo, se especificar contra-chave="boo" na apólice, então é acessível por contador "boo". Mas se for definido como contra-chave="@"("b"+""")" então será acessível por tecla "ba"

quotaPeriodKey
path True
  • string

Identificador chave do período de quota.

resourceGroupName
path True
  • string

O nome do grupo de recursos.

serviceName
path True
  • string

O nome do serviço de Gestão da API.

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

subscriptionId
path True
  • string

Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID de subscrição faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

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

Respostas

Name Type Description
200 OK

O organismo de resposta contém os dados do contador quota para o período especificado.

Other Status Codes

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

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

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 quotas.

QuotaCounterValueContractProperties

Detalhes do valor do contador de quotas.

ErrorFieldContract

Contrato de Campo de Erro.

Name Type Description
code
  • string

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

message
  • string

Representação legível pelo homem de erro de nível de propriedade.

target
  • string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Name Type Description
error.code
  • string

Código de erro definido pelo serviço. Este código serve como sub-estado para o código de erro HTTP especificado na resposta.

error.details

A lista de campos inválidos envia a pedido, em caso de erro de validação.

error.message
  • string

Representação legível pelo erro.

QuotaCounterContract

Detalhes do contador de quotas.

Name Type Description
counterKey
  • string

O valor chave do contador. Não deve estar vazio.

periodEndTime
  • string

A data do fim do Período de Contra-Ataque. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.

periodKey
  • string

Identificador do período para o qual o contador foi recolhido. Não deve estar vazio.

periodStartTime
  • string

A data do início do Período de Contra-Ataque. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.

value

Propriedades de valor de quota

QuotaCounterValueContractProperties

Detalhes do valor do contador de quotas.

Name Type Description
callsCount
  • integer

O número de vezes que o Contador foi chamado.

kbTransferred
  • number

Dados transferidos em KiloBytes.