Obter todas as funções para chaves de API globais
Nesta página
Retorne uma lista de roles globais aceitáveis para chaves deAPI globais.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/apiKeys/roles
Funções obrigatórias
Requer que a chave de API que chama esse endpoint tenha a função Global Read Only .
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 | Descrição | Default | ||||
|---|---|---|---|---|---|---|---|
pageNum | inteiro | Número da página (com base em índice 1). | 1 | ||||
itemsPerPage | inteiro | Número de itens a serem devolvidos por página, até um máximo de 500. | 100 | ||||
pretty | booleano | Indica se o corpo da resposta deve estar em um prettyprint formato. | false | ||||
envelope | booleano | Indica se deseja ou não 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, configure Para endpoints que retornam um resultado, o corpo da resposta inclui:
Para endpoints que retornam uma lista de resultados, o objeto | none |
Resposta
Retorna uma matriz de todas as funções globais aceitáveis para as chaves de API globais.
Exemplo de solicitação
Observação
O usuário que faz a solicitação pode ser formatado como {USERNAME}:{APIKEY} ou {PUBLIC-KEY}:{PRIVATE-KEY}.
1 curl --user "{USERNAME}:{APIKEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/roles?pretty=true"
Exemplo de resposta
Cabeçalho de resposta
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}
Corpo de resposta
1 { 2 [ 3 "GLOBAL_BACKUP_ADMIN", 4 "GLOBAL_BILLING_ADMIN", 5 "GLOBAL_MONITORING_ADMIN", 6 "GLOBAL_READ_ONLY", 7 "GLOBAL_AUTOMATION_ADMIN", 8 "GLOBAL_USER_ADMIN" 9 ] 10 }