アプリ環境を設定する

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

アプリのアクティブな環境を設定する

path パラメータ

application/ JSON

body

  • environment string

    アプリケーションの環境。

    値は、development、testing、qa、または production です。

応答

  • 200 application/ JSON

    成功

    応答属性の非表示 応答属性の表示 オブジェクト

    特定の既存のアプリケーション。

    • name string

      アプリケーションの名前。文字で始まる必要があり、ASCII 文字、数字、アンダースコア、ハイフンのみを含めることができます。

    • provider_region string

      次の 1 つ：
      AwsDeploymentRegion string AzureDeploymentRegion string GcpDeploymentRegion string

      値は、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、または aws-sa-east-1 です。

      値は、azure-eastus2、azure-westus、azure-westeurope、azure-eastasia、または azure-southeastasia です。

      値は、gcp-us-central1、gcp-us-east4、gcp-us-west1、gcp-europe-west1、または gcp-asia-south1 です。

    • ロケーション string

      アプリをホストするクラウドプロバイダーに関係なく、アプリサーバーが物理的に配置されるロケーションの識別子です。

      値は、US-VA、US-OR、DE-FF、IE、AU、IN-MB、SG、または BR-SP です。

    • deployment_model string

      アプリケーションの配置モデル。

      値は GLOBAL または LOCAL です。

    • environment string

      アプリケーションの環境。

      値は、development、testing、qa、または production です。

    • _id string

      アプリケーションの一意の内部ID。

    • client_app_id string

      アプリケーションの公開 App ID。

    • domain_id string

      アプリケーションに関連付けられた ドメインID。

    • group_id string

      アプリケーションの Atlas Project/Group ID 。

    • last_used integer

      このアプリが最後に使用された時刻（UNIX 時間）（つまり 1 月 1、1970 からの秒数）。

    • last_modified integer

      このアプリがUNIX 時間で最後に変更された時刻（つまり 1 月 1、1970 からの秒数）。

    • product string

      このアプリはの製品です。

      値は、standard、atlas、data-api、または device-sync です。
  • 400 application/ JSON

    無効な環境

    応答属性の非表示 応答属性の表示 オブジェクト
    • エラー string

      エラーを説明するメッセージ。

    • error_code string

      エラーの種類。
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"}'
リクエスト例 
{
  "environment": "production"
}
応答の例（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"
}
応答の例（400） 
{
  "error": "string",
  "error_code": "string"
}