オンデマンド Sandbox を作成して監視する

学習の目的

この単元を完了すると、次のことができるようになります。

• Sandbox API を認証してコールを発行する。
  
• 特定のリソースプロファイルで Sandbox を作成する。
  
• 運用スケジューラーを設定して稼働時間を自動化する。
  
• Sandbox インスタンスの状況を監視する。
  
• Start (開始)、Stop (停止)、Reset (リセット)、Restart (再起動) などのライフサイクル操作を実行する。
  

Commerce for B2C Sandbox API で環境を制御する

Commerce for B2C Sandbox API は、制御された環境で Agentforce Commerce for B2C ソリューションを開発およびテストするための強力な手段です。この API を使用すると、Sandbox インスタンスをプログラムで作成、管理、設定、操作できます。この API を使用すると、本番稼働中のシステムに影響を与えずに、インテグレーション、カスタマイズ、新機能のテストが行えます。Commerce for B2C Sandbox API は、直接操作、自動化、継続的インテグレーション (CI) および継続的デリバリー (CD) プロセス、正確なリソース管理に使用します。

API にアクセスして認証する

コマンドを発行する前に、アクセスを認証して安全な接続を確立します。

1. [B2C Commerce Developer Sandbox REST API] に移動します。
   
2. [Authorize (認証)] をクリックしてログインプロセスを開始します。
   
3. Account Manager で設定した API クライアント ID を入力します。
   
4. [Authorize (認証)]、[Close (閉じる)] の順にクリックしてウィンドウを閉じます。
   

接続を認証すると、インターフェースから直接コールを発行できるようになります。

オンデマンド Sandbox を作成する

POST/sandboxes メソッドを使用して、次の仕様のオンデマンド Sandbox を作成します。

• emails: email@salesforce.com
  
• TTL: 0
  
• autoScheduled: True
  
• Tags: environment development、team engineering、project ecommerceProj
  
• Start and Stop Scheduler: 平日の月曜 ～ 金曜
  
• Start time: 08:00:00+03:00
  
• Stop time: 19:00:00Z
  
• analyticesEnabled: false
  
• Resource profile: medium
  
• Settings OCAPI: 商品とカテゴリのリソースをそれぞれ指定します。
  
• Settings webdav: cartridges と impex のディレクトリパスを指定します。
  

POST/sandboxes メソッドを使用してオンデマンド Sandbox を作成する手順は、次のとおりです。

1. Commerce for B2C Developer Sandbox REST API で、POST/Sandbox メソッドを見つけて展開します。
   
2. [Sandboxes] セクションで、POST/sandboxes メソッドを展開します。
   
3. Sandbox の仕様に従って、リクエストボディを入力します。一部のプロパティは省略可能です。
   

{
 "tags": {
   "environment": "development",
   "team": "engineering",
   "project": "ecommerceProj"
 }
}

{
"analyticsEnabled": true
}

"startScheduler": {
    "weekdays": [
      "MONDAY",
      "TUESDAY",
     "WEDNESDAY",
      "THURSDAY",
      "FRIDAY"
    ],
    "time": "08:00:00+03:00"
  },

"stopScheduler": {
    "weekdays": [
      "MONDAY",
      "TUESDAY",
     "WEDNESDAY",
      "THURSDAY",
      "FRIDAY"
    ],
    "time": "19:00:00Z"
  },

json
{
"settings": {
"ocapi": [
{
"client_id": "sample-client-id-12345",
"resources": [
{
"resource_id": "/s/-/dw/data/v20_10/products",
"methods": [
"get",
"post",
"put",
"patch",
"delete"
],
"read_attributes": "(**)",
"write_attributes": "(**)"
},
{
"resource_id": "/s/-/dw/data/v20_10/categories",
"methods": [
"get",
"post",
"put",
"patch",
"delete"
],
"read_attributes": "(**)",
"write_attributes": "(**)"
}
]
}
]
}
}
{
 "settings": {
   "webdav": [
     {
       "client_id": "sample-client-id-12345",
       "permissions": [
         {
           "path": "/cartridges",
           "operations": [
             "read_write"
           ]
         },
         {
           "path": "/impex",
           "operations": [
             "read_write"
           ]
         }
       ]
     }
   ]
 }
}

4. [Execute (実行)] をクリックすると、インスタンスが作成されます。
   

オンデマンド Sandbox を管理する

Commerce for B2C オンデマンド Sandbox (ODS) を効果的に管理するには、いくつかの重要な操作を実行することで、開発環境やテスト環境を効率よく維持し、クレジットを無駄なく使用して、問題発生時にも正確にトラブルシューティングできるようにします。

Sandbox の状況を確認する

GET/sandboxes/{sandboxId} メソッドを使用して Sandbox の状況を確認できます。このメソッドは現在の状態 (started、stopped、upgrading) を返します。この確認を行うことで、Sandbox の作成後や再起動後に、読み込み中のシステムにアクセスしようとして時間を無駄にせずに済みます。

Start (開始)、Stop (停止)、Reset (リセット)、Restart (再起動) の操作には、POST/sandboxes/{sandboxId}/operations メソッドを使用します。

• Stop (停止): 作業を一時停止し、インスタンスを削除せずにクレジットを節約します。
  
• Start (開始): 作業を開始し、クレジットの消費を再開します。
  
• Reset (リセット): データベースをクリア (DBINIT) して、新しいテストデータセットやデータの回復に備えます。
  
• Restart (再起動): インスタンスを再起動し、応答しなくなったプロセスを復旧したり、設定変更を適用したりします。
  

リクエストボディでアクションを定義します。これらのアクションを実行した後は、必ず Sandbox の状況を確認して、状態が変更されたことを確認してください。

オンデマンド Sandbox を削除する

クレジット消費を抑え、レルムを整理された状態に保つために、機能ブランチのマージ後やテストサイクル完了後に残っている不要な Sandbox 環境を、DELETE/sandboxes/{sandboxId} メソッドを使用して削除します。この操作により、Sandbox が完全に削除され、クレジットの消費が停止して、関連付けられたすべてのデータが削除されます。同じ Sandbox 設定を頻繁に使用する場合は、API で作成とデータインポートのプロセスを自動化し、削除後に環境をすばやく再作成できるようにすることを検討してください。

オンデマンド Sandbox のクレジットを確認する

プロジェクトマネージャーとシステム管理者は、予算内に収まるようにリソース消費量を監視します。クレジット利用状況を追跡すると、特定の期間に消費量の多い Sandbox や、レルムアクティビティの予期しない急増を特定できます。

GET/realm/{realm}/usage メソッドを使用して、レルムレベルの利用状況を確認できます。このメソッドでは、レルム ID とレポートの開始日および終了日を指定します。

特定のインスタンスの消費量を切り分けるには、GET/sandboxes/{sandboxId}/usage メソッドを使用して、Sandbox ID と開始日および終了日を指定します。

Control Center からオンデマンド Sandbox ログに直接アクセスする

パフォーマンスの問題やコードエラーをすばやく診断するには、Control Center から ODS ログに直接アクセスします。Control Center を使用すると、Sandbox ごとに個別の URL やログイン情報を用意しなくても、サーバーイベントを絞り込んで検索できます。

ストアフロントのコードやデータを忘れずに追加する

新しい ODS にはストアフロントデータは含まれていません。POD ベースの Sandbox から ODS にコードとデータを直接移行することはできません。POD Sandbox からデータとコードをエクスポートしてから、ODS API を使用してデータとコードを ODS にインポートできます。

リソース

Salesforce 開発者ガイド: オンデマンド Sandbox