Skip to content

Commit d26f59d

Browse files
author
gitName
committed
edits
1 parent cae94a4 commit d26f59d

File tree

2 files changed

+7
-9
lines changed

2 files changed

+7
-9
lines changed

articles/api-management/api-management-howto-api-inspector.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,27 +105,25 @@ Detailed steps follow.
105105
106106
```json
107107
{
108-
"token": "aid=api-name&p=tracing&ex=......."
108+
"token": "aid=api-name&......."
109109
}
110110
```
111111
112112
1. **Add the token value in a request header** - To enable tracing for a request to the API Management gateway, send the token value in an `Apim-Debug-Authorization` header. For example, to trace a call to the Petstore API that you imported in a previous tutorial, you might use a request similar to the following:
113113
114114
```bash
115-
curl -v https://apim-hello-world.azure-api.net/pet/1 HTTP/1.1 -H "Ocp-Apim-Subscription-Key: <subscription-key>" -H "Apim-Debug-Authorization: aid=api-name&p=tracing&ex=......."
115+
curl -v https://apim-hello-world.azure-api.net/pet/1 HTTP/1.1 -H "Ocp-Apim-Subscription-Key: <subscription-key>" -H "Apim-Debug-Authorization: aid=api-name&......."
116116
```
117117
118-
1. Depending on the token, the response contains different headers:
118+
1. Depending on the token, the response contains one of the following headers:
119119
* If the token is valid, the response includes an `Apim-Trace-Id` header whose value is the trace ID, similar to the following:
120120
121121
```http
122-
[....]
123122
Apim-Trace-Id: 0123456789abcdef....
124-
[....]
125123
```
126124
127125
* If the token is expired, the response includes an `Apim-Debug-Authorization-Expired` header with information about expiration date.
128-
* If the token was obtained for wrong API, the response includes an `Apim-Debug-Authorization-WrongAPI` header with an error message.
126+
* If the token was obtained for a different API, the response includes an `Apim-Debug-Authorization-WrongAPI` header with an error message.
129127
130128
1. **Retrieve the trace** - Pass the trace ID obtained in the previous step to the gateway's [List trace](/rest/api/apimanagement/gateway/list-trace) API. For example, to retrieve the trace for the managed gateway, use a request similar to the following:
131129

includes/api-management-tracing-alert.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
author: dlepow
33
ms.service: azure-api-management
44
ms.topic: include
5-
ms.date: 05/05/2024
5+
ms.date: 11/04/2024
66
ms.author: danlep
77
---
88
> [!IMPORTANT]
9-
> * API Management request tracing using the **Ocp-Apim-Trace** header in a request and using the value of the **Ocp-Apim-Trace-Location** response header is being deprecated.
10-
> * To improve security, tracing can now be enabled at the level of an individual API by obtaining a time-limited token using the API Management REST API, and passing the token in a request to the gateway. For details, see [Enable tracing of an API](../articles/api-management/api-management-howto-api-inspector.md#enable-tracing-for-an-api).
9+
> * API Management no longer supports subscriptions for tracing or the **Ocp-Apim-Trace** header.
10+
> * To improve API security, tracing can now be enabled at the level of an individual API by obtaining a time-limited token using the API Management REST API, and passing the token in a request to the gateway. For details, see [Enable tracing of an API](../articles/api-management/api-management-howto-api-inspector.md#enable-tracing-for-an-api).
1111
> * Take care when enabling tracing, as it can expose sensitive information in the trace data. Ensure that you have appropriate security measures in place to protect the trace data.

0 commit comments

Comments
 (0)