Obtenha todos os clusters em todos os projetos

Nesta página

Funções obrigatórias

Solicitar
Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Parâmetros de resposta
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

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/clusters

Parâ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 indicando se o corpo da resposta deve estar em um prettyprint formato.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes da 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:

Nome	Descrição
`status`	Código de resposta HTTP
`content`	Corpo de resposta esperado

false

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 result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome	Tipo	Descrição
`results`	array	A array inclui um objeto para cada item detalhado na seção Documento incorporado`results` .
`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.

`results` documento incorporado

Cada resultado é um projeto.

Nome	Tipo	Descrição
`clusters`	Array de objetos	Objetos que descrevem os clusters em cada projeto que a chave de API está autorizada a visualizar.
`clusters.[n].alertCount`	inteiro	Número de alertas abertos.
`clusters.[n].authEnabled`	booleano	Especifica se a autenticação é necessária para acessar os nós no cluster.
`clusters.[n].availability`	string	Disponibilidade do cluster. Os valores incluem: `available`: todos os nós no cluster estão disponíveis. `warning`: alguns nós no cluster estão disponíveis. Pelo menos um nó não está disponível. `unavailable`: o cluster não está disponível. O cluster não tem um nó primário. `dead`: o cluster está inativo.
`clusters.[n].backupEnabled`	booleano	Especifica se o backup está habilitado para o cluster.
`clusters.[n].clusterId`	string	Identificador único do cluster do MongoDB Ops Manager .
`clusters.[n].dataSizeBytes`	número	Tamanho total dos dados armazenados em cada nó no cluster em bytes.
`clusters.[n].name`	string	Nome do cluster conforme aparece no MongoDB Ops Manager.
`clusters.[n].nodeCount`	inteiro	Número de nós no cluster.
`clusters.[n].sslEnabled`	booleano	Especifica se a autenticação SSL é necessária para acessar os nós no cluster.
`clusters.[n].type`	string	O tipo de MongoDB cluster. Os valores incluem: `replica set`: conjunto de réplicas `sharded cluster`: cluster fragmentado `standalone`: standalone
`clusters.[n].versions`	array de strings	Versão do MongoDB que cada nó do cluster está executando.
`groupId`	string	Identificador único do projeto.
`groupName`	string	Nome do projeto ao qual pertencem os clusters retornados.
`orgId`	string	Identificador único da organização que possui o projeto ao qual pertencem os clusters retornados.
`orgName`	string	Nome da organização que possui o projeto ao qual pertencem os clusters retornados.
`planType`	string	Tipo de plano. No MongoDB Ops Manager, esse valor é sempre MongoDB Ops Manager.
`tags`	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 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   "links": [
3     {
4       "href": "https://example.com:8080/api/public/v1.0/clusters",
5       "rel": "self"
6     }
7   ],
8   "results": [
9     {
10       "clusters": [
11         {
12           "alertCount": 0,
13           "authEnabled": true,
14           "availability": "available",
15           "backupEnabled": false,
16           "clusterId": "5e6bc0352e41683c191c8956",
17           "dataSizeBytes": 0,
18           "name": "Cluster1",
19           "nodeCount": 3,
20           "sslEnabled": true,
21           "type": "replica set",
22           "versions": [
23             "4.2.3"
24           ]
25         },
26         {
27           "alertCount": 0,
28           "authEnabled": true,
29           "availability": "available",
30           "backupEnabled": false,
31           "clusterId": "5e6bc60ba4c3f47a54d8fe95",
32           "dataSizeBytes": 0,
33           "name": "Cluster2",
34           "nodeCount": 3,
35           "sslEnabled": true,
36           "type": "replica set",
37           "versions": [
38             "4.2.3"
39           ]
40         }
41       ],
42       "groupId": "5df90932f10fab675508b0e5",
43       "groupName": "az",
44       "orgId": "5df7a168f10fab3a149357fb",
45       "orgName": "jww-12-16",
46       "planType": "Ops Manager",
47       "tags": [
48 
49       ]
50     },
51     {
52       "clusters": [
53         {
54           "alertCount": 0,
55           "authEnabled": true,
56           "availability": "available",
57           "backupEnabled": false,
58           "clusterId": "5e6bbf6a9de0d35b1527dd93",
59           "dataSizeBytes": 0,
60           "name": "Cluster0",
61           "nodeCount": 3,
62           "sslEnabled": true,
63           "type": "replica set",
64           "versions": [
65             "4.2.3"
66           ]
67         }
68       ],
69       "groupId": "5df90590f10fab5e33de2305",
70       "groupName": "jww-12-17",
71       "orgId": "5df7a168f10fab3a149357fb",
72       "orgName": "jww-12-16",
73       "planType": "Ops Manager",
74       "tags": [
75 
76       ]
77     },
78     {
79       "clusters": [
80         {
81           "alertCount": 0,
82           "authEnabled": true,
83           "availability": "dead",
84           "backupEnabled": false,
85           "clusterId": "5e6be93fd434591c4ca765f6",
86           "dataSizeBytes": 0,
87           "name": "Cluster0",
88           "nodeCount": 0,
89           "sslEnabled": true,
90           "type": "replica set",
91           "versions": [
92             "4.2.3"
93           ]
94         }
95       ],
96       "groupId": "5df90923f10fab675508b065",
97       "groupName": "gcp",
98       "orgId": "5df7a168f10fab3a149357fb",
99       "orgName": "jww-12-16",
100       "planType": "Ops Manager",
101       "tags": [
102 
103       ]
104     }
105   ],
106   "totalCount": 3
107 }

Voltar

Clusters

Obter todos os clusters em um projeto

1	{
2	"links": [
3	{
4	"href": "https://example.com:8080/api/public/v1.0/clusters",
5	"rel": "self"
6	}
7	],
8	"results": [
9	{
10	"clusters": [
11	{
12	"alertCount": 0,
13	"authEnabled": true,
14	"availability": "available",
15	"backupEnabled": false,
16	"clusterId": "5e6bc0352e41683c191c8956",
17	"dataSizeBytes": 0,
18	"name": "Cluster1",
19	"nodeCount": 3,
20	"sslEnabled": true,
21	"type": "replica set",
22	"versions": [
23	"4.2.3"
24	]
25	},
26	{
27	"alertCount": 0,
28	"authEnabled": true,
29	"availability": "available",
30	"backupEnabled": false,
31	"clusterId": "5e6bc60ba4c3f47a54d8fe95",
32	"dataSizeBytes": 0,
33	"name": "Cluster2",
34	"nodeCount": 3,
35	"sslEnabled": true,
36	"type": "replica set",
37	"versions": [
38	"4.2.3"
39	]
40	}
41	],
42	"groupId": "5df90932f10fab675508b0e5",
43	"groupName": "az",
44	"orgId": "5df7a168f10fab3a149357fb",
45	"orgName": "jww-12-16",
46	"planType": "Ops Manager",
47	"tags": [
48
49	]
50	},
51	{
52	"clusters": [
53	{
54	"alertCount": 0,
55	"authEnabled": true,
56	"availability": "available",
57	"backupEnabled": false,
58	"clusterId": "5e6bbf6a9de0d35b1527dd93",
59	"dataSizeBytes": 0,
60	"name": "Cluster0",
61	"nodeCount": 3,
62	"sslEnabled": true,
63	"type": "replica set",
64	"versions": [
65	"4.2.3"
66	]
67	}
68	],
69	"groupId": "5df90590f10fab5e33de2305",
70	"groupName": "jww-12-17",
71	"orgId": "5df7a168f10fab3a149357fb",
72	"orgName": "jww-12-16",
73	"planType": "Ops Manager",
74	"tags": [
75
76	]
77	},
78	{
79	"clusters": [
80	{
81	"alertCount": 0,
82	"authEnabled": true,
83	"availability": "dead",
84	"backupEnabled": false,
85	"clusterId": "5e6be93fd434591c4ca765f6",
86	"dataSizeBytes": 0,
87	"name": "Cluster0",
88	"nodeCount": 0,
89	"sslEnabled": true,
90	"type": "replica set",
91	"versions": [
92	"4.2.3"
93	]
94	}
95	],
96	"groupId": "5df90923f10fab675508b065",
97	"groupName": "gcp",
98	"orgId": "5df7a168f10fab3a149357fb",
99	"orgName": "jww-12-16",
100	"planType": "Ops Manager",
101	"tags": [
102
103	]
104	}
105	],
106	"totalCount": 3
107	}