次の方法で共有

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 パラメーター

名前 / 必須 型 説明
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 バージョン。

要求本文

名前 型 説明
traceId

string

トレース ID。

応答

名前 型 説明
200 OK

GatewayTraceContract

応答本文には、ゲートウェイによって収集されたトレースが含まれています。
Other Status Codes

ErrorResponse

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

例

ApiManagementGatewayListTrace

要求のサンプル

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

応答のサンプル

状態コード:
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"
        }
      }
    ]
  }
}

定義

名前 説明
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答
GatewayListTraceContract

トレースのプロパティを一覧表示します。
GatewayTraceContract

ゲートウェイで収集されたトレース。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

GatewayListTraceContract

Object

トレースのプロパティを一覧表示します。

名前 型 説明
traceId

string

トレース ID。

GatewayTraceContract

Object

ゲートウェイで収集されたトレース。