URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /orgs/{ORG-ID}
Parámetros de la ruta de solicitud
Elemento de ruta | Tipo | Descripción |
|---|---|---|
ORG-ID | string | (Obligatorio.) El identificador único para el organización cuya información desea recuperar. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|
| booleano | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
| ||||||
| booleano | 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 Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
|
| ||||||
| 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
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}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/"
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
{ "id" : "{ORG-ID}", "isDeleted": false, "links": [{ }], "name" : "Customer Application Support" }