Funções obrigatórias
Este recurso exige que a chave API tenha o papel Global Owner .
Resource
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /usage/groupsParâ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). |
|
itemsPerPage | inteiro | Número de itens a serem devolvidos por página, até um máximo de 500. |
|
pretty | booleano | Indica se o corpo da resposta deve estar em formato prettyprint. |
|
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 |
Parâmetros do corpo da solicitação
Parâmetro do corpo | Tipo | necessidade | Descrição |
|---|---|---|---|
virtualHosts | array de strings | Obrigatório | Lista de hosts virtuais vinculados ao host físico fornecido. |
virtualHosts | string | Opcional | Identificador único do projeto no qual o Ops Manager coloca esse host virtual. |
virtualHosts | string | Opcional | FQDN do host virtual vinculado ao host físico. |
name | string | Obrigatório | Etiqueta que você deu ao host físico. Este valor deve ser único. |
serverType | string | Obrigatório | Tipo de servidor do host físico. Você pode definir isso como um dos seguintes valores:
Para saber mais, consulte a página de uso do MongoDB. |
Resposta
Elemento de resposta | Tipo | Descrição |
|---|---|---|
hosts | Array de objetos | Lista de hosts virtuais vinculados ao host físico fornecido. |
hospedar | 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. |
id | string | Identificador único do host físico ao qual o Ops Manager vinculou os hosts virtuais. |
name | string | Etiqueta que você deu ao host físico. |
serverType | string | Tipo de servidor do host físico. O Ops Manager retorna um dos seguintes valores:
Para saber mais, consulte a página de uso do MongoDB. |
Exemplo de solicitação
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true" \ --data '{ "name": "physicalHostA", "serverType": { "name": "PRODUCTION_SERVER", "label": "Production Server", }, "virtualHosts": [ { "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1", "groupId": "{groupId}" } ] }'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
{ "hosts": [ { "groupId": "{groupId}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1" } ], "id": "{physicalHostID}", "name": "physicalHostA", "serverType": { "name": "PRODUCTION_SERVER", "label": "Production Server", },}