URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /orgs
Request Parameters
Parámetros de la ruta de solicitud
Este endpoint no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Descripción | predeterminado |
|---|---|---|---|
| entero | Número de página (basado en 1). |
|
| entero | Número de elementos a devolver por página, hasta un máximo de 500. |
|
| booleano | Muestra la respuesta en una pretty-print 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 que no distingue entre mayúsculas y minúsculas para organizaciones que coinciden exactamente con el Por ejemplo, si especificas un parámetro de query | 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 configura en |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Documento de respuesta
La respuesta El documento JSON incluye un arreglo de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en la sección del |
| 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. |
| 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. |
results embeddedDocument
Cada resultado corresponde a una organización.
Nombre | Tipo | Descripción |
|---|---|---|
ID | string | Identificador único para la organización. |
isDeleted | booleano | Indica si la organización ha sido eliminada. |
Nombre | string | Nombre de la organización. |
enlaces | objeto arreglo | Uno o más enlaces a subrecursos o recursos relacionados. Todas las |
Solicitud de ejemplo
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://{OPSMANAGER-HOST}/api/public/v1.0/orgs/"
Respuesta de ejemplo
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}
Respuesta del cuerpo
{ "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 }