Gateway - List Trace

Referentie

Service:: API Management

API Version:: 2023-05-01-preview

Haalt trace op die is verzameld door de gateway.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listTrace?api-version=2023-05-01-preview

URI-parameters

Name	In	Vereist	Type	Description
gatewayId	path	True	string	Gateway-entiteits-id. Moet uniek zijn in het huidige API Management service-exemplaar. Mag geen waarde 'beheerd' hebben
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string	De naam van de API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
traceId	string	Tracerings-id.

Antwoorden

Name	Type	Description
200 OK	GatewayTraceContract	De hoofdtekst van het antwoord bevat tracering die is verzameld door de gateway.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

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

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGatewayListTrace

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/listTrace?api-version=2023-05-01-preview

{
  "traceId": "CrDvXXXXXXXXXXXXXVU3ZA2-1"
}

Sample Response

Status code:: 200

{
  "serviceName": "apimService1",
  "traceId": "1e0447d4-XXXX-XXXX-XXXX-dbdb8098a0d3",
  "traceEntries": {
    "inbound": [
      {
        "source": "api-inspector",
        "timestamp": "2023-05-03T12:03:04.6899436Z",
        "elapsed": "00:00:00.2983315",
        "data": {
          "request": {
            "method": "GET",
            "url": "https://proxy.msitesting.net/6452XXXXXXXXXXXX9c2facb1/64524dXXXXXXXXXXXX2facb3?subscription-key=117313e70XXXXXXXXXXXX38ba4658ca3",
            "headers": [
              {
                "name": "Host",
                "value": "proxy.msitesting.net"
              }
            ]
          }
        }
      },
      {
        "source": "api-inspector",
        "timestamp": "2023-05-03T12:03:04.6969650Z",
        "elapsed": "00:00:00.3046329",
        "data": {
          "configuration": {
            "api": {
              "from": "/6452XXXXXXXXXXXX9c2facb1",
              "to": {
                "scheme": "http",
                "host": "msitesting.net",
                "port": 80,
                "path": "/",
                "queryString": "",
                "query": {},
                "isDefaultPort": true
              },
              "version": null,
              "revision": "1"
            },
            "operation": {
              "method": "GET",
              "uriTemplate": "/64524dXXXXXXXXXXXX2facb3"
            },
            "user": "-",
            "product": "-"
          }
        }
      },
      {
        "source": "cors",
        "timestamp": "2023-05-03T12:03:04.9901631Z",
        "elapsed": "00:00:00.5972352",
        "data": "Origin header was missing or empty and the request was classified as not cross-domain. CORS policy was not applied."
      },
      {
        "source": "set-status",
        "timestamp": "2023-05-03T12:03:05.0031202Z",
        "elapsed": "00:00:00.6107970",
        "data": {
          "message": [
            "Response status code was set to 200",
            "Response status reason was set to 'OK'"
          ]
        }
      },
      {
        "source": "return-response",
        "timestamp": "2023-05-03T12:03:05.0086543Z",
        "elapsed": "00:00:00.6164228",
        "data": {
          "message": "Return response was applied",
          "response": {
            "status": {
              "code": "OK",
              "reason": "OK"
            },
            "headers": []
          }
        }
      }
    ],
    "outbound": [
      {
        "source": "transfer-response",
        "timestamp": "2023-05-03T12:03:05.0438287Z",
        "elapsed": "00:00:00.6510195",
        "data": {
          "message": "Response has been sent to the caller in full"
        }
      }
    ]
  }
}

Definities

Name	Description
ErrorFieldContract	Fout Veldcontract.
ErrorResponse	Foutreactie.
GatewayListTraceContract	Traceringseigenschappen weergeven.
GatewayTraceContract	Tracering verzameld in gateway.

ErrorFieldContract

Fout Veldcontract.

Name	Type	Description
code	string	Foutcode op eigenschapsniveau.
message	string	Door mensen leesbare weergave van fout op eigenschapsniveau.
target	string	Naam van eigenschap.

ErrorResponse

Foutreactie.

Name	Type	Description
error.code	string	Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
error.details	ErrorFieldContract[]	De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout.
error.message	string	Door mensen leesbare weergave van de fout.

GatewayListTraceContract

Traceringseigenschappen weergeven.

Name	Type	Description
traceId	string	Tracerings-id.

GatewayTraceContract

Tracering verzameld in gateway.

Share via