Docs Menu
Docs Home
/ /
Claves API globales

Obtenga todas las claves API globales

Devolver todo Global ClavesAPI para Ops Manager.

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

GET /admin/apiKeys

Requiere que la clave API que llama a este punto final tenga la Global Read Only role.

Este punto final no utiliza parámetros de ruta de solicitud HTTP.

Los siguientes parámetros de consulta son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

número de página

Número

Opcional

Entero basado en uno que devuelve una subsección de resultados.

1

artículos por página

Número

Opcional

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

100

bonita

booleano

Opcional

false

envolvente

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionarlo, configure envelope : true en la consulta.

Para los puntos finales que devuelven una lista de resultados, el objeto results es un sobre. Ops Manager añade el campo status al cuerpo de la respuesta.

false

trabajos de respaldo habilitados solamente

booleano

Opcional

Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en false para incluir las configuraciones de daemon con el indicador backupJobsEnabled establecido en false.

true

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

Nombre
Tipo
Descripción

results

arreglo

La matriz incluye un objeto para cada elemento detallado en la results sección Documento incrustado.

links

arreglo

La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.

totalCount

Número

Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

Cada resultado es una clave API.

Nombre
Tipo
Descripción

desc

string

Descripción de esta clave API global.

id

string

Identificador único para esta clave API global.

links

string

Una matriz de documentos que representa un enlace a uno o más subrecursos o recursos relacionados, como la paginación de listas. Consulte Enlaces para obtener más información.

privateKey

string

Clave privada redactada para esta clave API global.

publicKey

string

Clave pública para esta clave API global.

roles

matriz de objetos

Roles que tiene esta clave API global. Esta matriz 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:

Valor del rol en la API
rol

GLOBAL_AUTOMATION_ADMIN

GLOBAL_BACKUP_ADMIN

GLOBAL_MONITORING_ADMIN

GLOBAL_OWNER

GLOBAL_READ_ONLY

GLOBAL_USER_ADMIN

Nota

El usuario que realiza la solicitud puede tener el formato {USERNAME}:{APIKEY} o {PUBLIC-KEY}:{PRIVATE-KEY}.

1curl --user "{USERNAME}:{APIKEY}" --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}

Volver

Claves API globales

En esta página