Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.
Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
MongoDB Branding Shape
Click Here!
Docs Menu

Obtener todas las claves API globales

Devuelve todas las claves API globales para Ops Manager.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /admin/apiKeys

Requiere que la clave de API que llama a este endpoint tenga el rol de Global Read Only.

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

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.

1

elementosPorPágina

Número

Opcional

Número de elementos a devolver por página, hasta un máximo de 500.

100

bonito

booleano

Opcional

Indicador que señala si el cuerpo de la respuesta debe estar en formato prettyprint.

false

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 ni al código de estado. Para corregir esto, establezca envelope : true en la query.

Para los endpoints que devuelven una lista de resultados, el objeto content es un sobre. Ops Manager agrega el campo status al cuerpo de la respuesta.

false

El JSON documento de respuesta incluye un arreglo de objetos result, un arreglo de objetos link y un recuento del número total de objetos result recuperados.

Nombre
Tipo
Descripción

results

arreglo

El arreglo incluye un objeto para cada elemento detallado en la sección del results documento incrustado.

links

arreglo

El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web.

totalCount

Número

Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado.

Cada resultado es una clave de API.

Nombre
Tipo
Descripción

desc

string

Descripción de esta clave API global.

id

string

Identificador único para esta clave de API global.

links

string

Un arreglo de documentos que representa un vínculo a uno o más subrecursos o recursos relacionados como paginación de lista. Consulte Vinculación para obtener más información.

privateKey

string

llave privada redactada para esta clave global API.

publicKey

string

Clave pública para esta clave API global.

roles

objeto arreglo

Roles que tiene esta clave API global. Este arreglo devuelve todos los roles Globales que el usuario tiene en Ops Manager.

roles.roleName

string

Nombre del rol. Este recurso devuelve todos los roles que el usuario tiene en Ops Manager. Los valores posibles son:

Nota

El usuario que realiza la solicitud puede formatearse como {PUBLIC-KEY}:{PRIVATE-KEY}.

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --include \
4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true"
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
1{
2 "links" : [ {
3 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4 "rel" : "self"
5 } ],
6 "results" : [ {
7 "desc" : "Test Global API Key 1",
8 "id" : "5d669ce780eef52a42cf0e1e",
9 "links" : [ {
10 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e",
11 "rel" : "self"
12 } ],
13 "privateKey" : "********-****-****-54d9792d337d",
14 "publicKey" : "zrefxaep",
15 "roles" : [ {
16 "roleName" : "GLOBAL_READ_ONLY"
17 }, {
18 "roleName" : "GLOBAL_BILLING_ADMIN"
19 } ]
20 }, {
21 "desc" : "Test Global API Key 2",
22 "id" : "5d6fec4180eef54728814b14",
23 "links" : [ {
24 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fec4180eef54728814b14",
25 "rel" : "self"
26 } ],
27 "privateKey" : "********-****-****-fe646723a586",
28 "publicKey" : "qlgofmne",
29 "roles" : [ {
30 "roleName" : "GLOBAL_READ_ONLY"
31 } ]
32 }, {
33 "desc" : "Test Global API Key 3",
34 "id" : "5d6fecfc80eef547288207f3",
35 "links" : [ {
36 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fecfc80eef547288207f3",
37 "rel" : "self"
38 } ],
39 "privateKey" : "********-****-****-fe348ed1796f",
40 "publicKey" : "cfswjfck",
41 "roles" : [ {
42 "roleName" : "GLOBAL_READ_ONLY"
43 }, {
44 "roleName" : "GLOBAL_BILLING_ADMIN"
45 }, {
46 "roleName" : "GLOBAL_USER_ADMIN"
47 } ]
48 } ],
49 "totalCount" : 3
50}