Retornar o status deste aplicativo do MongoDB

OBTER /api/atlas/v2

Contas de serviço DigestAuth

Esse recurso retorna informações sobre o aplicativo MongoDB junto com os metadados da chave API.

parâmetros de query

envelope booleano

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

O valor padrão é false.
pretty booleano

Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

O valor padrão é false.

Prettyprint

Respostas

200 application/vnd.atlas.2023-01-01+json

OK
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- apiKey objeto | zero Obrigatório
  
  Detalhes contidos em uma chave de API.
  
  Ocultar atributos apiKey Mostrar atributos da apiKey objeto | zero
  
  accessList array[objeto]
  
  Lista de endereços de rede que concederam acesso a esta API usando esta chave de API.
  
  Ocultar atributos accessList Mostrar atributos de accessList objeto
  
  cidrBlock string
  
  Faixa de endereços IP na notação CIDR (Classless Inter-Domain Routing) encontrada na lista de acesso deste projeto.
  
  O formato deve corresponder ao seguinte padrão: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.
  
  ipAddress string Obrigatório
  
  Endereço IP incluído na lista de acesso da API.
  
  O formato deve corresponder ao seguinte padrão: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.
  
  id string Obrigatório
  
  String exclusiva de 24 dígitos hexadecimais que identifica esta chave API da organização.
  
  O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
  
  publicKey string Obrigatório
  
  Valor da chave de API pública definido para a chave de API da organização especificada.
  
  O comprimento mínimo é 8, o comprimento máximo é 8.
  
  roles array[objeto]
  
  Lista que contém funções que a chave API precisa ter. Todas as funções fornecidas devem ser válidas para o projeto ou organização especificada . Cada solicitação deve incluir um mínimo de uma função válida. O recurso retorna todas as roles do projeto e da organização atribuídas ao usuário do Cloud.
  
  As roles do usuário da MongoDB Cloud e a organização ou projeto correspondente ao qual essa role se aplica. Cada função pode ser aplicada a uma organização ou a um projeto , mas não a ambos.
  
  Ocultar atributos de roles Mostrar atributos de funções objeto
  
  groupId string
  
  24String única de dígitos hexadecimais que identifica o projeto ao qual esta role pertence. Você pode definir um valor para esse parâmetro ou orgId, mas não ambos na mesma solicitação.
  
  O comprimento mínimo é 24, o comprimento máximo é 24. O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
  
  orgId string
  
  24String única de dígitos hexadecimais que identifica a organização à qual pertence esta função. Você pode definir um valor para esse parâmetro ou groupId, mas não ambos na mesma solicitação.
  
  O comprimento mínimo é 24, o comprimento máximo é 24. O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
  
  roleName string
  
  Etiqueta legível por humanos que identifica a coleção de privilégios que o MongoDB Cloud concede a uma chave de API específica, a um usuário do MongoDB Cloud ou a uma equipe do MongoDB Cloud. Essas funções incluem funções de nível de organização e de projeto.
  
  Os valores são ORG_MEMBER, ORG_READ_ONLY, ORG_STREAM_PROCESSING_ADMIN, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_GROUP_CREATOR, ORG_OWNER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_CLUSTER_MANAGER, GROUP_SEARCH_INDEX_EDITOR, GROUP_STREAM_PROCESSING_OWNER, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER ou GROUP_DATABASE_ACCESS_ADMIN.
- appName string Obrigatório
  
  Etiqueta legível para humanos que identifica o serviço do qual você solicitou esta resposta.
  
  O valor é MongoDB Atlas.
- COMPILAR string Obrigatório
  
  Hash exclusivo de 40dígitos hexadecimais que identifica o último commit do git mesclado para este aplicação.
- links array[objeto]
  
  Lista de um ou mais localizadores uniformes de recursos (URLs) que ponto para sub-recursos de API, recursos de API relacionados ou ambos. A RFC 5988 descreve esses relacionamentos.
  
  Especificação de vinculação à web ( RFC 5988)
  
  Ocultar atributos dos links Mostrar atributos dos links objeto
  
  href string
  
  Localizador de recursos uniforme (URL) que aponta outro recurso de API para o qual essa resposta tem algum relacionamento. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Localizador de recursos uniforme (URL) que define a relacionamento semântica entre este recurso e outro recurso de API. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.
- estrangulamento booleano Obrigatório
  
  Sinalizador que indica se alguém habilitou a limitação neste serviço.
401

Não autorizado.
403 aplicação/json

Forbidden.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.
500 aplicação/json

Erro interno do servidor.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.

GET /api/atlas/v2

atlas api root getSystemStatus --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231001001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetSystemStatusApiParams{}
	sdkResp, httpResp, err := client.RootApi.
		GetSystemStatusWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-10-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-10-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true"

Exemplos de resposta (200)

{
  "apiKey": {
    "accessList": [
      {
        "cidrBlock": "string",
        "ipAddress": "string"
      }
    ],
    "id": "32b6e34b3d91647abb20e7b8",
    "publicKey": "string",
    "roles": [
      {
        "groupId": "32b6e34b3d91647abb20e7b8",
        "orgId": "32b6e34b3d91647abb20e7b8",
        "roleName": "ORG_MEMBER"
      }
    ]
  },
  "appName": "MongoDB Atlas",
  "build": "83be55e140f493c88e7f578aae96548dd881587b",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "throttling": true
}

Exemplos de resposta (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Exemplos de resposta (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}