Nota
Los términos «grupos» y «proyectos» son sinónimos. Tu {PROJECT-ID} ID de grupo es el mismo que el tuyo. Para los grupos existentes, tu ID de grupo/proyecto permanece igual. En esta página se utiliza el término «grupo», más común, para las descripciones. El punto final se mantiene como se indica en el documento.
URL base: https://cloud.mongodb.com/prometheus/v1.0
Sintaxis
GET /groups/{GROUP-ID}/discovery
Parámetros de ruta de solicitud
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
{ID del proyecto} | string | Requerido | string única de 24 dígitos hexadecimales que identifica tu proyecto. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
Num. de pág. | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
elementosPorPágina | Número | Opcional | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de la respuesta debe estar en formato prettyprint. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP o al código de estado. Para remediarlo, establezca Para los endpoints que devuelven una lista de resultados, el objeto |
|
backupJobsEnabledOnly | booleano | Opcional | Indicador que indica si se deben excluir los demonios que no están habilitados para hacer copias de seguridad de bases de datos de la respuesta. Establece esto en |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Elementos de respuesta
La respuesta incluye un arreglo de tus targets más recientes de los cuales extraer información y un documento que contiene su labels.
Nombre | Tipo | Descripción |
|---|---|---|
objetivos | arreglo | Cada |
etiquetas | Documento | Documento que contiene la etiqueta y el valor que diferencian sus métricas. |
labels.group_id | string | String única de dígitos hexadecimales que identifica el proyecto. |
Nombre del grupo | string | Etiqueta legible por humanos que identifica el proyecto. |
labels.org_id | string | String única de dígitos hexadecimales que identifica a la organización. |
Solicitud de ejemplo
Sets the `Authorization` header on every scrape request with the configured username and password. The URL that Prometheus fetches the targets from. curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/prometheus/v1.0/groups/{PROJECT-ID}/discovery"
Respuesta de ejemplo
[ { "targets":[ "mongodbd-prometheus:9216" ], "labels":{ "group_id":"{PROJECT-ID}", "group_name":"CM-Testing", "org_id":"{ORG-ID}" } } ]