チュートリアル: 予定されたトリガーでクラスターを自動化

サービス アカウントの作成

trigger が既存の Atlasプロジェクトに対するProject Owner 権限を持つ Atlas Administration API を呼び出すために使用できるサービス アカウントを作成するには、次の手順に従います。

1. Atlasで、Go Users{0 ページに します。

   1. まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー

   2. サイドバーの [Identity & Access] セクションの下の [All Projects] をクリックし、目的のプロジェクトを選択します。

   3. サイドバーの [Security] セクションの下の [Project Identity & Access] をクリックします。

   [ ユーザー ] ページが表示されます。

2. Create ApplicationService Account[ をクリックします。

3. サービスアカウント情報を入力します。

   • 名前: サービス アカウントの名前。 （例: TriggersServiceAccount）

   • 説明: （任意）サービス アカウントの説明。 （例: Atlas Administration APIを呼び出すための Atlas Function のサービス アカウント。）

   • サービス アカウントの権限: Project Owner

4. [Create] をクリックします。

   これにより、サービス アカウントが作成され、権限Organization Member を持つプロジェクトの親組織に自動的に追加されます。

5. API Access List を設定します。

   このサービス アカウントで Atlas Administration API を呼び出せるIPアドレスを制限する場合は、API Access List にIPアドレスを追加します。

   注意

   組織で Require IP Access List for the Atlas Administration API が有効になっている場合、またはサービス アカウントの API Access List にIPアドレスを追加した場合、すべての Atlas Administration APIリクエストはIPアクセス リスト チェックに合格する必要があります。

   Atlas triggers と Functions は、特定のアウトバウンドIPアドレスのセットから送信HTTPリクエストを送信します。スケジュールされたトリガーで Atlas Administration APIやその他の外部サービスを呼び出すようにするには、これらのIPアドレスをサービス アカウントの API Access List に追加する必要があります。

   Atlas Functionで使用されるアウトバウンドIPアドレスの完全なリストについては、「 関数のセキュリティ アウトバウンドIPアクセス 」を参照してください。各IPアドレスを個別に追加する必要があります。

サービス アカウントの認証情報を 値とシークレット として保存します。

サービス アカウントの認証情報を保存するには、次の値とシークレットを作成します。

• AtlasClientId サービス アカウントクライアントIDを含む値。

• AtlasClientSecret サービス アカウントクライアントシークレットを含む シークレット

• AtlasClientSecret シークレットにリンクする値。これにより、シークレットとして安全に保存されたままに、関数内のクライアントシークレット値にアクセスできるようになります。

1. Atlas で、 Triggers ページに移動します。

   1. まだ表示されていない場合は、プロジェクトを含む組織をナビゲーション バーの Organizations メニューで選択します。

   2. まだ表示されていない場合は、ナビゲーション バーの Projects メニューからプロジェクトを選択します。

   3. サイドバーで、 Streaming Data見出しの下のTriggersをクリックします。

   Triggersページが表示されます。

2. Values ページに移動します。

   1. Linked App Service: Triggersリンクをクリックします。

   2. サイドバーで、 Build見出しの下のValuesをクリックします。

3. クライアントID を値 に保存します。

   1. クリック Create a Value

   2. Value Name として AtlasClientId を入力します。

   3. Valueタイプを選択します。

   4. Custom Content オプションを選択し、クライアントIDを入力します。

      注意

      クライアントID は、引用符（"<clientId>"）を含む文字列として入力する必要があります。

   5. [Save] をクリックします。

4. クライアントシークレットを シークレット に保存し、それを 値にリンクします。

   注意

   シークレット値には直接アクセスできないため、シークレットにリンクする 2 番目の 値 を作成する必要があります。

   1. [Create a Value] をクリックします。

   2. Value Name として AtlasClientSecret を入力します。

   3. Valueタイプを選択します。

   4. Link to Secret オプションを選択します。

   5. シークレット値に名前を付けるには、「AtlasClientSecret」と入力し、Create "AtlasClientSecret" をクリックします。

      シークレット名の下に表示される Client Secretフィールドにクライアントシークレットを貼り付けます。

   6. シークレットと値の両方を作成するには、Save をクリックします。

getAuthHeaders関数を作成します。

サービス アカウントの認証情報を使用してアクセス トークンを取得し、 Atlas Administration APIを呼び出すための適切な認証ヘッダーを返す再利用可能な関数を作成するには、次の手順に従います。

1. Functions ページに移動します。

   1. サイドバーで、 Build見出しの下のFunctionsをクリックします。

   2. [Create a Function] をクリックします。

      Settingsタブにはデフォルトで が表示されます。

2. 関数の Name として getAuthHeaders を入力します。

3. Private を true に設定します。この関数は、このチュートリアルでは他の関数によってのみ呼び出されます。

   Settingsタブのその他の構成オプションはデフォルト値のままにします。

4. 関数 コードを定義します。

   [Function Editor ] タブをクリックし、次のコードを貼り付けて関数を定義します。

   1
   /*
   2
    * Generate API request headers with a new Service Account Access Token.
   3
    */
   4
   exports = async function getAuthHeaders() {
   5
   6
     // Get stored credentials
   7
     clientId = context.values.get("AtlasClientId");
   8
     clientSecret = context.values.get("AtlasClientSecret");
   9
   10
     // Throw an error if credentials are missing
   11
     if (!clientId || !clientSecret) {
   12
       throw new Error("Authentication credentials not found. Set AtlasClientId/AtlasClientSecret (service account auth credentials).");
   13
     }
   14
   15
     // Define the argument for the HTTP request to get the access token
   16
     const tokenUrl = "https://cloud.mongodb.com/api/oauth/token";
   17
     const credentials = Buffer.from(`${clientId}:${clientSecret}`).toString("base64");
   18
   19
     const arg = {
   20
       url: tokenUrl,
   21
       headers: {
   22
         "Authorization": [ `Basic ${credentials}` ],
   23
         "Content-Type": [ "application/x-www-form-urlencoded" ]
   24
       },
   25
       body: "grant_type=client_credentials"
   26
     }
   27
   28
     // The response body is a BSON.Binary object; parse it to extract the access token 
   29
     const response = await context.http.post(arg);
   30
     const tokenData = JSON.parse(response.body.text());
   31
     const accessToken = tokenData.access_token;
   32
   33
     // Define the Accept header with the resource version from env var or default to latest stable
   34
     const resourceVersion = context.environment.ATLAS_API_VERSION || "2025-03-12";
   35
     const acceptHeader = `application/vnd.atlas.${resourceVersion}+json`;
   36
   37
     // Return the access token as headers for future API calls
   38
     return {
   39
      headers: {
   40
        "Authorization": [ `Bearer ${accessToken}` ],
   41
        "Accept": [ acceptHeader ],
   42
        "Accept-Encoding": [ "bzip, deflate" ],
   43
        "Content-Type": [ "application/json" ]
   44
      }
   45
     };
   46
   }

modifyCluster関数を作成します。

1 つのプロジェクトの 1 つのクラスターの更新 をラップする再利用可能な関数 エンドポイントを作成するには、次の手順に従います。

1. Functions ページから、Create a Function をクリックします。

   Settingsタブにはデフォルトで が表示されます。

2. 関数の Name として modifyCluster を入力します。

3. Private を true に設定します。この関数は、このチュートリアルでは他の関数によってのみ呼び出されます。

   Settingsタブのその他の構成オプションはデフォルト値のままにします。

4. 関数 コードを定義します。

   [Function Editor ] タブをクリックし、次のコードを貼り付けて関数を定義します。

   1
   /*
   2
    * Modifies the cluster as defined by the `body` parameter.
   3
    * See https://www.mongodb.com/ja-jp/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster
   4
    */
   5
   exports = async function(projectID, clusterName, body) {
   6
   7
     // Easy testing from the console
   8
     if (projectID === "Hello world!") {
   9
       projectID   = "<projectId>";
   10
       clusterName = "<clusterName>";
   11
       body        = { paused: false };
   12
     }
   13
   14
     // Retrieve headers to authenticate with a new access token, and define the request URL for the Atlas API endpoint
   15
     const authHeaders = await context.functions.execute("getAuthHeaders");
   16
     const requestUrl = `https://cloud.mongodb.com/api/atlas/v2/groups/${projectID}/clusters/${clusterName}`;
   17
   18
     // Build the argument for the HTTP request to the Atlas API to modify the cluster
   19
     const arg = {
   20
       url: requestUrl,
   21
       headers: authHeaders.headers,
   22
       body: JSON.stringify(body)
   23
     };
   24
   25
     // The response body is a BSON.Binary object; parse it and return the modified cluster description
   26
     const response = await context.http.patch(arg);
   27
     if (response.body) {
   28
        return EJSON.parse(response.body.text()); 
   29
     } else {
   30
        throw new Error(`No response body returned from Atlas API. Status code: ${response.status}`);
   31
     }
   32
   };

   注意

   関数エディターでコードをテストします。

   Testing Console で関数を実行すると、Function Editor は最初の引数として "Hello world!" を自動的に提供します。このコードはその入力をテストし、"Hello world!" が受信された場合は パラメーターに値を提供します。

   独自の入力で関数をテストするには、次のプレースホルダー値を独自の情報に置き換えます。

   • <projectId>

   • <clusterName>

   • body パラメーターでは、クラスターに加える変更を含むペイロードを指定します。例コードには、クラスターを一時停止するペイロードが含まれています。

pauseClusters関数を作成します。

1. Atlas で、 Triggers ページに移動します。

   1. まだ表示されていない場合は、プロジェクトを含む組織をナビゲーション バーの Organizations メニューで選択します。

   2. まだ表示されていない場合は、ナビゲーション バーの Projects メニューからプロジェクトを選択します。

   3. サイドバーで、 Streaming Data見出しの下のTriggersをクリックします。

   Triggersページが表示されます。

2. Functionsページに移動します

   1. Linked App Service: Triggersリンクをクリックします。

   2. サイドバーで、 Build見出しの下のFunctionsをクリックします。

   3. [Create a Function] をクリックします。

      Settingsタブにはデフォルトで が表示されます。

3. 関数の Name として pauseClusters を入力します。

4. Private を true に設定します。この関数は、このチュートリアルでは pauseClusters trigger によってのみ呼び出されます。

   Settingsタブのその他の構成オプションはデフォルト値のままにします。

5. 関数 コードを定義します。

   [Function Editor ] タブをクリックし、次のコードを貼り付けて関数を定義します。

   1
   /*
   2
    * Iterates over the provided projects and clusters, pausing those clusters.
   3
    */
   4
   exports = async function () {
   5
   6
     // Supply project IDs and cluster names to pause
   7
     const projectIDs = [
   8
       {
   9
         id: "<projectIdA>",
   10
         names: [ "<clusterNameA>", "<clusterNameB>" ]
   11
       },
   12
       {
   13
         id: "<projectIdB>",
   14
         names: [ "<clusterNameC>" ]
   15
       }
   16
     ];
   17
   18
     // Set desired state
   19
     const body = { paused: true };
   20
   21
     // Pause each cluster and log the response
   22
     for (const project of projectIDs) {
   23
       for (const cluster of project.names) {
   24
         const result = await context.functions.execute(
   25
           "modifyCluster",
   26
           project.id,
   27
           cluster,
   28
           body,
   29
         );
   30
         console.log("Cluster " + cluster + ": " + EJSON.stringify(result));
   31
       }
   32
     }
   33
   34
     return "Clusters Paused";
   35
   };

   projectIDs 配列を独自のプロジェクトとクラスター名に置き換えます。

   注意

   プロジェクトとクラスター名がハードコーディングされないようにするには、このチュートリアルの最後にヘルパー関数 を使用して、Atlas Administration APIからプロジェクトとクラスターのリストを取得し、スケジュールでどのクラスターを一時停止および再開するかをプログラムで決定できます。

pauseClustersの予定されたトリガーを作成します。

1. Functions ページから、Build 見出しの下のサイドバーにある Triggers をクリックして、Triggers ページに移動します。

2. Create a Triggerをクリックしてトリガー設定ページを開きます。

   既存の trigger がある場合は、次をクリックします Add a Trigger

3. trigger 設定を構成します。

   Trigger Details で、次の構成を設定します。

   設定	値
   trigger タイプ	スケジュール
   スケジュールの種類	高度。これにより、スケジュールに CRON式を指定できるようになります。 62200これを曜日ごとに実行するには、次の [CRON式]を使用します。 0 22 * * 1-5
   再有効化時にイベントをスキップ	。これにより、trigger が無効になっている間にキューに入れられたスケジュールで trigger が実行されなくなります。
   eventType	関数。ドロップダウンから pauseClusters 関数を選択します。
   trigger 名	pauseClusters

4. trigger を作成するには、Save をクリックします。

   テスト クラスターは、毎日午前 606 時（米国東部）に自動的に一時停止されるようになりました。

resumeClusters関数を作成します。

1. pauseClusters 関数を resumeClusters という名前の新しい関数に複製します。

2. Function Editorタブで、関数コードで paused 状態を false に更新します。

   1
   /*
   2
    * Iterates over the provided projects and clusters, resuming those clusters.
   3
    */
   4
   exports = async function () {
   5
   6
     // Supply project IDs and cluster names to resume
   7
     const projectIDs = [
   8
       {
   9
         id: "<projectIdA>",
   10
         names: [ "<clusterNameA>", "<clusterNameB>" ]
   11
       },
   12
       {
   13
         id: "<projectIdB>",
   14
         names: [ "<clusterNameC>" ]
   15
       }
   16
     ];
   17
   18
     // Set desired state
   19
     const body = { paused: false };
   20
   21
     // Resume each cluster and log the response
   22
     for (const project of projectIDs) {
   23
       for (const cluster of project.names) {
   24
         const result = await context.functions.execute(
   25
           "modifyCluster",
   26
           project.id,
   27
           cluster,
   28
           body,
   29
         );
   30
         console.log("Cluster " + cluster + ": " + EJSON.stringify(result));
   31
       }
   32
     }
   33
   34
     return "Clusters Resumed";
   35
   };

resumeClustersの予定されたトリガーを作成します。

1. Functions ページから、Build 見出しの下のサイドバーにある Triggers をクリックして、Triggers ページに移動します。

2. trigger 設定を構成します。

   Trigger Details で、次の構成を設定します。

   設定	値
   trigger タイプ	スケジュール
   スケジュールの種類	高度。これにより、スケジュールに CRON式を指定できるようになります。 これを毎日午前 8 に米国東部（12:00 UTC）に実行するには、次の CRON式を使用します。 0 12 * * 1-5
   再有効化時にイベントをスキップ	。これにより、trigger が無効になっている間にキューに入れられたスケジュールで trigger が実行されなくなります。
   eventType	関数。ドロップダウンから resumeClusters 関数を選択します。
   trigger 名	resumeClusters

3. trigger を作成するには、Save をクリックします。

これで、テスト クラスターは毎週ごとに一時停止され、毎週午前に自動的に再開されます。

scaleClusterUp関数を作成します。

1. Atlas で、 Triggers ページに移動します。

   1. まだ表示されていない場合は、プロジェクトを含む組織をナビゲーション バーの Organizations メニューで選択します。

   2. まだ表示されていない場合は、ナビゲーション バーの Projects メニューからプロジェクトを選択します。

   3. サイドバーで、 Streaming Data見出しの下のTriggersをクリックします。

   Triggersページが表示されます。

2. Functionsページに移動します

   1. Linked App Service: Triggersリンクをクリックします。

   2. サイドバーで、 Build見出しの下のFunctionsをクリックします。

   3. [Create a Function] をクリックします。

      Settingsタブにはデフォルトで が表示されます。

3. 関数の Name として scaleClusterUp を入力します。

4. Private を true に設定します。この関数は、このチュートリアルでは scaleClusterUp trigger によってのみ呼び出されます。

   Settingsタブのその他の構成オプションはデフォルト値のままにします。

5. 関数 コードを定義します。

   Create Function ページから、Function Editorタブをクリックし、次のコードを貼り付けて関数を定義します。

   1
   /*
   2
    * Scales a single cluster up to a larger instance size.
   3
    * This example scales an AWS cluster up to M30 in region US_EAST_1.
   4
    */
   5
   exports = async function() {
   6
     // Supply project ID and cluster name...
   7
     const projectID   = "<projectId>";
   8
     const clusterName = "<clusterName>";
   9
   10
     // Set the desired instance size and topology...
   11
     const body = {
   12
       replicationSpecs: [
   13
         {
   14
           regionConfigs: [
   15
             {
   16
               electableSpecs: {
   17
                 instanceSize: "M30", // for example, larger tier
   18
                 nodeCount: 3
   19
               },
   20
               priority:     7,
   21
               providerName: "AWS",
   22
               regionName:   "US_EAST_1"
   23
             }
   24
           ]
   25
         }
   26
       ]
   27
     };
   28
   29
     // Scale up the cluster and log the response
   30
     const result = await context.functions.execute(
   31
       "modifyCluster",
   32
       projectID,
   33
       clusterName,
   34
       body
   35
     );
   36
     console.log(EJSON.stringify(result));
   37
   38
     return clusterName + " scaled up";
   39
   };

   <projectId> と <clusterName> のプレースホルダーを独自のプロジェクトIDとクラスター名に置き換え、regionConfigs 配列を独自のトポロジーに合わせて調整します。

   クラスターの構成を変更するためにリクエスト本文に含めることができるフィールドの詳細については、「 1 つのプロジェクトの 1 つのクラスターの更新 」エンドポイントのドキュメントを参照してください。

scaleClusterUpの予定されたトリガーを作成します。

1. Functions ページから、Build 見出しの下のサイドバーにある Triggers をクリックして、Triggers ページに移動します。

2. Create a Triggerをクリックしてトリガー設定ページを開きます。

   既存の trigger がある場合は、次をクリックします Add a Trigger

3. trigger 設定を構成します。

   Trigger Details で、次の構成を設定します。

   設定	値
   trigger タイプ	スケジュール
   スケジュールの種類	高度。これにより、スケジュールに CRON式を指定できるようになります。 これを毎日午前 8 に米国東部（13:00 UTC）に実行するには、次の CRON式を使用します。 0 13 * * *
   再有効化時にイベントをスキップ	。これにより、trigger が無効になっている間にキューに入れられたスケジュールで trigger が実行されなくなります。
   eventType	関数。ドロップダウンから pauseClusters 関数を選択します。
   trigger 名	scaleClusterUp

4. trigger を作成するには、Save をクリックします。

   テスト クラスターは、毎日午前8 60 時（米国東部）にテスト クラスターが自動的に増やすアップされるようになりました。

scaleClusterDown関数を作成します。

1. scaleClusterUp 関数を scaleClusterDown という名前の新しい関数に複製します。

2. Function Editorタブで、次のコードを貼り付けて調整し、指定された構成にクラスターを増やすダウンします。

   1
   /*
   2
    * Scales a single cluster down to a smaller instance size.
   3
    * This example scales an AWS cluster down to M10 in region US_EAST_1.
   4
    */
   5
   exports = async function() {
   6
     const projectID   = "<projectId>";
   7
     const clusterName = "<clusterName>";
   8
   9
     const body = {
   10
       replicationSpecs: [
   11
         {
   12
           regionConfigs: [
   13
             {
   14
               electableSpecs: {
   15
                 instanceSize: "M10", // for example, smaller tier
   16
                 nodeCount: 3
   17
               },
   18
               priority:     7,
   19
               providerName: "AWS",
   20
               regionName:   "US_EAST_1"
   21
             }
   22
           ]
   23
         }
   24
       ]
   25
     };
   26
   27
     // Scale down the cluster and log the response
   28
     const result = await context.functions.execute(
   29
       "modifyCluster",
   30
       projectID,
   31
       clusterName,
   32
       body
   33
     );
   34
     console.log(EJSON.stringify(result));
   35
   36
     return clusterName + " scaled down";
   37
   };

   <projectId> と <clusterName> のプレースホルダーを独自のプロジェクトIDとクラスター名に置き換え、regionConfigs 配列を独自のトポロジーに合わせて調整します。

   クラスターの構成を変更するためにリクエスト本文に含めることができるフィールドの詳細については、「 1 つのプロジェクトの 1 つのクラスターの更新 」エンドポイントのドキュメントを参照してください。

scaleClusterDownの予定されたトリガーを作成します。

1. Functions ページから、Build 見出しの下のサイドバーにある Triggers をクリックして、Triggers ページに移動します。

2. trigger 設定を構成します。

   Trigger Details で、次の構成を設定します。

   設定	値
   trigger タイプ	スケジュール
   スケジュールの種類	高度。これにより、スケジュールに CRON式を指定できるようになります。 62200これを毎時（ 0 22 * * *
   再有効化時にイベントをスキップ	。これにより、trigger が無効になっている間にキューに入れられたスケジュールで trigger が実行されなくなります。
   eventType	関数。ドロップダウンから scaleClusterDown 関数を選択します。
   trigger 名	scaleClusterDown

3. trigger を作成するには、Save をクリックします。

これら 2 つの trigger を組み合わせると、クラスターがピーク時間帯により高いキャパシティーで実行され、その後はスケールダウンされます。