URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /orgs/{ORG-ID}/groups
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Elemento do caminho | Tipo | Descrição |
|---|---|---|
ORG-ID | Obrigatório. | O identificador exclusivo da organização cujas informações você deseja recuperar. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | Descrição | Default |
|---|---|---|---|
| inteiro | Número da página (com base em 1). |
|
| inteiro | Número de itens a serem devolvidos por página, até um máximo de 500. |
|
| booleano | Exibe a resposta em um formato de impressão bonita. |
|
| booleano | Especifica se deseja ou não envolver a resposta em um envelope. |
|
| string | Etiqueta legível por humanos do projeto a ser usada para filtrar a lista retornada. Executa uma pesquisa sem diferenciação de maiúsculas e minúsculas para um projeto, que é prefixado pelo Por exemplo, se você especificar um parâmetro de query | none |
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
documento de resposta
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
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 |
|---|---|---|
ActiveAgentCount | inteiro | O número de monitoramento, automação e backups ativos no projeto. |
hostCounts | Documento | Descreve os tipos de host e o número de cada tipo de host para o cluster. |
hostCounts.arbiter | inteiro | O número de hosts árbitro no cluster. |
hostCounts.config | inteiro | O número de hosts do servidor de configuração de cluster fragmentado no cluster. |
hostCounts.mongos | inteiro | The number of |
hostCounts.primary | inteiro | O número de hosts primary no cluster. |
hostCounts.secondary | inteiro | O número de hosts secundários no cluster. |
id | string | O identificador exclusivo do projeto. |
links | array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays |
name | string | O nome do cluster. |
orgId | string | O identificador exclusivo da organização principal do projeto. |
publicApiEnabled | booleano | O status do acesso da API ao cluster. |
replicaSetCount | inteiro | O número de conjuntos de réplicas no cluster. |
shardCount | inteiro | O número de fragmentos no cluster. |
Exemplo de solicitação
curl --user "{username:apiKey}" \ --include \ --header "Content-Type: application/json" \ --digest GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/groups"
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
{ "links": [{ }], "results": [{ "activeAgentCount": 0, "hostCounts": { "arbiter": 0, "config": 0, "mongos": 0, "primary": 1, "secondary": 2 }, "id": "{PROJECT-ID}", "links": [{ }], "name": "Production Cluster", "orgId": "{ORG-ID}", "publicApiEnabled": true, "replicaSetCount": 1, "shardCount": 0 }, { "activeAgentCount": 0, "hostCounts": { "arbiter": 0, "config": 0, "mongos": 0, "primary": 1, "secondary": 2 }, "id": "{PROJECT-ID}", "lastActiveAgent": "2017-10-26T02:39:59Z", "links": [{ }], "name": "Staging Cluster", "orgId": "{ORG-ID}", "publicApiEnabled": true, "replicaSetCount": 1, "shardCount": 0 } ], "totalCount": 2 }