Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Obter todos os clusters em um projeto

Recupere detalhes de todos os clusters em um projeto.

Você pode chamar esse endpoint com sucesso com qualquer função atribuída.

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

GET /groups/{PROJECT-ID}/clusters
Nome
Tipo
Descrição

PROJECT-ID

string

Identificador único do projeto.

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default

pageNum

número

Opcional

Um inteiro baseado que retorna uma subseção de resultados.

1

itemsPerPage

número

Opcional

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Opcional

Sinalizador que indica se o corpo da resposta deve estar em um formato de impressão bonita.

false

envelope

booleano

Opcional

Sinalizador que 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 envelope : true na query.

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

false

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

O documento JSON de resposta inclui uma array de objetos de result, uma array de objetos de link e uma contagem do número total de objetos de result recuperados.

Nome
Tipo
Descrição

results

array

A array inclui um objeto para cada item detalhado na seção results Documento incorporado.

links

array

A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.

totalCount

número

Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

Cada resultado é um cluster.

Nome
Tipo
Descrição

clusterName

string

Nome de exibição do cluster. Observe que o mongod em si não permite que você nomeie um cluster; MongoDB Ops Manager fornece este nome e você pode atualizá-lo. Para um conjunto de réplicas em um cluster fragmentado, o nome do cluster é o nome do cluster pai.

groupId

string

Identificador único do projeto ao qual o cluster pertence.

id

string

Identificador único do cluster.

lastHeartbeat

data

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o MongoDB Ops Manager processou mais recentemente um ping deste cluster.

replicaSetName

string

Nome do nome do conjunto. O Ops Manager retorna esse valor quando um cluster tem typeName de REPLICA_SET ou CONFIG_SERVER_REPLICA_SET.

shardName

string

Nome do shard. O Ops Manager retorna esse valor quando um cluster tem typeName de SHARDED ou um REPLICA_SET que faz parte de um cluster fragmentado.

typeName

string

Tipo de cluster. Ops Manager pode retornar:

  • SHARDED: Um cluster fragmentado em que cada shard é uma instância autônomo . Os fragmentos não são conjuntos de réplicas.

  • SHARDED_REPLICA_SET: Um cluster sharded que contém pelo menos um shard que é um conjunto de réplicas.

  • CONFIG_SERVER_REPLICA_SET: Servidores de configuração implantados como um conjunto de réplicas.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters?pretty=true"
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-alive
HTTP/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}
{ "links": [ { "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "clusterName": "myRS", "groupId": "5e84b94c003f2d6370004f4e", "id": "5e8ba20e87d9396ca9b96bd0", "lastHeartbeat": "2020-06-10T14:51:28Z", "links": [ { "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0", "rel": "self" } ], "replicaSetName": "myRS", "typeName": "REPLICA_SET" }, { "clusterName": "cm-clstr-repl", "groupId": "5e84b94c003f2d6370004f4e", "id": "5e84e393395ec72bfc888f6c", "lastHeartbeat": "2020-06-10T15:20:08Z", "links": [ { "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e84e393395ec72bfc888f6c", "rel": "self" } ], "replicaSetName": "cm-clstr-repl", "typeName": "REPLICA_SET" } ], "totalCount": 2}