/ /

API de administración

Más recursos de la API

Docs Home

Gestión

APIs

API de administración

Más recursos de la API

Devolver las sesiones más recientes para Prometheus

Nota

Grupos y proyectos son términos sinónimos. Tu {GROUP-ID} es el mismo que tu ID del grupo. Para los grupos existentes, tu ID de grupo/ID del grupo sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término groups.

https://cloud.mongodb.com/prometheus/v1.0

Sintaxis

GET /groups/{GROUP-ID}/discovery

Parámetros de ruta de solicitud

Parameter	Obligatorio/Opcional	Descripción
`{GROUP-ID}`	Requerido	Identificador del proyecto.

Parámetros de Solicitud Query

Nombre	Tipo	Necesidad	Descripción	predeterminado
esquema objetivo	TargetScheme	Opcional	Tipo de objetivos a devolver. Los valores incluyen: `PUBLIC`: Destinos accesibles por Internet público. `PRIVATE`: IP privada para destinos compatibles con el emparejamiento de VPC.	`PUBLIC`

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Documento de respuesta

El JSON documento de respuesta incluye un arreglo de tus últimos objetivos de los cuales extraer información y un documento que contiene sus etiquetas.

Nombre	Tipo	Descripción
`targets`	Arreglo de objetos	Cada `host` y `port` desde los cuales extraer métricas.
`labels`	Documento	Documento que contiene la etiqueta y el valor que diferencian sus métricas.

etiquetas Documento incrustado

Etiqueta	Descripción
`availability_zone`	ID de AWS para la zona de disponibilidad, nombre completamente calificado de Google Cloud para una zona, o número de zona de Azure. Azure solo admite zonas de disponibilidad en un subconjunto de regiones. Atlas proporciona etiquetas predefinidas de zonas de disponibilidad para Azure solo en regiones que admiten zonas de disponibilidad. Para aprender más, consulta Microsoft Azure. Para obtener más información sobre los posibles valores de `availabilityZone` para cada proveedor de nube, consulte la documentación de AWS, GCP o Azure.
`cl_name`	Etiqueta que identifica de manera única el clúster.
`group_id`	String única de dígitos hexadecimales que identifica el proyecto.
`group_name`	Etiqueta que identifica de forma única el proyecto.
`node_type`	Tipo de nodo. Los valores posibles son `ELECTABLE`, `READ_ONLY` y `ANALYTICS`. Para obtener más información, consulte Tipos de nodos.
`org_id`	String única de dígitos hexadecimales que identifica a la organización.
`provider`	Proveedor de nube en el cual se aprovisiona el nodo. Los valores posibles son `AWS`, `GCP` y `AZURE`.
`region`	Región de la nube en la que reside el nodo. Para obtener una lista completa de los posibles valores `region`, consulte la página de referencia de AWS, GCP o Azure.
`replica_set_name`	Etiqueta que identifica de forma única el set de réplicas.

Solicitud de ejemplo

curl --header 'Accept: application/json'
# Sets the `Authorization` header on every scrape request with the
# configured username and password.
--user prom_user_618d48e05277a606ed2496fe:fSIMUngfTmOTVEB4
# The URL that Prometheus fetches the targets from.
--request GET "https://cloud.mongodb.com/prometheus/v1.0/groups/673f4ae24759b47bdd3a2e90/discovery"

Respuesta de ejemplo

1 [
2   {
3     "labels": {
4       "availability_zone": "use1-az4",
5       "cl_name": "Cluster012",
6       "group_id": "673f4ae24759b47bdd3a2e90",
7       "node_type": "ELECTABLE",
8       "org_id": "673cad5b6b921181d015e1de",
9       "provider": "AWS",
10       "region": "us-east-1"
11     },
12     "targets": [
13       "cluster012-shard-00-00.rffkz.mongodb-dev.net:27018"
14     ]
15   },
16   {
17     "labels": {
18       "availability_zone": "use1-az6",
19       "cl_name": "Cluster012",
20       "group_id": "673f4ae24759b47bdd3a2e90",
21       "node_type": "ELECTABLE",
22       "org_id": "673cad5b6b921181d015e1de",
23       "provider": "AWS",
24       "region": "us-east-1"
25       },
26     "targets": [
27       "cluster012-shard-00-01.rffkz.mongodb-dev.net:27018"
28     ]
29   },
30   {
31     "labels": {
32       "availability_zone": "use1-az1",
33       "cl_name": "Cluster012",
34       "group_id": "673f4ae24759b47bdd3a2e90",
35       "node_type": "ELECTABLE",
36       "org_id": "673cad5b6b921181d015e1de",
37       "provider": "AWS",
38       "region": "us-east-1"
39     },
40     "targets": [
41       "cluster012-shard-00-02.rffkz.mongodb-dev.net:27018"
42     ]
43   }
44 ]

Volver

Más recursos de la API

Acciones de rol personalizadas

1	[
2	{
3	"labels": {
4	"availability_zone": "use1-az4",
5	"cl_name": "Cluster012",
6	"group_id": "673f4ae24759b47bdd3a2e90",
7	"node_type": "ELECTABLE",
8	"org_id": "673cad5b6b921181d015e1de",
9	"provider": "AWS",
10	"region": "us-east-1"
11	},
12	"targets": [
13	"cluster012-shard-00-00.rffkz.mongodb-dev.net:27018"
14	]
15	},
16	{
17	"labels": {
18	"availability_zone": "use1-az6",
19	"cl_name": "Cluster012",
20	"group_id": "673f4ae24759b47bdd3a2e90",
21	"node_type": "ELECTABLE",
22	"org_id": "673cad5b6b921181d015e1de",
23	"provider": "AWS",
24	"region": "us-east-1"
25	},
26	"targets": [
27	"cluster012-shard-00-01.rffkz.mongodb-dev.net:27018"
28	]
29	},
30	{
31	"labels": {
32	"availability_zone": "use1-az1",
33	"cl_name": "Cluster012",
34	"group_id": "673f4ae24759b47bdd3a2e90",
35	"node_type": "ELECTABLE",
36	"org_id": "673cad5b6b921181d015e1de",
37	"provider": "AWS",
38	"region": "us-east-1"
39	},
40	"targets": [
41	"cluster012-shard-00-02.rffkz.mongodb-dev.net:27018"
42	]
43	}
44	]