沙箱管理端點

最後更新： 2025年4月4日
  • 主題：

建立對象：

  • 開發人員

Adobe Experience Platform中的沙箱提供獨立的開發環境，可讓您測試功能、執行實驗及進行自訂設定，而不會影響您的生產環境。 Sandbox API中的/sandboxes端點可讓您以程式設計方式管理Experience Platform中的沙箱。

快速入門

本指南中使用的API端點是Sandbox API的一部分。 在繼續之前，請先檢閱快速入門手冊，以取得相關檔案的連結、閱讀本檔案中範例API呼叫的手冊，以及有關成功呼叫任何Experience Platform API所需必要標題的重要資訊。

擷取沙箱清單

您可以透過向/sandboxes端點發出GET請求，列出屬於您組織的所有沙箱（作用中或其他方式）。

API格式

GET /sandboxes?{QUERY_PARAMS}
參數說明
{QUERY_PARAMS}篩選結果的選用查詢引數。 如需詳細資訊，請參閱查詢引數的相關章節。

要求

curl -X GET \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes?&limit=4&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}"
        },
        {
            "name": "dev-2",
            "title": "Development 2",
            "state": "creating",
            "type": "development",
            "region": "VA7",
            "isDefault": false,
            "eTag": 1,
            "createdDate": "2019-09-07 10:16:02",
            "lastModifiedDate": "2019-09-07 10:16:02",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        }
    ],
    "_page": {
        "limit": 4,
        "count": 4
    },
    "_links": {
        "next": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/sandboxes/?limit={limit}&offset={offset}",
            "templated": true
        },
        "prev": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/sandboxes?offset=0&limit=1",
            "templated": null
        },
        "page": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/sandboxes?offset=1&limit=1",
            "templated": null
        }
    }
}
屬性說明
name沙箱的名稱。 此屬性用於API呼叫中的查閱用途。
title沙箱的顯示名稱。
state

沙箱的目前處理狀態。 沙箱的狀態可以是下列任一專案：

  • creating：沙箱已建立，但系統仍在布建中。
  • active：沙箱已建立且作用中。
  • failed：由於發生錯誤，沙箱無法由系統布建，因此已停用。
  • deleted：沙箱已手動停用。
type沙箱型別。 目前支援的沙箱型別包括development和production。
isDefault表示此沙箱是否為組織的預設生產沙箱的布林值屬性。
eTag特定版本沙箱的識別碼。 用於版本控制和快取效率，每次對沙箱進行變更時都會更新此值。