Reports - List By Operation

  • Referencia
Service:
API Management
API Version:
2022-08-01

Enumera los registros de informes por operaciones de API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation?$filter={$filter}&api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation?$filter={$filter}&$top={$top}&$skip={$skip}&$orderby={$orderby}&api-version=2022-08-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
 path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serviceName
 path True

string

Nombre del servicio API Management.

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

string

Identificador de la suscripción de destino.
$filter
 query True

string

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

api-version
 query True

string

Versión de API que se usará para la operación.
$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

Nombre Tipo Description
200 OK

ReportCollection

Enumera una colección de registros de informe.
Other Status Codes

ErrorResponse

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

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

ApiManagementGetReportsByOperation

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/byOperation?$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

Status code:
200 
{
  "value": [
    {
      "name": "get",
      "apiId": "/apis/57a03a13e4bbd5119c8b19e9",
      "operationId": "/apis/57a03a13e4bbd5119c8b19e9/operations/57a03a1dd8d14f0a780d7d14",
      "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
    },
    {
      "name": "GetWeatherInformation",
      "apiId": "/apis/57c999d1e4bbd50c988cb2c3",
      "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93e",
      "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": "GetCityForecastByZIP",
      "apiId": "/apis/57c999d1e4bbd50c988cb2c3",
      "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93f",
      "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
    }
  ],
  "count": 3,
  "nextLink": ""
}

Definiciones

Nombre Description
ErrorFieldContract

Contrato de campo de error.
ErrorResponse

Respuesta de error.
ReportCollection

Representación de la lista de registros de informe paginado.
ReportRecordContract

Datos del informe.

ErrorFieldContract

Contrato de campo de error.

Nombre Tipo 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.

Nombre Tipo 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

ErrorFieldContract[]

La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.
error.message

string

Representación legible del error.

ReportCollection

Representación de la lista de registros de informe paginado.

Nombre Tipo Description
count

integer

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

string

Vínculo de página siguiente, si existe.
value

ReportRecordContract[]

Valores de página.

ReportRecordContract

Datos del informe.

Nombre Tipo Description
apiId

string

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

string

Identificador de región de API.
apiTimeAvg

number

Promedio de tiempo necesario para 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 el contenido se ha servido desde la directiva de caché.
cacheMissCount

integer

Número de veces que se ha capturado el 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 erróneas debido a errores de puerta de enlace 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 al 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

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 la operación. /apis/{apiId}/operations/{operationId}
productId

string

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

string

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

number

Promedio de tiempo necesario para 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 necesario para 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 siguiente formato: 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 al que están relacionados estos datos de registro.