ドキュメントExperience Platformサンドボックスガイド

使用可能なサンドボックスエンドポイント

最終更新日： 2024年7月16日
  • トピック：

作成対象：

  • 開発者
NOTE
Sandbox API で提供される他のエンドポイントとは異なり、このエンドポイントは、サンドボックス管理のアクセス権限を持たないユーザーを含むすべてのユーザーが使用できます。

使用可能なサンドボックス エンドポイントにGETリクエストを行うことで、現在のユーザーが使用できるサンドボックスをリストできます。

API 形式

GET /{QUERY_PARAMS}
パラメーター説明
{QUERY_PARAMS}結果をフィルタリングするオプションのクエリパラメーター。 使用可能なパラメーターのリストについては、 付録ドキュメントを参照してください。

リクエスト

curl -X GET \
  https://platform.adobe.io/data/foundation/sandbox-management/?limit=3&offset=1 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'

応答

応答が成功すると、name、title、state、type などの詳細を含む、現在のユーザーが使用できるサンドボックスのリストが返されます。

{
    "sandboxes": [
        {
            "name": "prod",
            "title": "Production",
            "state": "active",
            "type": "production",
            "region": "VA7",
            "isDefault": true,
            "eTag": 2,
            "createdDate": "2019-09-04 04:57:24",
            "lastModifiedDate": "2019-09-04 04:57:24",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        },
        {
            "name": "dev",
            "title": "Development",
            "state": "active",
            "type": "development",
            "region": "VA7",
            "isDefault": false,
            "eTag": 1,
            "createdDate": "2019-09-03 22:27:48",
            "lastModifiedDate": "2019-09-03 22:27:48",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        },
        {
            "name": "stage",
            "title": "Staging",
            "state": "active",
            "type": "development",
            "region": "VA7",
            "isDefault": false,
            "eTag": 1,
            "createdDate": "2019-09-03 22:27:48",
            "lastModifiedDate": "2019-09-03 22:27:48",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        }
    ],
    "_page": {
        "limit": 3,
        "count": 1
    },
    "_links": {
        "page": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/?limit={limit}&offset={offset}",
            "templated": true
        }
    }
}
プロパティ説明
nameサンドボックスの名前。API 呼び出しで参照目的に使用されます。
titleサンドボックスの表示名。
state

サンドボックスの現在の処理状態。サンドボックスの状態は、次のいずれかになります。

  • creating: サンドボックスが作成されましたが、まだシステムによるプロビジョニングが行われています。
  • active：サンドボックスが作成され、アクティブになります。
  • failed: エラーが発生したので、サンドボックスをシステムでプロビジョニングできなかったため、無効になりました。
  • deleted：サンドボックスは手動で無効になりました。
typeサンドボックスタイプ（「開発」または「実稼働」）。
isDefaultこのサンドボックスが組織のデフォルトの実稼動サンドボックスであるかどうかを示すブール値プロパティ。
eTagサンドボックスの特定のバージョンの識別子。バージョン管理とキャッシュの効率化に使用され、この値はサンドボックスに変更が追加されるたびに更新されます。
recommendation-more-help
e243ad8f-a318-46b3-9930-159a80f82b42