Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos
/
Uso do servidor

Atualizar um host físico

Nesta página

  • Funções obrigatórias
  • Resource
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Funções obrigatórias

Esse recurso exige que achave de API tenha a função Global Owner .

Resource

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

PUT /usage/groups/{physicalHostId}

Parâmetros do caminho da solicitação

O Ops Manager exige todos os parâmetros do caminho da solicitação:

parâmetro de caminho
Tipo
Descrição

flexibleHostId

string

Identificador único do host físico a ser removido.

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 do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure "envelope" : true na consulta.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome
Descrição

status

Código de resposta HTTP

content

Corpo de resposta esperado

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Ops Manager adiciona o campo status ao corpo da resposta.

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
.groupId

string

Opcional

Identificador único do projeto no qual o Ops Manager coloca esse host virtual.

virtualHosts
.hostname

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:

  • DEV_SERVER

  • TEST_SERVER

  • PRODUCTION_SERVER

  • RAM_POOL

Para saber mais, consulte Uso do MongoDB .

Resposta

Elemento de resposta
Tipo
Descrição

hosts

Array de objetos

Lista de hosts virtuais vinculados ao host físico fornecido.

hosts
.[n].groupId

string

Identificador único do projeto no qual o Ops Manager coloca esse host virtual.

hosts
.[n].hostname

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:

  • DEV_SERVER

  • TEST_SERVER

  • production_server

  • RAM_POOL

Para saber mais, consulte Uso do MongoDB .

Exemplo de solicitação

1curl --user "{publicApiKey}:{privateApiKey}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request PUT "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups/{groupId}?pretty=true" \
6     --data '{
7               "name": "physicalHostA",
8               "serverType":
9                 {
10                   "name": "PRODUCTION_SERVER",
11                   "label": "Production Server",
12                 },
13               "virtualHosts": [
14                 {
15                   "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1",
16                   "groupId": "{groupId}"
17                 }
18               ]
19             }'

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 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
HTTP/1.1 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  "hosts": [
3    {
4      "groupId": "{groupId}",
5      "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
6    }
7  ],
8  "id": "{physicalHostID}",
9  "name": "physicalHostA",
10  "serverType":
11    {
12      "name": "PRODUCTION_SERVER",
13      "label": "Production Server",
14    },
15}

Voltar

Criar host físico

Próximo

Remover host físico