Reports - List By Product
Lista registros de relatório por Produto.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct?$filter={$filter}&api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct?$filter={$filter}&$top={$top}&$skip={$skip}&$orderby={$orderby}&api-version=2022-08-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. |
service
|
path | True |
string |
O nome do serviço Gerenciamento de API. Regex pattern: |
subscription
|
path | True |
string |
A ID da assinatura de destino. |
$filter
|
query | True |
string |
| Campo | Uso | Operadores com suporte | Funções com suporte | |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
$orderby
|
query |
string |
Opção ordenar por consulta OData. |
|
$skip
|
query |
integer int32 |
Número de registros a serem ignorados. |
|
$top
|
query |
integer int32 |
Número de registros a serem retornados. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Lista uma coleção de registros de relatório. |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
ApiManagementGetReportsByProduct
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/byProduct?$filter=timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'&api-version=2022-08-01
Sample Response
{
"value": [
{
"name": "Starter",
"productId": "/products/5600b59475ff190048060001",
"callCountSuccess": 0,
"callCountBlocked": 0,
"callCountFailed": 0,
"callCountOther": 0,
"callCountTotal": 0,
"bandwidth": 0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"apiTimeAvg": 0,
"apiTimeMin": 0,
"apiTimeMax": 0,
"serviceTimeAvg": 0,
"serviceTimeMin": 0,
"serviceTimeMax": 0
},
{
"name": "Unlimited",
"productId": "/products/5600b59475ff190048060002",
"callCountSuccess": 13,
"callCountBlocked": 1,
"callCountFailed": 0,
"callCountOther": 0,
"callCountTotal": 14,
"bandwidth": 11019,
"cacheHitCount": 0,
"cacheMissCount": 0,
"apiTimeAvg": 1015.7607923076923,
"apiTimeMin": 330.3206,
"apiTimeMax": 1819.2173,
"serviceTimeAvg": 957.094776923077,
"serviceTimeMin": 215.24,
"serviceTimeMax": 1697.3612
}
],
"count": 2,
"nextLink": ""
}
Definições
Nome | Description |
---|---|
Error |
Contrato de campo de erro. |
Error |
Resposta de erro. |
Report |
Representação de lista de registros de relatório paginado. |
Report |
Relatar dados. |
ErrorFieldContract
Contrato de campo de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código de erro no nível da propriedade. |
message |
string |
Representação legível por humanos do erro no nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta de erro.
Nome | Tipo | 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 enviados na solicitação, em caso de erro de validação. |
|
error.message |
string |
Representação legível ao olho humano do erro. |
ReportCollection
Representação de lista de registros de relatório paginado.
Nome | Tipo | Description |
---|---|---|
count |
integer |
Número total de contagem de registros em todas as páginas. |
nextLink |
string |
Próximo link da página, se houver. |
value |
Valores de página. |
ReportRecordContract
Relatar dados.
Nome | Tipo | Description |
---|---|---|
apiId |
string |
Caminho do identificador de API. /apis/{apiId} |
apiRegion |
string |
Identificador de região da API. |
apiTimeAvg |
number |
Tempo médio necessário para processar a solicitação. |
apiTimeMax |
number |
Tempo máximo necessário para processar a solicitação. |
apiTimeMin |
number |
Tempo mínimo necessário para processar a solicitação. |
bandwidth |
integer |
Largura de banda consumida. |
cacheHitCount |
integer |
Número de vezes em que o conteúdo foi fornecido da política de cache. |
cacheMissCount |
integer |
Número de vezes que o conteúdo foi buscado do back-end. |
callCountBlocked |
integer |
Número de chamadas bloqueadas devido a credenciais inválidas. Isso inclui chamadas que retornam HttpStatusCode.Unauthorized e HttpStatusCode.Forbidden e HttpStatusCode.TooManyRequests |
callCountFailed |
integer |
Falha no número de chamadas devido a erros de gateway ou back-end. Isso inclui chamadas que retornam HttpStatusCode.BadRequest(400) e qualquer código entre HttpStatusCode.InternalServerError (500) e 600 |
callCountOther |
integer |
Número de outras chamadas. |
callCountSuccess |
integer |
Número de chamadas com êxito. Isso inclui chamadas que retornam HttpStatusCode <= 301 e HttpStatusCode.NotModified e HttpStatusCode.TemporaryRedirect |
callCountTotal |
integer |
Número total de chamadas. |
country |
string |
País ao qual esses dados de registro estão relacionados. |
interval |
string |
Comprimento do período de agregação. O intervalo deve ser múltiplo de 15 minutos e pode não ser zero. O valor deve estar no formato ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). |
name |
string |
O nome, dependendo do ponto de extremidade do relatório, especifica o produto, a API, a operação ou o nome do desenvolvedor. |
operationId |
string |
Caminho do identificador de operação. /apis/{apiId}/operations/{operationId} |
productId |
string |
Caminho do identificador do produto. /products/{productId} |
region |
string |
Região do país à qual esses dados de registro estão relacionados. |
serviceTimeAvg |
number |
Tempo médio necessário para processar a solicitação no back-end. |
serviceTimeMax |
number |
Tempo máximo necessário para processar a solicitação no back-end. |
serviceTimeMin |
number |
Tempo mínimo necessário para processar a solicitação no back-end. |
subscriptionId |
string |
Caminho do identificador de assinatura. /subscriptions/{subscriptionId} |
timestamp |
string |
Início do período de agregação. A data está em conformidade com o seguinte formato: |
userId |
string |
Caminho do identificador do usuário. /users/{userId} |
zip |
string |
Cep ao qual esses dados de registro estão relacionados. |