Crie uma chave de API global para o Ops Manager.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /admin/apiKeysFunções obrigatórias
Exige que a API Key chamando este ponto de extremidade tenha o Global Owner função.
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Este endpoint não usa parâmetros de caminho de solicitação HTTP.
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default |
|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador que indica se o corpo da resposta está em um formato pretty-print. |
|
envelope | booleano | Opcional | Sinalizador que indica se deve envolver a resposta em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
|
|
Parâmetros do corpo da solicitação
Você deve fornecer todos os parâmetros do corpo da solicitação.
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
| string | Obrigatório | Descrição da chave de API global. Deve ter entre 1 e 250 caracteres. |
| array de strings | Obrigatório | Lista de funções que a Chave API Global precisa ter. Se o array
As funções globais aceitas por padrão incluem:
|
Resposta
Nome | Tipo | Descrição |
|---|---|---|
| string | Descrição desta chave de API global. |
| string | Identificador exclusivo para esta chave de API global. |
| string | Um array de documentos que representa um link para um ou mais sub-recursos ou recursos relacionados, como paginação de lista. Consulte Vinculação para obter mais informações. |
| string | Chave privada não editada para esta chave de API global. |
| string | Chave pública para esta chave de API global. |
| array de objetos | Funções que esta chave de API global tem. Essa matriz retorna todos os roles globais que o usuário tem no Ops Manager. |
| string | Nome da função. Esse recurso retorna todos os roles que o usuário tem no Ops Manager. Os valores possÃveis são:
|
Exemplo de solicitação
Observação
O usuário que faz a solicitação pode ser formatado como {PUBLIC-KEY}:{PRIVATE-KEY}.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true" \ --data '{ "desc" : "New API key for Global Testing", "roles" : [ "GLOBAL_READ_ONLY", "GLOBAL_USER_ADMIN" ] }'Exemplo de resposta
Cabeçalho de resposta
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}Corpo de resposta
{ "desc" : "New API key for Global Testing", "id" : "5d669ce780eef52a42cf0e1e", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e", "rel" : "self" } ], "privateKey" : "8d080e57-5fd6-495c-9388-fe348ed1796f", "publicKey" : "cfswjfck", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "roleName" : "GLOBAL_USER_ADMIN" } ]}