Obter todos os clusters em um projeto
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a autenticação OAuth 2.0 , crie umaconta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
Recupere detalhes de todos os clusters em um projeto.
Funções obrigatórias
Você pode chamar esse endpoint com sucesso com qualquer função atribuída.
Solicitar
URL base: https://cloud.mongodb.com/api/public/v1.0
GET /groups/{PROJECT-ID}/clusters
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
---|---|---|
PROJECT-ID | string | Identificador único do projeto. |
Solicitar parâmetros de query
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 prettyprint formato. | false |
envelope | booleano | Opcional | Sinalizador que 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 Para endpoints que retornam uma lista de resultados, o objeto | false |
backupJobsEnabledOnly | booleano | Opcional | Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como false para incluir configurações de daemon com o sinalizador backupJobsEnabled definido como false . | true |
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 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; O Cloud 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 Cloud Manager processou mais recentemente um ping desse cluster. | ||||||||||
replicaSetName | string | Nome do nome do conjunto. O Cloud Manager retorna esse valor quando um cluster tem typeName de REPLICA_SET ou CONFIG_SERVER_REPLICA_SET . | ||||||||||
shardName | string | Nome do shard. Cloud 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. O Cloud Manager pode retornar:
|
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters?pretty=true"
Exemplo de resposta
Cabeçalho de resposta
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
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://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters?pageNum=1&itemsPerPage=100", 5 "rel": "self" 6 } 7 ], 8 "results": [ 9 { 10 "clusterName": "myRS", 11 "groupId": "5e84b94c003f2d6370004f4e", 12 "id": "5e8ba20e87d9396ca9b96bd0", 13 "lastHeartbeat": "2020-06-10T14:51:28Z", 14 "links": [ 15 { 16 "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0", 17 "rel": "self" 18 } 19 ], 20 "replicaSetName": "myRS", 21 "typeName": "REPLICA_SET" 22 }, 23 { 24 "clusterName": "cm-clstr-repl", 25 "groupId": "5e84b94c003f2d6370004f4e", 26 "id": "5e84e393395ec72bfc888f6c", 27 "lastHeartbeat": "2020-06-10T15:20:08Z", 28 "links": [ 29 { 30 "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e84e393395ec72bfc888f6c", 31 "rel": "self" 32 } 33 ], 34 "replicaSetName": "cm-clstr-repl", 35 "typeName": "REPLICA_SET" 36 } 37 ], 38 "totalCount": 2 39 }