Compartir a través de

Reports - List By Subscription

  • Referencia
Servicio:
API Management
Versión de la API:
2024-05-01

Enumera los registros de informe por suscripción.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription?$filter={$filter}&api-version=2024-05-01
Con parámetros opcionales: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription?$filter={$filter}&$top={$top}&$skip={$skip}&$orderby={$orderby}&api-version=2024-05-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

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

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nombre del servicio API Management.
subscriptionId
 path True

string (uuid)

Identificador de la suscripción de destino. El valor debe ser un UUID.
$filter
 query True

string

| Campo | Uso | Operadores admitidos | Funciones admitidas |
|-------------|-------------|-------------|-------------|
| marca de tiempo | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | seleccionar, filtrar | eq | |
| productId | seleccionar, filtrar | eq | |
| subscriptionId | seleccionar, filtrar | 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

minLength: 1

Versión de la API que se va a usar para esta operación.
$orderby
 query

string

OData order by query option (Orden de OData por opción de consulta).
$skip
 query

integer (int32)

minimum: 0

Número de registros que se van a omitir.
$top
 query

integer (int32)

minimum: 1

Número de registros que se van 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 por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

ApiManagementGetReportsBySubscription

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/bySubscription?$filter=timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'&api-version=2024-05-01

Respuesta de muestra

status code:
200 
{
  "value": [
    {
      "name": "",
      "userId": "/users/1",
      "productId": "/products/5600b59475ff190048060001",
      "subscriptionId": "/subscriptions/5600b59475ff190048070001",
      "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": "",
      "userId": "/users/1",
      "productId": "/products/5600b59475ff190048060002",
      "subscriptionId": "/subscriptions/5600b59475ff190048070002",
      "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": "",
      "userId": "/users/1",
      "productId": "/products/5702e97e5157a50f48dce801",
      "subscriptionId": "/subscriptions/5702e97e5157a50a9c733303",
      "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
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
ReportCollection

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

Datos de informe.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

ReportCollection

Object

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

Nombre Tipo Description
count

integer (int64)

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

Object

Datos de 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 (double)

Promedio de tiempo necesario para procesar la solicitud.
apiTimeMax

number (double)

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

number (double)

Tiempo mínimo necesario para procesar la solicitud.
bandwidth

integer (int64)

Ancho de banda consumido.
cacheHitCount

integer (int32)

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

integer (int32)

Número de veces que se capturó el contenido del back-end.
callCountBlocked

integer (int32)

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 (int32)

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 (int32)

Número de otras llamadas.
callCountSuccess

integer (int32)

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

integer (int32)

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 de 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 (double)

Promedio de tiempo necesario para procesar la solicitud en el back-end.
serviceTimeMax

number (double)

Tiempo máximo necesario para procesar la solicitud en el back-end.
serviceTimeMin

number (double)

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 (date-time)

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.