Retornar um processo do MongoDB por ID

OBTER /api/atlas/v1.0/groups/{groupId}/processes/{processId}

Retorna os processos do host especificado para o projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função somente leitura do projeto.

parâmetros de caminho

groupId string Obrigatório

Sequência única 24de dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
processId string Obrigatório

Combinação de nome de host e porta Internet Assigned Numbers Authority (IANA) que atende ao processo do MongoDB. O host deve ser o nome do host, o FQDN (nome de domínio totalmente qualificado) ou o endereço IPv4 ou IPv6 do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.

O formato deve corresponder ao seguinte padrão: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.

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 aplicação/json

OK
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- Criado string(data-hora)
  
  Data e hora em que o MongoDB Cloud criou esse processo MongoDB . Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.
- groupId string
  
  24String única de dígitos hexadecimais string que identifica o projeto. O projeto contém processos MongoDB que você deseja retornar. O processo do MongoDB pode ser mongod ou mongos.
  
  O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
- nome do host string
  
  Nome de host, nome de domínio totalmente qualificado (FQDN) ou endereço de protocolo de Internet (IPv4 ou IPv6) do host que executa o processo do MongoDB (mongod ou mongos).
  
  O formato deve corresponder ao seguinte padrão: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?$.
- id string
  
  Combinação de nome de host e porta Internet Assigned Numbers Authority (IANA) que atende ao processo do MongoDB. O host deve ser o nome do host, o FQDN (nome de domínio totalmente qualificado) ou o endereço IPv4 ou IPv6 do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.
  
  O formato deve corresponder ao seguinte padrão: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.
- lastPing string(data-hora)
  
  Data e hora em que o MongoDB Cloud recebeu o último ping para esse processo do MongoDB . Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.
- 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.
- Porta integer(int32)
  
  Porta Internet Assigned Numbers Authority (IANA) na qual o processo do MongoDB escuta as solicitações.
- ReplicaSetName string
  
  Rótulo legível por humanos que identifica o conjunto de réplicas que contém este processo. Este recurso retorna este parâmetro se este processo pertencer a um conjunto de réplica.
- shardName string
  
  Rótulo legível por humanos que identifica o shard que contém esse processo. Este recurso retorna este valor somente se este processo pertencer a um cluster fragmentado.
- typeName string
  
  Tipo de processo MongoDB que o MongoDB Cloud rastreia. O MongoDB Cloud retorna novos processos como NO_DATA até que o MongoDB Cloud conclua a implantação do processo.
  
  Os valores são REPLICA_PRIMARY, REPLICA_SECONDARY, RECOVERING, SHARD_MONGOS, SHARD_CONFIG, SHARD_STANDALONE, SHARD_PRIMARY, SHARD_SECONDARY ou NO_DATA.
- userAlias string
  
  Rótulo legível por humanos que identifica o nó do cluster. O MongoDB Cloud define esse nome de host geralmente como o nome de host padrão para o nó do cluster. Ele aparece na string de conexão de um cluster em vez do valor do parâmetro hostname.
- Versão string
  
  Versão do MongoDB que este processo executa.
  
  O formato deve corresponder ao seguinte padrão: ([\d]+\.[\d]+\.[\d]+).
401 aplicação/json

Não autorizado.
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.
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.
404 aplicação/json

Não encontrado.
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/v1.0/groups/{groupId}/processes/{processId}

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/processes/mongodb.example.com:27017' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Exemplos de resposta (200)

{
  "created": "2025-05-04T09:42:00Z",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hostname": "string",
  "id": "string",
  "lastPing": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "port": 42,
  "replicaSetName": "string",
  "shardName": "string",
  "typeName": "REPLICA_PRIMARY",
  "userAlias": "string",
  "version": "string"
}

Exemplos de resposta (401)

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

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 (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

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