Actualiza los valores de una clave Global API desde Ops Manager utilizando el identificador único para esa Clave.
Para encontrar una clave de API global específica, obtenga la lista de claves de API globales y, a continuación, busque el {API-KEY-ID} que necesita.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /admin/apiKeys/{API-KEY-ID}Roles necesarios
Requiere que la clave de API que llama a este endpoint tenga el rol de Global Owner.
Request Parameters
Parámetros de ruta de solicitud
Todos los parámetros de ruta de la solicitud son obligatorios.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único para la clave Global API que se desea actualizar. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
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 solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Deberás proporcionar uno o ambos de los dos parámetros de cuerpo.
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| string | Condicional | Descripción de la clave. Este parámetro es opcional; sin embargo, la solicitud debe contener un parámetro |
| arreglo de string | Condicional | Lista de roles que la clave de API global necesita tener. Si se proporciona el arreglo
Las funciones globales aceptadas por defecto incluyen:
|
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| string | Descripción de esta clave API global. |
| string | Identificador único para esta clave de API global. |
| 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. |
| string | llave privada redactada para esta clave global API. |
| string | Clave pública para esta clave API global. |
| objeto arreglo | Roles que tiene esta clave API global. Este arreglo devuelve todos los roles Globales que el usuario tiene en Ops Manager. |
| string | Nombre del rol. Este recurso devuelve todos los roles que el usuario tiene en Ops Manager. Los valores posibles son:
|
Solicitud de ejemplo
Nota
El usuario que realiza la solicitud puede formatearse como {PUBLIC-KEY}:{PRIVATE-KEY}.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true" \ --data '{ "desc" : "Updated API key description for test purposes" }'Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
{ "created": "2019-09-04T15:37:40Z", "desc": "Updated API key description for test purposes", "globalRoles": ["GLOBAL_READ_ONLY"], "groupRoles": [], "numGroups": 0, "orgRoles": [], "orgRolesString": "", "privateKey": "********-****-****-cfe60e9f1f72", "userId": "5d6fda44ff4ab7133648a852", "username": "dczverfw"}