Recupera todas as atribuições de host.
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/assignmentsParâmetros do caminho da solicitação
Este endpoint não usa parâmetros de caminho de solicitação HTTP.
Solicitar parâmetros de query
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âmetro de query | Tipo | necessidade | Descrição | Default |
|---|---|---|---|---|
startDate | string | Obrigatório | Data no formato de data ISO 8601 em que a lista de atribuições de hosts é iniciada. | |
endDate | string | Obrigatório | Data no formato de data ISO 8601 em que a lista de atribuições de host termina. | |
pageNum | inteiro | Obrigatório | Iniciando o grupo de atribuições de hosts para retornar. O tamanho do grupo é definido por itemsPerPage. Este valor começa com 1. | |
itemsPerPage | inteiro | Obrigatório | Número de atribuições de host para retornar em um grupo. |
|
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 | string | Identificador único do projeto no qual o Ops Manager coloca esse host virtual. |
hospedar | string | FQDN do host virtual vinculado ao host físico. |
processes | Array de objetos | Processos do MongoDB em execução no host virtual. |
processos | objeto | Nome do cluster ao qual pertence o processo MongoDB. |
processos | string | Nome do projeto ao qual pertence o processo MongoDB. |
processos | string | Nome da organização à qual pertence o processo MongoDB. |
processos | string | Identificador único do projeto ao qual pertence o processo MongoDB. |
processos | Boolean | Sinalizador que indica se o nó tem um tipo de servidor diferente dos outros nós. |
processos | string | Nome do nó que hospeda o processo do MongoDB. |
processos | inteiro | Número que representa o tipo de processo do MongoDB. |
serverType | objeto | Tipo de servidor do host físico. Para saber mais, consulte a página de uso do MongoDB. |
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/assignments?startDate=2020-07-23&endDate=2020-07-28&pageNum=1&itemsPerPage=100&pretty=true'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
{ "links": [{ "rel": "self", "href": "http://usage.example.com/api/public/v1.0/usage/assignments?startDate=2020-07-23&endDate=2020-07-28&pageNum=1&itemsPerPage=100" }], "totalCount": 3, "results": [{ "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0", "processes": [{ "cluster": "sdivabux", "groupName": "{projectName}", "orgName": "{orgName}", "groupId": "{groupId}", "hasConflictingServerType": true, "name": "replicaPrimary-0-proc0-run51839", "processType": 7 }, { "cluster": "sdivabux", "groupName": "{projectName}", "orgName": "{orgName}", "groupId": "{groupId}", "hasConflictingServerType": true, "name": "replicaPrimary-0-proc1-run51839", "processType": 7 } ], "serverType": { "name": "PRODUCTION_SERVER", "label": "Production Server" }, "isChargeable": true, "memSizeMB": 178 }, { "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1", "processes": [{ "cluster": "sdivabux", "groupName": "{projectName}", "orgName": "{orgName}", "groupId": "{groupId}", "hasConflictingServerType": true, "name": "replicaSecondary-0-proc0-run51839", "processType": 8 }, { "cluster": "sdivabux", "groupName": "{projectName}", "orgName": "{orgName}", "groupId": "{groupId}", "hasConflictingServerType": true, "name": "replicaSecondary-0-proc1-run51839", "processType": 8 } ], "serverType": { "name": "PRODUCTION_SERVER", "label": "Production Server" }, "isChargeable": true, "memSizeMB": 178 }, { "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-2", "processes": [{ "cluster": "sdivabux", "groupName": "{projectName}", "orgName": "{orgName}", "groupId": "{groupId}", "hasConflictingServerType": true, "name": "replicaSecondary-0-proc1-run51839", "processType": 8 }, { "cluster": "sdivabux", "groupName": "{projectName}", "orgName": "{orgName}", "groupId": "{groupId}", "hasConflictingServerType": true, "name": "replicaSecondary-0-proc0-run51839", "processType": 8 } ], "serverType": { "name": "RAM_POOL", "label": "RAM Pool" }, "isChargeable": true, "memSizeMB": 178 } ] }