Set the App Environment

PUT /groups/{groupId}/apps/{appId}/environment

Establecer el entorno activo de la aplicación

Parámetros de path

application/json

Cuerpo

  • entorno string

    The application's environment.

    Los valores son development, testing, qa o production.

Respuestas

  • 200 application/json

    éxito

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto

    A specific, existing application.

    • Nombre string

      The name of the application. Must begin with a letter and may only contain ASCII letters, numbers, underscores, and hyphens.

    • provider_region

      Uno de los siguientes:

      El identificador corto de una región de implementación específica del proveedor de nube. Algunas regiones están disponibles para la implementación global, mientras que otras solo están disponibles para aplicaciones locales. Consulte Regiones de implementación en la nube.

      Los valores son 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 o aws-sa-east-1.

      El identificador corto de una región de implementación específica del proveedor de nube. Algunas regiones están disponibles para la implementación global, mientras que otras solo están disponibles para aplicaciones locales. Consulte Regiones de implementación en la nube.

      Los valores son azure-eastus2, azure-westus, azure-westeurope, azure-eastasia o azure-southeastasia.

      El identificador corto de una región de implementación específica del proveedor de nube. Algunas regiones están disponibles para la implementación global, mientras que otras solo están disponibles para aplicaciones locales. Consulte Regiones de implementación en la nube.

      Los valores son gcp-us-central1, gcp-us-east4, gcp-us-west1, gcp-europe-west1 o gcp-asia-south1.

    • Ubicación string

      La ubicación física de la implementación de la aplicación. Este debe coincidir con el valor más específico de provider_region. Por ejemplo, una aplicación con un provider_region de aws-us-west-2 se asigna a un location de US-OR.

      Los valores son US-VA, US-OR, DE-FF, IE, AU, IN-MB, SG o BR-SP.

    • deployment_model string

      An application deployment model.

      Los valores son GLOBAL o LOCAL.

    • entorno string

      The application's environment.

      Los valores son development, testing, qa o production.

    • _id string

      El ID interno único de la aplicación.

    • client_app_id string

      El ID de la aplicación pública de la aplicación.

    • domain_id string

      El ID de dominio asociado a la aplicación.

    • group_id string

      The application's Atlas Project/Group ID.

    • last_used entero

      The time this app was last used in UNIX time (i.e. the number of seconds since Jan 1, 1970).

    • last_modified entero

      The time this app was last modified in UNIX time (i.e. the number of seconds since Jan 1, 1970).

    • Producto string

      The product this app is for.

      Los valores son standard, atlas, data-api o device-sync.

  • 400 application/json

    Entorno inválido

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Error string

      Un mensaje que describe el error.

    • error_code string

      El tipo de error.

PUT /groups/{groupId}/apps/{appId}/environment
curl \
 --request PUT 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/environment' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "environment": "production"
}'
Solicitar ejemplos
{
  "environment": "production"
}
Ejemplos de respuesta (200)
{
  "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"
}
Ejemplos de respuesta (400)
{
  "error": "string",
  "error_code": "string"
}