Criar uma nova aplicação

POSTAR /groups/{groupId}/apps
tokenAuth

parâmetros de caminho

parâmetros de query

  • defaults booleano

    Criar ou não um aplicativo padrão.

  • produto string

    O tipo de produto do aplicativo. Os aplicativos usam o tipo de produto standard por padrão. Para a maioria dos aplicativos, você não precisa especificar product, ou deve especificar standard.

    Os tipos de produto atlas, data-api e device-sync representam aplicativos especiais para Atlas Triggers, Atlas Data API e Atlas Device Sync que você pode acessar por meio da interface do usuário do Atlas.

    Os valores são standard, atlas, data-api ou device-sync.

aplicação/json

corpo, corpo Obrigatório

Um objeto que descreve um novo aplicativo para criar

  • name string

    O nome do aplicativo. Deve começar com uma letra e só pode conter letras ASCII, números, sublinhados e hífens.

  • provider_region
    Um dos seguintes:
    AWSDeploymentRegion AzureDeploymentRegion GcpDeploymentRegion

    O identificador curto de uma região de implantação específica do provedor de nuvem. Algumas regiões estão disponíveis para implementação global, enquanto outras estão disponíveis apenas para aplicativos locais. Consulte Regiões do sistema de nuvem.

    Os valores são aws-us-east-1, aws-us-west-2, aws-us-east-2, aws-eu-central-1, aws-eu-west-1, aws-eu-west-2, aws-ap-southeast-1, aws-ap-southeast-2, aws-ap-south-1 ou aws-sa-east-1.

    O identificador curto de uma região de implantação específica do provedor de nuvem. Algumas regiões estão disponíveis para implementação global, enquanto outras estão disponíveis apenas para aplicativos locais. Consulte Regiões do sistema de nuvem.

    Os valores são azure-eastus2, azure-westus, azure-westeurope, azure-eastasia ou azure-southeastasia.

    O identificador curto de uma região de implantação específica do provedor de nuvem. Algumas regiões estão disponíveis para implementação global, enquanto outras estão disponíveis apenas para aplicativos locais. Consulte Regiões do sistema de nuvem.

    Os valores são gcp-us-central1, gcp-us-east4, gcp-us-west1, gcp-europe-west1 ou gcp-asia-south1.

  • localização string

    O local do sistema físico do aplicativo. Isso deve estar de acordo com o valor específico de provider_region. Por exemplo, um aplicativo com uma provider_region de aws-us-west-2 mapeia para um location de US-OR.

    Os valores são US-VA, US-OR, DE-FF, IE, AU, IN-MB, SG ou BR-SP.

  • deployment_model string

    Um modelo de implantação de aplicativos.

    Os valores são GLOBAL ou LOCAL.

  • ambiente string

    O ambiente do aplicativo.

    Os valores são development, testing, qa ou production.

  • template_id string

    A ID de um aplicativo de modelo de App Services a ser usado como base para o novo aplicativo.

  • data_source objeto
    Um dos seguintes:
    objeto ServiceConstructor objeto AtlasFederatedInstanceConstructor

Respostas

  • 201 aplicação/json

    O aplicativo foi criado com sucesso.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto

    Um aplicação específico existente.

    • name string

      O nome do aplicativo. Deve começar com uma letra e só pode conter letras ASCII, números, sublinhados e hífens.

    • provider_region
      Um dos seguintes:
      AWSDeploymentRegion AzureDeploymentRegion GcpDeploymentRegion

      O identificador curto de uma região de implantação específica do provedor de nuvem. Algumas regiões estão disponíveis para implementação global, enquanto outras estão disponíveis apenas para aplicativos locais. Consulte Regiões do sistema de nuvem.

      Os valores são aws-us-east-1, aws-us-west-2, aws-us-east-2, aws-eu-central-1, aws-eu-west-1, aws-eu-west-2, aws-ap-southeast-1, aws-ap-southeast-2, aws-ap-south-1 ou aws-sa-east-1.

      O identificador curto de uma região de implantação específica do provedor de nuvem. Algumas regiões estão disponíveis para implementação global, enquanto outras estão disponíveis apenas para aplicativos locais. Consulte Regiões do sistema de nuvem.

      Os valores são azure-eastus2, azure-westus, azure-westeurope, azure-eastasia ou azure-southeastasia.

      O identificador curto de uma região de implantação específica do provedor de nuvem. Algumas regiões estão disponíveis para implementação global, enquanto outras estão disponíveis apenas para aplicativos locais. Consulte Regiões do sistema de nuvem.

      Os valores são gcp-us-central1, gcp-us-east4, gcp-us-west1, gcp-europe-west1 ou gcp-asia-south1.

    • localização string

      O local do sistema físico do aplicativo. Isso deve estar de acordo com o valor específico de provider_region. Por exemplo, um aplicativo com uma provider_region de aws-us-west-2 mapeia para um location de US-OR.

      Os valores são US-VA, US-OR, DE-FF, IE, AU, IN-MB, SG ou BR-SP.

    • deployment_model string

      Um modelo de implantação de aplicativos.

      Os valores são GLOBAL ou LOCAL.

    • ambiente string

      O ambiente do aplicativo.

      Os valores são development, testing, qa ou production.

    • _id string

      O ID interno exclusivo do aplicativo.

    • client_app_id string

      O ID público do aplicativo do aplicativo.

    • domain_id string

      O ID de domínio associado do aplicativo.

    • GROUP_ID string

      O ID do Projeto/Grupo Atlas do aplicativo.

    • last_used inteiro

      A hora em que este aplicativo foi usado pela última vez no horário UNIX (ou seja, o número de segundos desde 1 de janeiro de 1970).

    • last_modified inteiro

      A hora em que este aplicativo foi modificado pela última vez em horário UNIX (ou seja, o número de segundos desde 1 de janeiro de 1970).

    • produto string

      O produto para o qual este aplicativo é.

      Os valores são standard, atlas, data-api ou device-sync.
  • 400 aplicação/json

    Há um erro na solicitação.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • Erro string

      Uma mensagem que descreve o erro.

    • error_code string

      O tipo de erro.
POST /groups/{groupId}/apps 
curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "name": "MyApp",
  "provider_region": "aws-us-east-1",
  "location": "US-VA",
  "deployment_model": "GLOBAL",
  "environment": "production",
  "template_id": "string",
  "data_source": {
    "_id": "string",
    "name": "string",
    "type": "string"
  }
}'
Exemplos de solicitação 
{
  "name": "MyApp",
  "provider_region": "aws-us-east-1",
  "location": "US-VA",
  "deployment_model": "GLOBAL",
  "environment": "production",
  "template_id": "string",
  "data_source": {
    "_id": "string",
    "name": "string",
    "type": "string"
  }
}
Exemplos de resposta (201) 
{
  "name": "MyApp",
  "provider_region": "aws-us-east-1",
  "location": "US-VA",
  "deployment_model": "GLOBAL",
  "environment": "production",
  "_id": "633209ffd3bd3478005d1bac",
  "client_app_id": "myapp-abcde",
  "domain_id": "63320a2b5f9de9a6e0a213e8",
  "group_id": "5b2ec991973129243223a114",
  "last_used": 1664224746,
  "last_modified": 1656440824,
  "product": "standard"
}
Exemplos de resposta (400) 
{
  "error": "string",
  "error_code": "string"
}