Obtener la configuración de exportación de rastreo del proyecto

OBTENER /api/v1/projects/{id}/trace-export/config

Devuelve la configuración actual de exportación de trazas OTLP a nivel de proyecto. El secreto de autenticación se devuelve solo por referencia (headers_secret_ref); el valor sin procesar nunca se devuelve. El ámbito del proyecto se define mediante el parámetro de ruta del ID de ruta y la organización se deriva de dicho proyecto.

Parámetros de path

ID string Requerido

ID del proyecto

Respuestas

406

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

Versión de API no compatible o con formato incorrecto, operación no disponible en el contrato publicado seleccionado o representación inaceptable (incluidos parámetros de tipo de medio no compatibles o SSE excluidos). Los fallos de autenticación, autorización y límite de velocidad existentes tienen prioridad.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Campos con errores de validación.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Un campo y su fallo de validación.
  
  Descripción string Requerido
  
  Fallo en la validación legible para humanos.
  
  Campo string Requerido
  
  Nombre o ruta del campo de solicitud no válido.
- detalle string Requerido
  
  Detalles de errores legibles para humanos.
- Error entero Requerido
  
  HTTP status code.
- errorCode string Requerido
  
  Código de error legible por máquina.
- Parámetros array[string]
  
  Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.
- motivo string Requerido
  
  Frase que indica el motivo del estado HTTP.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Campos con errores de validación.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Un campo y su fallo de validación.
  
  Descripción string Requerido
  
  Fallo en la validación legible para humanos.
  
  Campo string Requerido
  
  Nombre o ruta del campo de solicitud no válido.
- detalle string Requerido
  
  Detalles de errores legibles para humanos.
- Error entero Requerido
  
  HTTP status code.
- errorCode string Requerido
  
  Código de error legible por máquina.
- Parámetros array[string]
  
  Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.
- motivo string Requerido
  
  Frase que indica el motivo del estado HTTP.
200

aplicación/vnd.agent-engine-2026-09-20-preview+json

aplicación/vnd.agent-engine-2026-09-20-preview+json application/json

OK
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- config Objeto
  
  Ocultar atributos de configuración Show config attributes Objeto
  
  modo_de_contenido string
  
  ContentMode selecciona la censura del contenido del span. Vacío significa metadata_only.
  
  Los valores son metadata_only o full.
  
  modo_de_salida string
  
  EgressMode selecciona dónde se entregan los tramos. Vacío significa platform_only.
  
  Los valores son platform_only, platform_and_customer_mirror o customer_only.
  
  habilitado booleano Requerido
  
  Enabled es un puntero para que el controlador pueda distinguir un campo omitido (nil, rechazado) de un falso explícito (una solicitud válida de "deshabilitar exportación").
  
  endpoint string
  
  El punto final es el punto final OTLP/HTTP del cliente. Es obligatorio cuando está habilitado. Debe ser https y no debe apuntar a una dirección interna/de bucle invertido (ver Validar).
  
  La longitud máxima es 2048.
  
  encabezados Objeto
  
  La columna Headers contiene los encabezados de exportación NO SECRETOS que requiere un preset (por ejemplo, un ID de espacio de trabajo). Los valores secretos nunca deben colocarse aquí; utilice HeadersSecretRef.
  
  Atributo de ocultar encabezados Mostrar atributo de encabezados Objeto
  
  * string Propiedades adicionales
  
  encabezados_secreto_ref string
  
  HeadersSecretRef es un puntero al secreto de autenticación único almacenado (normalmente una clave API). Es una referencia, nunca el valor del secreto. Debe estar limitado al proyecto del llamador (ver Validate).
  
  La longitud máxima es 512.
  
  inseguro_omitir_verificación booleano
  
  InsecureSkipVerify desactiva la verificación TLS del punto final del cliente. Un puntero nulo (verify, el valor predeterminado) es distinto de una exclusión explícita; la interfaz de usuario muestra que habilitar esta opción implica una reducción deliberada de la seguridad.
  
  protocolo string
  
  El protocolo es el protocolo OTLP de salida. v1 solo admite http/protobuf.
  
  El valor es http/protobuf.
  
  resource_attributes Objeto
  
  Los ResourceAttributes son atributos de recursos OTLP adicionales que se añaden a cada segmento enviado al punto final del cliente (por ejemplo, un identificador de proyecto/modelo requerido por el destino). Las claves que requiere un destino determinado provienen de su configuración predefinida (véase pkg/traceexportconfig/presets); los valores siempre los proporciona el cliente, ya que normalmente nombran un proyecto en el propio destino que esta plataforma no puede consultar.
  
  Ocultar atributo resource_attributes Mostrar atributo resource_attributes Objeto
  
  * string Propiedades adicionales
  
  política_de_muestreo Objeto
  
  SamplingPolicy selecciona el muestreador de cabecera que se aplica antes de la exportación.
  
  Ocultar atributos de la política de muestreo Mostrar atributos de la política de muestreo Objeto
  
  ratio Número
  
  La razón es la probabilidad de muestreo (0..1); requerida y utilizada solo cuando el tipo es razón.
  
  El valor mínimo es 0, el valor máximo es 1.
  
  tipo string
  
  El tipo es uno de always_on, always_off, ratio, parent_based.
  
  Los valores son always_on, always_off, ratio o parent_based.
  
  nombre_de_encabezado_secreto string
  
  SecretHeaderName es el nombre del encabezado con el que se envía el valor del secreto referenciado (por ejemplo, "api_key"), tomado de secret_header_keys del preajuste o introducido por el usuario para un destino personalizado. La plataforma compone la línea de encabezado de salida ": ", por lo que el secreto almacenado siempre es el valor sin formato (nunca una línea de encabezado preformateada). Obligatorio cuando se establece HeadersSecretRef (ver Validar).
  
  La longitud máxima es 128.
- Generación entero
- generación_recibida entero
- updated_at string
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- config Objeto
  
  Ocultar atributos de configuración Show config attributes Objeto
  
  modo_de_contenido string
  
  ContentMode selecciona la censura del contenido del span. Vacío significa metadata_only.
  
  Los valores son metadata_only o full.
  
  modo_de_salida string
  
  EgressMode selecciona dónde se entregan los tramos. Vacío significa platform_only.
  
  Los valores son platform_only, platform_and_customer_mirror o customer_only.
  
  habilitado booleano Requerido
  
  Enabled es un puntero para que el controlador pueda distinguir un campo omitido (nil, rechazado) de un falso explícito (una solicitud válida de "deshabilitar exportación").
  
  endpoint string
  
  El punto final es el punto final OTLP/HTTP del cliente. Es obligatorio cuando está habilitado. Debe ser https y no debe apuntar a una dirección interna/de bucle invertido (ver Validar).
  
  La longitud máxima es 2048.
  
  encabezados Objeto
  
  La columna Headers contiene los encabezados de exportación NO SECRETOS que requiere un preset (por ejemplo, un ID de espacio de trabajo). Los valores secretos nunca deben colocarse aquí; utilice HeadersSecretRef.
  
  Atributo de ocultar encabezados Mostrar atributo de encabezados Objeto
  
  * string Propiedades adicionales
  
  encabezados_secreto_ref string
  
  HeadersSecretRef es un puntero al secreto de autenticación único almacenado (normalmente una clave API). Es una referencia, nunca el valor del secreto. Debe estar limitado al proyecto del llamador (ver Validate).
  
  La longitud máxima es 512.
  
  inseguro_omitir_verificación booleano
  
  InsecureSkipVerify desactiva la verificación TLS del punto final del cliente. Un puntero nulo (verify, el valor predeterminado) es distinto de una exclusión explícita; la interfaz de usuario muestra que habilitar esta opción implica una reducción deliberada de la seguridad.
  
  protocolo string
  
  El protocolo es el protocolo OTLP de salida. v1 solo admite http/protobuf.
  
  El valor es http/protobuf.
  
  resource_attributes Objeto
  
  Los ResourceAttributes son atributos de recursos OTLP adicionales que se añaden a cada segmento enviado al punto final del cliente (por ejemplo, un identificador de proyecto/modelo requerido por el destino). Las claves que requiere un destino determinado provienen de su configuración predefinida (véase pkg/traceexportconfig/presets); los valores siempre los proporciona el cliente, ya que normalmente nombran un proyecto en el propio destino que esta plataforma no puede consultar.
  
  Ocultar atributo resource_attributes Mostrar atributo resource_attributes Objeto
  
  * string Propiedades adicionales
  
  política_de_muestreo Objeto
  
  SamplingPolicy selecciona el muestreador de cabecera que se aplica antes de la exportación.
  
  Ocultar atributos de la política de muestreo Mostrar atributos de la política de muestreo Objeto
  
  ratio Número
  
  La razón es la probabilidad de muestreo (0..1); requerida y utilizada solo cuando el tipo es razón.
  
  El valor mínimo es 0, el valor máximo es 1.
  
  tipo string
  
  El tipo es uno de always_on, always_off, ratio, parent_based.
  
  Los valores son always_on, always_off, ratio o parent_based.
  
  nombre_de_encabezado_secreto string
  
  SecretHeaderName es el nombre del encabezado con el que se envía el valor del secreto referenciado (por ejemplo, "api_key"), tomado de secret_header_keys del preajuste o introducido por el usuario para un destino personalizado. La plataforma compone la línea de encabezado de salida ": ", por lo que el secreto almacenado siempre es el valor sin formato (nunca una línea de encabezado preformateada). Obligatorio cuando se establece HeadersSecretRef (ver Validar).
  
  La longitud máxima es 128.
- Generación entero
- generación_recibida entero
- updated_at string
401

aplicación/vnd.agent-engine-2026-09-20-preview+json

aplicación/vnd.agent-engine-2026-09-20-preview+json application/json

Credenciales faltantes o no válidas
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
403

aplicación/vnd.agent-engine-2026-09-20-preview+json

aplicación/vnd.agent-engine-2026-09-20-preview+json application/json

La persona que llama no tiene permiso de lectura.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
404

aplicación/vnd.agent-engine-2026-09-20-preview+json

aplicación/vnd.agent-engine-2026-09-20-preview+json application/json

No se ha almacenado ninguna configuración para el proyecto.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano

GET /api/v1/projects/{id}/trace-export/config

curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/trace-export/config' \
 --header "Authorization: $API_KEY"

Ejemplos de respuesta (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"
}

Ejemplos de respuesta (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"
}

Ejemplos de respuesta (200)

{
  "config": {
    "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"
  },
  "generation": 42,
  "received_generation": 42,
  "updated_at": "string"
}

Ejemplos de respuesta (200)

{
  "config": {
    "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"
  },
  "generation": 42,
  "received_generation": 42,
  "updated_at": "string"
}

Ejemplos de respuesta (401)

{
  "code": "string",
  "error": "string",
  "success": true
}

Ejemplos de respuesta (401)

{
  "code": "string",
  "error": "string",
  "success": true
}

Ejemplos de respuesta (403)

{
  "code": "string",
  "error": "string",
  "success": true
}

Ejemplos de respuesta (403)

{
  "code": "string",
  "error": "string",
  "success": true
}

Ejemplos de respuesta (404)

{
  "code": "string",
  "error": "string",
  "success": true
}

Ejemplos de respuesta (404)

{
  "code": "string",
  "error": "string",
  "success": true
}