Página inicial do Docs → MongoDB Ops Manager
Listar todas as tarefas de host em um projeto
Nesta página
Recupera todas as atribuições de host para um projeto.
Funções obrigatórias
Sua chave de API deve ter a função Global Owner
para chamar esse recurso com êxito.
Solicitar
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /usage/groups/{groupId}/hosts
Parâmetros do caminho da solicitação
O Ops Manager requer todos os parâmetros de caminho:
parâmetro de caminho | Tipo | Descrição |
---|---|---|
groupId | string | Identificador único do projeto associado aos hosts desejados. |
Solicitar parâmetros de query
Nome | Tipo | necessidade | Descrição | default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | boleano | Opcional | Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato. | false | ||||||
envelope | boleano | Opcional | Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes da 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:
| false |
Parâmetro de query | Tipo | necessidade | Descrição | default |
---|---|---|---|---|
startDate | string | Obrigatório | Data em ISO 8601 formato de data em que a lista de atribuições de host começa. | |
endDate | string | Obrigatório | Data em ISO 8601 formato de data em que a lista de atribuições de host termina. | |
pageNum | inteiro | Obrigatório | Iniciando grupo de atribuições de host para retornar. O tamanho do grupo é definido em itemsPerPage. Esse valor começa com 1. | |
itemsPerPage | inteiro | Obrigatório | Número de atribuições de host para retornar em um grupo. | 100 |
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Elemento de resposta | Tipo | Descrição |
---|---|---|
hosts | array de strings | Lista de hosts virtuais vinculados ao host físico fornecido. |
hosts .groupId | string | Identificador único do projeto no qual o Ops Manager coloca esse host virtual. |
hosts .hostname | string | FQDN do host virtual vinculado ao host físico. |
processos, | Array de objetos | Processos do MongoDB em execução no host virtual. |
processos, .[n].cluster | objeto | Nome do cluster ao qual pertence o processo MongoDB. |
processos, .[n].groupName | string | Nome do projeto ao qual pertence o processo MongoDB. |
processos, .[n].orgName | string | Nome da organização à qual pertence o processo MongoDB. |
processos, .[n].groupId | string | Identificador único do projeto ao qual pertence o processo MongoDB. |
processos, .[n].hasConflictingServerType | Boolean | Sinalizador que indica se o nó tem um tipo de servidor diferente dos outros nós. |
processos, .[n].name | string | Nome do nó que hospeda o processo do MongoDB. |
processos, .[n].processType | inteiro | Número que representa o tipo de processo do MongoDB. |
serverType | objeto | Tipo de servidor do host físico. DicaVeja também: |
serverType.name | string | O Ops Manager retorna um dos seguintes valores:
|
serverType.label | string | O Ops Manager retorna um dos seguintes valores:
|
Exemplo de solicitação
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/usage/groups/{groupId}/hosts?startDate=2020-07-23&endDate=2020-07-28&pageNum=1&itemsPerPage=100&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 "links": [{ 3 "rel": "self", 4 "href": "http://usage.example.com/api/public/v1.0/usage/assignments?startDate=2020-07-23&endDate=2020-07-28&pageNum=1&itemsPerPage=100" 5 }], 6 "totalCount": 3, 7 "results": [{ 8 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0", 9 "processes": [{ 10 "cluster": "sdivabux", 11 "groupName": "{projectName}", 12 "orgName": "{orgName}", 13 "groupId": "{groupId}", 14 "hasConflictingServerType": true, 15 "name": "replicaPrimary-0-proc0-run51839", 16 "processType": 7 17 }, 18 { 19 "cluster": "sdivabux", 20 "groupName": "{projectName}", 21 "orgName": "{orgName}", 22 "groupId": "{groupId}", 23 "hasConflictingServerType": true, 24 "name": "replicaPrimary-0-proc1-run51839", 25 "processType": 7 26 } 27 ], 28 "serverType": { 29 "name": "PRODUCTION_SERVER", 30 "label": "Production Server" 31 }, 32 "isChargeable": true, 33 "memSizeMB": 178 34 }, 35 { 36 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1", 37 "processes": [{ 38 "cluster": "sdivabux", 39 "groupName": "{projectName}", 40 "orgName": "{orgName}", 41 "groupId": "{groupId}", 42 "hasConflictingServerType": true, 43 "name": "replicaSecondary-0-proc0-run51839", 44 "processType": 8 45 }, 46 { 47 "cluster": "sdivabux", 48 "groupName": "{projectName}", 49 "orgName": "{orgName}", 50 "groupId": "{groupId}", 51 "hasConflictingServerType": true, 52 "name": "replicaSecondary-0-proc1-run51839", 53 "processType": 8 54 } 55 ], 56 "serverType": { 57 "name": "PRODUCTION_SERVER", 58 "label": "Production Server" 59 }, 60 "isChargeable": true, 61 "memSizeMB": 178 62 }, 63 { 64 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-2", 65 "processes": [{ 66 "cluster": "sdivabux", 67 "groupName": "{projectName}", 68 "orgName": "{orgName}", 69 "groupId": "{groupId}", 70 "hasConflictingServerType": true, 71 "name": "replicaSecondary-0-proc1-run51839", 72 "processType": 8 73 }, 74 { 75 "cluster": "sdivabux", 76 "groupName": "{projectName}", 77 "orgName": "{orgName}", 78 "groupId": "{groupId}", 79 "hasConflictingServerType": true, 80 "name": "replicaSecondary-0-proc0-run51839", 81 "processType": 8 82 } 83 ], 84 "serverType": { 85 "name": "RAM_POOL", 86 "label": "RAM Pool" 87 }, 88 "isChargeable": true, 89 "memSizeMB": 178 90 } 91 ] 92 }