Gateway - List Trace

서비스:

API Management

API 버전:

2024-05-01

게이트웨이에서 수집된 추적을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 'managed' 값이 없어야 합니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management 서비스의 이름입니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
traceId	string	추적 ID입니다.

응답

Name	형식	Description
200 OK	GatewayTraceContract	응답 본문에는 게이트웨이에서 수집한 추적이 포함됩니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementGatewayListTrace

샘플 요청

HTTP

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

{
  "traceId": "CrDvXXXXXXXXXXXXXVU3ZA2-1"
}

Java

import com.azure.resourcemanager.apimanagement.models.GatewayListTraceContract;

/**
 * Samples for Gateway ListTrace.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementGatewayListTrace.json
     */
    /**
     * Sample code: ApiManagementGatewayListTrace.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementGatewayListTrace(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.gateways().listTraceWithResponse("rg1", "apimService1", "gw1",
            new GatewayListTraceContract().withTraceId("CrDvXXXXXXXXXXXXXVU3ZA2-1"), 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

Python

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_gateway_list_trace.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.gateway.list_trace(
        resource_group_name="rg1",
        service_name="apimService1",
        gateway_id="gw1",
        parameters={"traceId": "CrDvXXXXXXXXXXXXXVU3ZA2-1"},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGatewayListTrace.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

Go

package armapimanagement_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGatewayListTrace.json
func ExampleGatewayClient_ListTrace() {
	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)
	}
	res, err := clientFactory.NewGatewayClient().ListTrace(ctx, "rg1", "apimService1", "gw1", armapimanagement.GatewayListTraceContract{
		TraceID: to.Ptr("CrDvXXXXXXXXXXXXXVU3ZA2-1"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Value = map[string]any{
	// 	"serviceName": "apimService1",
	// 	"traceEntries": map[string]any{
	// 		"inbound":[]any{
	// 			map[string]any{
	// 				"data":map[string]any{
	// 					"request":map[string]any{
	// 						"method": "GET",
	// 						"headers":[]any{
	// 							map[string]any{
	// 								"name": "Host",
	// 								"value": "proxy.msitesting.net",
	// 							},
	// 						},
	// 						"url": "https://proxy.msitesting.net/6452XXXXXXXXXXXX9c2facb1/64524dXXXXXXXXXXXX2facb3?subscription-key=117313e70XXXXXXXXXXXX38ba4658ca3",
	// 					},
	// 				},
	// 				"elapsed": "00:00:00.2983315",
	// 				"source": "api-inspector",
	// 				"timestamp": "2023-05-03T12:03:04.6899436Z",
	// 			},
	// 			map[string]any{
	// 				"data":map[string]any{
	// 					"configuration":map[string]any{
	// 						"api":map[string]any{
	// 							"from": "/6452XXXXXXXXXXXX9c2facb1",
	// 							"revision": "1",
	// 							"to":map[string]any{
	// 								"path": "/",
	// 								"host": "msitesting.net",
	// 								"isDefaultPort": true,
	// 								"port": float64(80),
	// 								"query":map[string]any{
	// 								},
	// 								"queryString": "",
	// 								"scheme": "http",
	// 							},
	// 							"version": nil,
	// 						},
	// 						"operation":map[string]any{
	// 							"method": "GET",
	// 							"uriTemplate": "/64524dXXXXXXXXXXXX2facb3",
	// 						},
	// 						"product": "-",
	// 						"user": "-",
	// 					},
	// 				},
	// 				"elapsed": "00:00:00.3046329",
	// 				"source": "api-inspector",
	// 				"timestamp": "2023-05-03T12:03:04.6969650Z",
	// 			},
	// 			map[string]any{
	// 				"data": "Origin header was missing or empty and the request was classified as not cross-domain. CORS policy was not applied.",
	// 				"elapsed": "00:00:00.5972352",
	// 				"source": "cors",
	// 				"timestamp": "2023-05-03T12:03:04.9901631Z",
	// 			},
	// 			map[string]any{
	// 				"data":map[string]any{
	// 					"message":[]any{
	// 						"Response status code was set to 200",
	// 						"Response status reason was set to 'OK'",
	// 					},
	// 				},
	// 				"elapsed": "00:00:00.6107970",
	// 				"source": "set-status",
	// 				"timestamp": "2023-05-03T12:03:05.0031202Z",
	// 			},
	// 			map[string]any{
	// 				"data":map[string]any{
	// 					"message": "Return response was applied",
	// 					"response":map[string]any{
	// 						"headers":[]any{
	// 						},
	// 						"status":map[string]any{
	// 							"code": "OK",
	// 							"reason": "OK",
	// 						},
	// 					},
	// 				},
	// 				"elapsed": "00:00:00.6164228",
	// 				"source": "return-response",
	// 				"timestamp": "2023-05-03T12:03:05.0086543Z",
	// 			},
	// 		},
	// 		"outbound":[]any{
	// 			map[string]any{
	// 				"data":map[string]any{
	// 					"message": "Response has been sent to the caller in full",
	// 				},
	// 				"elapsed": "00:00:00.6510195",
	// 				"source": "transfer-response",
	// 				"timestamp": "2023-05-03T12:03:05.0438287Z",
	// 			},
	// 		},
	// 	},
	// 	"traceId": "1e0447d4-XXXX-XXXX-XXXX-dbdb8098a0d3",
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Fetches trace collected by gateway.
 *
 * @summary Fetches trace collected by gateway.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGatewayListTrace.json
 */
async function apiManagementGatewayListTrace() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const gatewayId = "gw1";
  const parameters = {
    traceId: "CrDvXXXXXXXXXXXXXVU3ZA2-1",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.gateway.listTrace(
    resourceGroupName,
    serviceName,
    gatewayId,
    parameters,
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGatewayListTrace.json
// this example is just showing the usage of "Gateway_ListTrace" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementGatewayResource created on azure
// for more information of creating ApiManagementGatewayResource, please refer to the document of ApiManagementGatewayResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string gatewayId = "gw1";
ResourceIdentifier apiManagementGatewayResourceId = ApiManagementGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, gatewayId);
ApiManagementGatewayResource apiManagementGateway = client.GetApiManagementGatewayResource(apiManagementGatewayResourceId);

// invoke the operation
GatewayListTraceContract gatewayListTraceContract = new GatewayListTraceContract
{
    TraceId = "CrDvXXXXXXXXXXXXXVU3ZA2-1",
};
Response<IReadOnlyDictionary<string, BinaryData>> response = await apiManagementGateway.GetTraceAsync(gatewayListTraceContract);
IReadOnlyDictionary<string, BinaryData> result = response.Value;

Console.WriteLine($"Succeeded: {result}");

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

샘플 응답

상태 코드:

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"
        }
      }
    ]
  }
}

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
GatewayListTraceContract	추적 속성을 나열합니다.
GatewayTraceContract	게이트웨이에서 수집된 추적입니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

GatewayListTraceContract

Object

추적 속성을 나열합니다.

Name	형식	Description
traceId	string	추적 ID입니다.

GatewayTraceContract

Object

게이트웨이에서 수집된 추적입니다.