Reports - List By Subscription
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=2022-08-01
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=2022-08-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
service
|
path | True |
string |
Nombre del servicio API Management. Regex pattern: |
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
$filter
|
query | True |
string |
| Campo | Uso | Operadores admitidos | Funciones admitidas | |
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 |
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
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
ApiManagementGetReportsBySubscription
Sample Request
GET https://management.azure.com/subscriptions/subid/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=2022-08-01
Sample Response
{
"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 |
---|---|
Error |
Contrato de campo de error. |
Error |
Respuesta de error. |
Report |
Representación de lista de registros de informe paginado. |
Report |
Datos de 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 |
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 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 |
Valores de página. |
ReportRecordContract
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 |
Promedio de tiempo necesario para procesar la solicitud. |
apiTimeMax |
number |
Tiempo máximo que tardó en procesar la solicitud. |
apiTimeMin |
number |
Tiempo mínimo que 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 que no sea 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 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 siguiente formato: |
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. |