Obter todas as organizações

Nesta página

Resource

Parâmetros da solicitação
Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
documento de resposta
results documento incorporado
Exemplo de solicitação
Exemplo de resposta

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

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 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .

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

Resource

GET /orgs

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	Descrição	Default
`pageNum`	inteiro	Número da página (com base em 1).	`1`
`itemsPerPage`	inteiro	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
`pretty`	booleano	Exibe a resposta em um prettyprint formato.	`false`
`envelope`	booleano	Especifica se deseja ou não envolver a resposta em um envelope.	`false`
`name`	string	Filtra os resultados com base no nome da organização especificado. Executa uma pesquisa sem diferenciação de maiúsculas e minúsculas para organizações que correspondem exatamente ao `name` especificado. Por exemplo, se você especificar um parâmetro de query `name` de `org1`, o Cloud Manager retornará as organizações denominadas `org1` e `Org1`, mas não retornará uma organização denominada `org123`.	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

O documentoJSON 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 `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 é uma organização.

Nome	Tipo	Descrição
id	string	Identificador único da organização.
isDeleted	booleano	Sinalizador que indica se a organização foi excluída.
name	string	Nome da organização.
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.

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/orgs/"

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

{
  "links" : [{
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs",
    "rel" : "self"
  }],
  "results" : [
    {
      "id" : "{ORG-ID1}",
      "isDeleted": false,
      "links": [{
      }],
      "name" : "Internal Application Support"
    },
    {
      "id" : "{ORG-ID2}",
      "isDeleted": false,
      "links": [{
      }],
      "name" : "Customer Application Support"
    },
    {
      "id" : "{ORG-ID3}",
      "isDeleted": false,
      "links": [{
      }],
      "name" : "Research and Development"
    }
  ],
  "totalCount" : 3
}

Voltar

Organizações

Pegue um