URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /orgs
Request Parameters
Parámetros de la ruta de solicitud
Este punto final no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Descripción | predeterminado |
|---|---|---|---|
| entero | Número de página (basado en 1). |
|
| entero | Número de artículos a devolver por página, hasta un máximo de 500. |
|
| booleano | Muestra la respuesta en un impresión bonita formato. |
|
| booleano | Especifica si se debe envolver o no la respuesta en un sobre. |
|
| string | Filtra los resultados según el nombre de la organización especificada. Realiza una búsqueda sin distinción entre mayúsculas y minúsculas de las organizaciones que coinciden exactamente con el Por ejemplo, si especifica un parámetro de consulta | Ninguno |
| booleano | Bandera que indica si el cuerpo de la respuesta contiene organizaciones eliminadas. Ops Manager respeta el valor de este parámetro solo si el usuario que realiza la solicitud tiene un rol global. Si se establece en |
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Documento de respuesta
La respuesta El documentoJSON 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 |
|---|---|---|
| arreglo | La matriz incluye un objeto para cada elemento detallado en la |
| 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. |
| 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. |
results Documento incrustado
Cada resultado es una organización.
Nombre | Tipo | Descripción |
|---|---|---|
ID. | string | Identificador único de la organización. |
está eliminado | booleano | Bandera que indica si la organización está eliminada. |
Nombre | string | Nombre de la organización. |
enlaces | matriz de objetos | Uno o más enlaces a subrecursos o recursos relacionados. Todas las |
Ejemplo de solicitud
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://{OPSMANAGER-HOST}/api/public/v1.0/orgs/"
Ejemplo de respuesta
Encabezado de respuesta
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
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}
Cuerpo de respuesta
{ "links" : [{ "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs", "rel" : "self" }], "results" : [{ "id" : "5a2add1cfd9f3cfb17053317", "isDeleted": false, "links": [{ "href": "https://cloud.mongodb.com/api/public/v1.0/orgs/5a2add1cfd9f3cfb17053317", "rel": "self" }], "name" : "Internal Application Support" }, { "id" : "5a2add1cfd9f3cfb17053318", "isDeleted": false, "links": [{ "href": "https://cloud.mongodb.com/api/public/v1.0/orgs/5a2add1cfd9f3cfb17053318", "rel": "self" }], "name" : "Customer Application Support" }, { "id" : "5a2add1cfd9f3cfb17053319", "isDeleted": false, "links": [{ "href": "https://cloud.mongodb.com/api/public/v1.0/orgs/5a2add1cfd9f3cfb17053319", "rel": "self" }], "name" : "Research and Development" } ], "totalCount" : 3 }