沙盒管理端点

最近更新： 2025年5月5日
  • 主题：

创建对象：

  • 开发人员

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沙盒的特定版本的标识符。 用于版本控制和缓存效率，每次对沙盒进行更改时都会更新此值。