Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/ / / /

Obter uma equipe por nome

Nesta página

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

Observação

Este endpoint é incompatível com projetos utilizandoAutenticação LDAPdo .

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /orgs/{ORG-ID}/teams/byName/{TEAM-NAME}
Elemento do caminho
Obrigatório/Opcional
Descrição
ORG-ID
Obrigatório.
O identificador exclusivo da organização associada à equipe.
TEAM-NAME
Obrigatório
O nome da equipe cujas informações você deseja recuperar.

Os seguintes parâmetros de query são opcionais:

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
envelope
Corpo de resposta esperado
false

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Nome
Tipo
Descrição
id
string
O identificador exclusivo da equipe.
name
string
O nome da organização associada à equipe.
links
array

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.

curl --user "{username:apiKey}"" --digest -i \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
"https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/teams/byName/{TEAM-NAME}?pretty=true"
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}
{
"id": "{TEAM-ID}",
"links": [
{
"href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}",
"rel": "self"
}
],
"name": "myNewTeam"
}

Voltar

Obter uma equipe por ID