Obtenha detalhes de todos os clusters em todos os projetos disponÃveis para a chave de API programática que faz a solicitação.
Funções obrigatórias
Você pode chamar esse endpoint com sucesso com qualquer função atribuÃda.
Solicitar
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /api/public/v1.0/clustersParâ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âmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Parâmetros de resposta
documento de resposta
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 |
|---|---|---|
| array | A array inclui um objeto para cada item detalhado na seção |
| 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. |
| 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. |
results documento incorporado
Cada resultado é um projeto.
Nome | Tipo | Descrição |
|---|---|---|
| Array de objetos | Objetos que descrevem os clusters em cada projeto que a chave de API está autorizada a visualizar. |
| inteiro | Número de alertas abertos. |
| booleano | Especifica se a autenticação é necessária para acessar os nós no cluster. |
| string | Disponibilidade do cluster. Os valores incluem:
|
| booleano | Especifica se o backup está habilitado para o cluster. |
| string | Identificador único do cluster do MongoDB Ops Manager . |
| número | Tamanho total dos dados armazenados em cada nó no cluster em bytes. |
| string | Nome do cluster conforme aparece no MongoDB Ops Manager. |
| inteiro | Número de nós no cluster. |
| booleano | Especifica se a autenticação SSL é necessária para acessar os nós no cluster. |
| string | O tipo de MongoDB cluster. Os valores incluem:
|
| array de strings | Versão do MongoDB que cada nó do cluster está executando. |
| string | Identificador único do projeto. |
| string | Nome do projeto ao qual pertencem os clusters retornados. |
| string | Identificador único da organização que possui o projeto ao qual pertencem os clusters retornados. |
| string | Nome da organização que possui o projeto ao qual pertencem os clusters retornados. |
| string | Tipo de plano. No MongoDB Ops Manager, esse valor é sempre MongoDB Ops Manager. |
| array de strings | Marcações aplicadas ao projeto. |
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/clusters?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": [ { "href": "https://example.com:8080/api/public/v1.0/clusters", "rel": "self" } ], "results": [ { "clusters": [ { "alertCount": 0, "authEnabled": true, "availability": "available", "backupEnabled": false, "clusterId": "5e6bc0352e41683c191c8956", "dataSizeBytes": 0, "name": "Cluster1", "nodeCount": 3, "sslEnabled": true, "type": "replica set", "versions": [ "4.2.3" ] }, { "alertCount": 0, "authEnabled": true, "availability": "available", "backupEnabled": false, "clusterId": "5e6bc60ba4c3f47a54d8fe95", "dataSizeBytes": 0, "name": "Cluster2", "nodeCount": 3, "sslEnabled": true, "type": "replica set", "versions": [ "4.2.3" ] } ], "groupId": "5df90932f10fab675508b0e5", "groupName": "az", "orgId": "5df7a168f10fab3a149357fb", "orgName": "jww-12-16", "planType": "Ops Manager", "tags": [
] }, { "clusters": [ { "alertCount": 0, "authEnabled": true, "availability": "available", "backupEnabled": false, "clusterId": "5e6bbf6a9de0d35b1527dd93", "dataSizeBytes": 0, "name": "Cluster0", "nodeCount": 3, "sslEnabled": true, "type": "replica set", "versions": [ "4.2.3" ] } ], "groupId": "5df90590f10fab5e33de2305", "groupName": "jww-12-17", "orgId": "5df7a168f10fab3a149357fb", "orgName": "jww-12-16", "planType": "Ops Manager", "tags": [
] }, { "clusters": [ { "alertCount": 0, "authEnabled": true, "availability": "dead", "backupEnabled": false, "clusterId": "5e6be93fd434591c4ca765f6", "dataSizeBytes": 0, "name": "Cluster0", "nodeCount": 0, "sslEnabled": true, "type": "replica set", "versions": [ "4.2.3" ] } ], "groupId": "5df90923f10fab675508b065", "groupName": "gcp", "orgId": "5df7a168f10fab3a149357fb", "orgName": "jww-12-16", "planType": "Ops Manager", "tags": [
] } ], "totalCount": 3}