Reports - List By Request

Referência

Service:: API Management

API Version:: 2022-08-01

Lista registros de relatório por Solicitação.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
serviceName	path	True	string	O nome do serviço Gerenciamento de API. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	A ID da assinatura de destino.
$filter	query	True	string	\| Campo \| Uso \| Operadores com suporte \| Funções com suporte \| \|-------------\|-------------\|-------------\|-------------\| \| carimbo de data/hora \| filter \| ge, le \| \| \| apiId \| filter \| eq \| \| \| operationId \| filter \| eq \| \| \| productId \| filter \| eq \| \| \| \| userId \| filter \| eq \| \| \| apiRegion \| filter \| eq \| \| \| subscriptionId \| filter \| eq \| \|
api-version	query	True	string	A versão da API a ser usada para esta operação.
$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	RequestReportCollection	Lista uma coleção de registros de relatório.
Other Status Codes	ErrorResponse	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

ApiManagementGetReportsByRequest

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/byRequest?$filter=timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'&api-version=2022-08-01

/** Samples for Reports ListByRequest. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByRequest.json
     */
    /**
     * Sample code: ApiManagementGetReportsByRequest.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetReportsByRequest(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .reports()
            .listByRequest(
                "rg1",
                "apimService1",
                "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'",
                null,
                null,
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_get_reports_by_request.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.reports.list_by_request(
        resource_group_name="rg1",
        service_name="apimService1",
        filter="timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByRequest.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByRequest.json
func ExampleReportsClient_NewListByRequestPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewReportsClient().NewListByRequestPager("rg1", "apimService1", "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", &armapimanagement.ReportsClientListByRequestOptions{Top: nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RequestReportCollection = armapimanagement.RequestReportCollection{
		// 	Count: to.Ptr[int64](2),
		// 	Value: []*armapimanagement.RequestReportRecordContract{
		// 		{
		// 			OperationID: to.Ptr("/apis/5931a75ae4bbd512a88c680b/operations/-"),
		// 			Method: to.Ptr("GET"),
		// 			APIID: to.Ptr("/apis/5931a75ae4bbd512a88c680b"),
		// 			APIRegion: to.Ptr("East Asia"),
		// 			APITime: to.Ptr[float64](221.1544),
		// 			Cache: to.Ptr("none"),
		// 			IPAddress: to.Ptr("207.xx.155.xx"),
		// 			ProductID: to.Ptr("/products/-"),
		// 			RequestID: to.Ptr("63e7119c-26aa-433c-96d7-f6f3267ff52f"),
		// 			RequestSize: to.Ptr[int32](0),
		// 			ResponseCode: to.Ptr[int32](404),
		// 			ResponseSize: to.Ptr[int32](405),
		// 			ServiceTime: to.Ptr[float64](0),
		// 			SubscriptionID: to.Ptr("/subscriptions/5600b59475ff190048070002"),
		// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-03T00:17:00.164Z"); return t}()),
		// 			URL: to.Ptr("https://apimService1.azure-api.net/echo/resource?param1=sample"),
		// 			UserID: to.Ptr("/users/1"),
		// 		},
		// 		{
		// 			OperationID: to.Ptr("/apis/5931a75ae4bbd512a88c680b/operations/-"),
		// 			Method: to.Ptr("POST"),
		// 			APIID: to.Ptr("/apis/5931a75ae4bbd512a88c680b"),
		// 			APIRegion: to.Ptr("East Asia"),
		// 			APITime: to.Ptr[float64](6.675400000000001),
		// 			Cache: to.Ptr("none"),
		// 			IPAddress: to.Ptr("207.xx.155.xx"),
		// 			ProductID: to.Ptr("/products/-"),
		// 			RequestID: to.Ptr("e581b7f7-c9ec-4fc6-8ab9-3855d9b00b04"),
		// 			RequestSize: to.Ptr[int32](0),
		// 			ResponseCode: to.Ptr[int32](404),
		// 			ResponseSize: to.Ptr[int32](403),
		// 			ServiceTime: to.Ptr[float64](0),
		// 			SubscriptionID: to.Ptr("/subscriptions/5600b59475ff190048070002"),
		// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-03T00:17:20.525Z"); return t}()),
		// 			URL: to.Ptr("https://apimService1.azure-api.net/echo/resource"),
		// 			UserID: to.Ptr("/users/1"),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists report records by Request.
 *
 * @summary Lists report records by Request.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByRequest.json
 */
async function apiManagementGetReportsByRequest() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const filter =
    "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.reports.listByRequest(resourceGroupName, serviceName, filter)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "apiId": "/apis/5931a75ae4bbd512a88c680b",
      "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-",
      "productId": "/products/-",
      "userId": "/users/1",
      "method": "GET",
      "url": "https://apimService1.azure-api.net/echo/resource?param1=sample",
      "ipAddress": "207.xx.155.xx",
      "responseCode": 404,
      "responseSize": 405,
      "timestamp": "2017-06-03T00:17:00.1649134Z",
      "cache": "none",
      "apiTime": 221.1544,
      "serviceTime": 0,
      "apiRegion": "East Asia",
      "subscriptionId": "/subscriptions/5600b59475ff190048070002",
      "requestId": "63e7119c-26aa-433c-96d7-f6f3267ff52f",
      "requestSize": 0
    },
    {
      "apiId": "/apis/5931a75ae4bbd512a88c680b",
      "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-",
      "productId": "/products/-",
      "userId": "/users/1",
      "method": "POST",
      "url": "https://apimService1.azure-api.net/echo/resource",
      "ipAddress": "207.xx.155.xx",
      "responseCode": 404,
      "responseSize": 403,
      "timestamp": "2017-06-03T00:17:20.5255131Z",
      "cache": "none",
      "apiTime": 6.675400000000001,
      "serviceTime": 0,
      "apiRegion": "East Asia",
      "subscriptionId": "/subscriptions/5600b59475ff190048070002",
      "requestId": "e581b7f7-c9ec-4fc6-8ab9-3855d9b00b04",
      "requestSize": 0
    }
  ],
  "count": 2
}

Definições

Nome	Description
ErrorFieldContract	Contrato de Campo de Erro.
ErrorResponse	Resposta de erro.
RequestReportCollection	Representação da lista de registros de relatório paginado.
RequestReportRecordContract	Solicitar dados do Relatório.

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	ErrorFieldContract[]	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.

RequestReportCollection

Representação da lista de registros de relatório paginado.

Nome	Tipo	Description
count	integer	Número total de contagem de registros em todas as páginas.
value	RequestReportRecordContract[]	Valores de página.

RequestReportRecordContract

Solicitar dados do Relatório.

Nome	Tipo	Description
apiId	string	Caminho do identificador de API. /apis/{apiId}
apiRegion	string	Região do Azure em que o gateway que processou essa solicitação está localizado.
apiTime	number	O tempo total necessário para processar essa solicitação.
backendResponseCode	string	O código de status HTTP recebido pelo gateway como resultado do encaminhamento dessa solicitação para o back-end.
cache	string	Especifica se o cache de resposta estava envolvido na geração da resposta. Se o valor for nenhum, o cache não foi usado. Se o valor for atingido, a resposta armazenada em cache será retornada. Se o valor for perdido, o cache foi usado, mas a pesquisa resultou em uma falha e a solicitação foi atendida pelo back-end.
ipAddress	string	O endereço IP do cliente associado a essa solicitação.
method	string	O método HTTP associado a essa solicitação..
operationId	string	Caminho do identificador de operação. /apis/{apiId}/operations/{operationId}
productId	string	Caminho do identificador do produto. /products/{productId}
requestId	string	Identificador de solicitação.
requestSize	integer	O tamanho dessa solicitação..
responseCode	integer	O código de status HTTP retornado pelo gateway.
responseSize	integer	O tamanho da resposta retornada pelo gateway.
serviceTime	number	ele tempo que levou para encaminhar este pedido para o back-end e obter a resposta de volta.
subscriptionId	string	Caminho do identificador de assinatura. /subscriptions/{subscriptionId}
timestamp	string	A data e a hora em que essa solicitação foi recebida pelo gateway no formato ISO 8601.
url	string	A URL completa associada a essa solicitação.
userId	string	Caminho do identificador do usuário. /users/{userId}

Reports - List By Request

Parâmetros de URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

ApiManagementGetReportsByRequest

Sample Request

Sample Response

Definições

ErrorFieldContract

ErrorResponse

RequestReportCollection

RequestReportRecordContract

Recursos adicionais