プロジェクトトレースエクスポート構成の設定

PUT /api/v1/projects/{id}/tace-export/config

プロジェクトレベルの TLS トレースエクスポート設定を保存します。認証シークレットは参照のみに使用されます (headers_secret_ref)。未加工の値は受け入れも保存もされません。生成カウンターをアップグレードし、下流への配信に対して保留中の構成をマークします。プロジェクトスコープは ルート ID パス パラメーターによって保持され、 組織はそのプロジェクトから派生します。

path パラメータ

  • id string 必須

    プロジェクトID

application/ JSON

body 必須

型指定されたJSON構成

  • content_mode string

    [ContentMode] では スパン コンテンツリダクションが選択されます。空の場合は metadata_only を意味します。

    値は metadata_only または full です。

  • Egress_mode string

    EgressMode は、範囲が配信される場所を選択します。空の場合はプラットフォームのみを意味します。

    値は platform_only、platform_and_customer_mirror、または customer_only です。

  • enabled ブール値 必須

    有効になっている場合はポインターであるため、ハンドラーは省略フィールド(nil、拒否)と明示的な false(エクスポートを無効にするリクエスト)を区別できます。

  • エンドポイント string

    エンドポイントは、カスタマーの TLS/ HTTPエンドポイントです。有効にする場合は必須です。 https である必要があり、内部アドレスまたはループバック アドレスを点はなりません(「 検証 」を参照してください)。

    最大長は 2048 です。

  • ヘッダー オブジェクト

    ヘッダーは、事前設定された必要のある非 SECRET エクスポート ヘッダーを保持します(例: ワークスペース ID)。秘密値はここに配置しないでください。 HeadersSecretRef を使用します。

    ヘッダー属性を非表示 ヘッダー属性を表示 オブジェクト
    • * string additionalProperties
  • headers_secret_ref string

    HeadersSecretRef は、保存された単一の認証シークレット(通常はAPIキー)へのポインターです。これは参照であり、シークレット値ではありません。呼び出し元のプロジェクトにスコープを設定する必要があります(「 検証 」を参照してください)。

    最大長は 512 です。

  • insecure_skip_verify ブール値

    InsecureSskipVerify はカスタマーエンドポイントの TLS 検証を無効にします。ポインターソース(デフォルトの)は、明示的なオプトアウトとは異なります。 UIは、セキュリティの意図的な削減としてこれを有効にします。

  • プロトコル string

    プロトコルは、アウトバウンド TLPプロトコルです。 v1 は http/protobuf のみをサポートします。

    値は http/protobuf です。

  • resource_attributes オブジェクト

    ResourceAttributes は、カスタマーエンドポイントに送信されるすべての範囲にスタンプされる追加の TLSリソース属性(例: ターゲットが必要なプロジェクトやモデル識別子)です。特定の宛先で必要とされるキーは、そのプリセットから取得されます( pkg/trateconfig/presets を参照)。値は常にカスタマーから提供されます。これは、通常、このプラットフォームでは検索方法がない宛先の独自のプロジェクトに名前を付けるためです。

    resource_attributes 属性を非表示 resource_attributes 属性の表示 オブジェクト
    • * string additionalProperties
  • サンプリング_ポリシー オブジェクト

    SampingPolicy は、エクスポートする前に適用されるヘッドサンプルを選択します。

    サンプリング_ポリシー属性を非表示にする サンプリング_ポリシー属性の表示 オブジェクト
    • 比率 数値

      比率は、サンプリング確率(0..1)です。は必須であり、Type が 比率の場合にのみ使用されます。

      最小値は 0、最大値は 1 です。

    • タイプ string

      タイプは、 exists_on、例: では、比率、親_ベースのいずれかです。

      値は、always_on、always_off、ratio、または parent_based です。

  • secret_header_name string

    SecretheaderName は、参照先のシークレットの値が として送信されるヘッダー名(例: "api_key")で、プリセットの secret_header_keys から取得されるか、カスタム宛先のユーザーが入力します。プラットフォームは、アウトバウンド ": " を構成します。指定します。そのため、保存されたシークレットは常に最低値(事前にフォーマットされたヘッダー行ではない)になります。 HeadersSecretRef が設定されている場合に必要です(「 検証 」を参照)。

    最大長は 128 です。

応答

  • サポートされていないAPIバージョンまたは不正な API バージョン、選択した公開契約で利用できない操作、または受け入れができない表現(サポートされていないメディアタイプのパラメーター、または除外された SSE を含む)。既存の認証、認可、およびレート制限の失敗が優先されます。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        検証に失敗したフィールド。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        検証に失敗したフィールド。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。

  • 200

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • 生成 integer
    • Updated_at string
    応答属性の非表示 応答属性の表示 オブジェクト
    • 生成 integer
    • Updated_at string
  • 400

    Invalid config

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 401

    認証情報が欠落しているか無効である

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 403

    呼び出し元にはプロジェクト所有者の権限がありません

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 413

    構成が 16 KB を超えています

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
PUT /api/v1 /projects/{id}/tace-export/config
curl \
 --request PUT 'https://agentengine.mongodb.com/api/v1/projects/{id}/trace-export/config' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "content_mode": "metadata_only",
  "egress_mode": "platform_only",
  "enabled": true,
  "endpoint": "string",
  "headers": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "headers_secret_ref": "string",
  "insecure_skip_verify": true,
  "protocol": "http/protobuf",
  "resource_attributes": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "sampling_policy": {
    "ratio": 42.0,
    "type": "always_on"
  },
  "secret_header_name": "string"
}'
リクエスト例
{
  "content_mode": "metadata_only",
  "egress_mode": "platform_only",
  "enabled": true,
  "endpoint": "string",
  "headers": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "headers_secret_ref": "string",
  "insecure_skip_verify": true,
  "protocol": "http/protobuf",
  "resource_attributes": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "sampling_policy": {
    "ratio": 42.0,
    "type": "always_on"
  },
  "secret_header_name": "string"
}
応答の例(406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
応答の例(406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
応答の例(200)
{
  "generation": 42,
  "updated_at": "string"
}
応答の例(200)
{
  "generation": 42,
  "updated_at": "string"
}
応答の例(400)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(400)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(401)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(401)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(403)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(403)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(413)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(413)
{
  "code": "string",
  "error": "string",
  "success": true
}