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 projetos para o usuário atual

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu grupo. Para grupos existentes, o ID do grupo/ ID do projeto permanece o mesmo. Esta página usa o termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups

Parâmetros da solicitação

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

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 Cloud Manager adiciona o campo status ao corpo da resposta.

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

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

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.

results documento incorporado

Cada resultado é um projeto.

Nome
Tipo
Descrição

ActiveAgentCount

inteiro

Número de agentes ativos que enviam pings regulares ao Cloud Manager.

O valor é atualizado a cada 24 horas e armazenado em cache. Se você iniciar um novo agente ou interromper um existente, a alteração pode levar até 30 minutos para aparecer no campo activeAgentCount .

hostCounts

objeto

Número total de hosts por tipo. Os campos incorporados devem ser autoexplicativos.

id

string

Identificador único do grupo.

lastActiveAgent

string

Hora do Cloud Manager atualizar pela última vez o total de activeAgentCount para o projeto. O Cloud Manager atualiza esse valor a cada 24 horas e o armazena em cache para registrar o número de agentes MongoDB ativos.

links

array de objetos

Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays links nas respostas incluem pelo menos um link chamado self. Os relacionamentos entre URLs são explicados na Especificação de links da web.

name

string

Nome de exibição do projeto.

orgId

string

Identificador único da organização à qual o projeto pertence.

publicApiEnabled

booleano

Sinalizador indicando que a API está habilitada para este projeto. Este é um campo somente leitura que é sempre true.

replicaSetCount

inteiro

Número total de conjuntos de réplica para este projeto.

shardCount

inteiro

Número total de shards para este projeto.

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?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-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}

Corpo de resposta

{  "links": [{    "href": "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true&pageNum=1&itemsPerPage=100",    "rel": "self"  }, {    "href": "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true&itemsPerPage=100&pageNum=2",    "rel": "next"  }],  "results": [{    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56a10a80e4b0fd3b9a9bb0c2",    "lastActiveAgent": "2016-03-09T18:19:37Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "012i3091203jioawjioej",    "orgId": "5980cfdf0b6d97029d82f86e",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }, {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56aa691ce4b0a0e8c4be51f7",    "lastActiveAgent": "2016-01-29T19:02:56Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "1454008603036",    "orgId": "5980d0040b6d97029d831798",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }, {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56aa6dfde4b0fe328eee82ad",    "lastActiveAgent": "2016-01-29T20:34:28Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "1454009852809",    "orgId": "5980d0040b6d97029d831799",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }, {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56aa8421e4b0d04c1c54df99",    "lastActiveAgent": "2016-01-29T21:36:10Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "1454015520776",    "orgId": "5980d0040b6d97029d83179a",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }, {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56aa85f9e4b0d04c1c54e347",    "lastActiveAgent": "2016-01-29T21:36:10Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "1454015992252",    "orgId": "5980d0040b6d97029d83179b",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }],  "totalCount": 5}
Voltar
Projetos
Próximo
Obter por ID
Avalie esta página

Nesta página