Reports - List By Product

Enumera los registros de informe por Producto.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct?$filter={$filter}&api-version=2021-01-01-preview
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=2021-01-01-preview

Parámetros de identificador URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nombre del grupo de recursos.

serviceName
path True
  • string

Nombre del servicio de API Management.

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

subscriptionId
path True
  • string

Credenciales de suscripción que identifican de forma Microsoft Azure suscripción. El identificador de suscripción forma parte del URI para cada llamada al servicio.

$filter
query True
  • string

| Campos | Uso | Operadores admitidos | Funciones admitidas |
|-------------|-------------|-------------|-------------|
| marca de tiempo | filtro | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filtro | eq | |
| userId | filtro | eq | |
| productId | select, filter | eq | |
| subscriptionId | filtro | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| ancho de banda | select, orderBy | | |
| cacheHitsCount | Seleccione | | |
| cacheMissCount | Seleccione | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | Seleccione | | |
| apiTimeMax | Seleccione | | |
| serviceTimeAvg | Seleccione | | |
| serviceTimeMin | Seleccione | | |
| serviceTimeMax | Seleccione | | |

api-version
query True
  • string

Versión de la API que se va a usar con la solicitud de cliente.

$orderby
query
  • string

Opción OData ordenar por consulta.

$skip
query
  • integer
int32

Número de registros que se van a omitir.

$top
query
  • integer
int32

Número de registros que se va a devolver.

Respuestas

Name Type Description
200 OK

Enumera una colección de registros de informe.

Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

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=2021-01-01-preview

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

Definiciones

ErrorFieldContract

Contrato de campo de error.

ErrorResponse

Respuesta de error.

ReportCollection

Representación de lista de registros de informe paginado.

ReportRecordContract

Datos de informe.

ErrorFieldContract

Contrato de campo de error.

Name Type Description
code
  • string

Código de error de nivel de propiedad.

message
  • string

Representación legible del error de nivel de propiedad.

target
  • string

Nombre de propiedad.

ErrorResponse

Respuesta de error.

Name Type Description
error.code
  • string

Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.

error.details

Lista de campos no válidos enviados en la solicitud, en caso de error de validación.

error.message
  • string

Representación legible del error.

ReportCollection

Representación de lista de registros de informe paginado.

Name Type Description
count
  • integer

Número total de recuento de registros en todas las páginas.

nextLink
  • string

Vínculo a la página siguiente, si lo hubiera.

value

Valores de página.

ReportRecordContract

Datos de informe.

Name Type Description
apiId
  • string

Ruta de acceso del identificador de API. /apis/{apiId}

apiRegion
  • string

Identificador de región de API.

apiTimeAvg
  • number

Tiempo medio que se tardó en procesar la solicitud.

apiTimeMax
  • number

Tiempo máximo que se tardó en procesar la solicitud.

apiTimeMin
  • number

Tiempo mínimo que se tardó en procesar la solicitud.

bandwidth
  • integer

Ancho de banda consumido.

cacheHitCount
  • integer

Número de veces que se ha servido contenido desde la directiva de caché.

cacheMissCount
  • integer

Número de veces que se ha obtenido contenido del back-end.

callCountBlocked
  • integer

Número de llamadas bloqueadas debido a credenciales no válidas. Esto incluye llamadas que devuelven HttpStatusCode.Unauthorized y HttpStatusCode.Forbidden y HttpStatusCode.TooManyRequests

callCountFailed
  • integer

Número de llamadas con error debido a errores de proxy o back-end. Esto incluye llamadas que devuelven HttpStatusCode.BadRequest(400) y cualquier código entre HttpStatusCode.InternalServerError (500) y 600

callCountOther
  • integer

Número de otras llamadas.

callCountSuccess
  • integer

Número de llamadas correctas. Esto incluye llamadas que devuelven HttpStatusCode <= 301 y HttpStatusCode.NotModified y HttpStatusCode.TemporaryRedirect

callCountTotal
  • integer

Número total de llamadas.

country
  • string

País con el que están relacionados estos datos de registro.

interval
  • string

Longitud del período de agregación. El intervalo debe ser múltiplo de 15 minutos y puede no ser cero. El valor debe estar en formato ISO 8601 ( http://en.wikipedia.org/wiki/ISO_8601#Durations) .

name
  • string

El nombre, en función del punto de conexión del informe, especifica el producto, la API, la operación o el nombre del desarrollador.

operationId
  • string

Ruta de acceso del identificador de operación. /apis/{apiId}/operations/{operationId}

productId
  • string

Ruta de acceso del identificador de producto. /products/{productId}

region
  • string

Región del país con la que están relacionados estos datos de registro.

serviceTimeAvg
  • number

Tiempo medio que se tardó en procesar la solicitud en el back-end.

serviceTimeMax
  • number

Tiempo máximo que se tardó en procesar la solicitud en el back-end.

serviceTimeMin
  • number

Tiempo mínimo que tardó en procesar la solicitud en el back-end.

subscriptionId
  • string

Ruta de acceso del identificador de suscripción. /subscriptions/{subscriptionId}

timestamp
  • string

Inicio del período de agregación. La fecha se ajusta al formato siguiente: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

userId
  • string

Ruta de acceso del identificador de usuario. /users/{userId}

zip
  • string

Código postal con el que están relacionados estos datos de registro.