文档Experience Platform沙盒指南

沙盒管理端点

Last update: Thu Aug 08 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 开发人员

Adobe Experience Platform中的沙盒提供了独立的开发环境，允许您在不影响生产环境的情况下测试功能、运行实验以及进行自定义配置。 Sandbox API中的/sandboxes端点允许您以编程方式管理Platform中的沙盒。

快速入门

本指南中使用的API端点是Sandbox API的一部分。 在继续之前，请查看快速入门指南，以获取相关文档的链接、阅读本文档中示例API调用的指南，以及有关成功调用任何Experience PlatformAPI所需的所需标头的重要信息。

检索沙盒列表 list

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

查找沙盒 lookup

您可通过在请求路径中包含沙盒的name属性的GET请求来查找单个沙盒。

API格式

GET /sandboxes/{SANDBOX_NAME}
参数
描述
{SANDBOX_NAME}
要查找的沙盒的name属性。

请求

以下请求检索名为“dev-2”的沙盒。

curl -X GET \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/dev-2 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \

响应

成功的响应返回沙盒的详细信息，包括其name、title、state和type。

{
    "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}"
}
属性
描述
name
沙盒的名称。 此属性用于API调用中的查找目的。
title
沙盒的显示名称。
state

沙盒的当前处理状态。 沙盒的状态可以是以下任一状态：

  • 正在创建：沙盒已创建，但系统仍在配置该沙盒。
  • 活动：沙盒已创建并处于活动状态。
  • 失败：由于错误，沙盒无法由系统配置，因此被禁用。
  • 已删除：沙盒已被手动禁用。
type
沙盒类型。 当前支持的沙盒类型包括： development和production。
isDefault
布尔属性，指示此沙盒是否为组织的默认沙盒。 通常，这是生产沙盒。
eTag
沙盒的特定版本的标识符。 用于版本控制和缓存效率，每次对沙盒进行更改时都会更新此值。

创建沙盒 create

NOTE
创建新沙盒时，您必须首先将该新沙盒添加到Adobe Admin Console中的产品配置文件中，然后才能开始使用新沙盒。 有关如何将沙盒预配到产品配置文件的信息，请参阅有关管理产品配置文件的权限的文档。

您可以通过向/sandboxes端点发出POST请求来创建新的开发或生产沙盒。

创建开发沙盒

要创建开发沙盒，您必须在请求有效负载中提供值为development的type特性。

API格式

POST /sandboxes

请求

以下请求创建一个名为“acme-dev”的新开发沙盒。

curl -X POST \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "acme-dev",
    "title": "Acme Business Group dev",
    "type": "development"
  }'
属性
描述
name
将在未来请求中用于访问沙盒的标识符。 该值必须唯一，最佳做法是使其尽可能具有描述性。 此值不能包含任何空格或特殊字符。
title
易于用户识别的名称，用于平台用户界面中的显示目的。
type
要创建的沙盒的类型。 对于非生产沙盒，此值必须为development。

响应

成功的响应返回新创建的沙盒的详细信息，表明其state正在“创建”。

{
    "name": "acme-dev",
    "title": "Acme Business Group dev",
    "state": "creating",
    "type": "development",
    "region": "VA7"
}
NOTE
系统配置沙盒大约需要30秒，之后其state将变为“活动”或“失败”。

创建生产沙盒

要创建生产沙盒，您必须在请求有效负载中提供值为production的type特性。

API格式

POST /sandboxes

请求

以下请求创建一个名为“acme”的新生产沙盒。

curl -X POST \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H `Accept: application/json` \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "acme",
    "title": "Acme Business Group",
    "type": "production"
}'
属性
描述
name
将在未来请求中用于访问沙盒的标识符。 该值必须唯一，最佳做法是使其尽可能具有描述性。 此值不能包含任何空格或特殊字符。
title
易于用户识别的名称，用于平台用户界面中的显示目的。
type
要创建的沙盒的类型。 对于生产沙盒，此值必须为production。

响应

成功的响应返回新创建的沙盒的详细信息，表明其state正在“创建”。

{
    "name": "acme",
    "title": "Acme Business Group",
    "state": "creating",
    "type": "production",
    "region": "VA7"
}
NOTE
系统配置沙盒大约需要30秒，之后其state将变为“活动”或“失败”。

更新沙盒 put

您可以通过发出PATCH请求来更新沙盒中的一个或多个字段，该请求请求在请求路径中包含沙盒的name，并在请求有效负载中包含要更新的属性。

NOTE
当前只能更新沙盒的title属性。

API格式

PATCH /sandboxes/{SANDBOX_NAME}
参数
描述
{SANDBOX_NAME}
要更新的沙盒的name属性。

请求

以下请求更新名为“acme”的沙盒的title属性。

curl -X PATCH \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/acme \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json'
  -d '{
    "title": "Acme Business Group prod"
  }'

响应

成功的响应返回HTTP状态200 （确定）以及新更新的沙盒的详细信息。

{
    "name": "acme",
    "title": "Acme Business Group prod",
    "state": "active",
    "type": "production",
    "region": "VA7"
}

重置沙盒 reset

沙盒具有“工厂重置”功能，可从沙盒中删除所有非默认资源。 您可以通过在PUT路径中包含沙盒的name来重置沙盒。

API格式

PUT /sandboxes/{SANDBOX_NAME}
参数
描述
{SANDBOX_NAME}
要重置的沙盒的name属性。
validationOnly
一个可选参数，允许您对沙盒重置操作执行预检而不发出实际请求。 将此参数设置为validationOnly=true以检查您即将重置的沙盒是否包含任何Adobe Analytics、Adobe Audience Manager或区段共享数据。

请求

以下请求重置名为“acme-dev”的沙盒。

curl -X PUT \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/acme-dev?validationOnly=true \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json'
  -d '{
    "action": "reset"
  }'
属性
描述
action
必须在请求有效负载中提供值为“reset”的此参数，才能重置沙盒。

响应

NOTE
沙盒重置后，系统配置沙盒大约需要30秒。

成功的响应返回已更新沙盒的详细信息，表明其state正在“重置”。

{
    "id": "d8184350-dbf5-11e9-875f-6bf1873fec16",
    "name": "acme-dev",
    "title": "Acme Business Group dev",
    "state": "resetting",
    "type": "development",
    "region": "VA7"
}

如果Adobe Analytics也在其中托管的身份图形用于Cross Device Analytics (CDA)功能，或者Adobe Audience Manager也在其中托管的身份图形用于基于人员的目标(PBD)功能，则无法重置默认生产沙盒和任何用户创建的生产沙盒。

以下是可阻止沙盒重置的可能异常列表：

{
    "status": 400,
    "title": "Sandbox `{SANDBOX_NAME}` cannot be reset. The identity graph hosted in this sandbox is also being used by Adobe Analytics for the Cross Device Analytics (CDA) feature.",
    "type": "http://ns.adobe.com/aep/errors/SMS-2074-400"
},
{
    "status": 400,
    "title": "Sandbox `{SANDBOX_NAME}` cannot be reset. The identity graph hosted in this sandbox is also being used by Adobe Audience Manager for the People Based Destinations (PBD) feature.",
    "type": "http://ns.adobe.com/aep/errors/SMS-2075-400"
},
{
    "status": 400,
    "title": "Sandbox `{SANDBOX_NAME}` cannot be reset. The identity graph hosted in this sandbox is also being used by Adobe Audience Manager for the People Based Destinations (PBD) feature, as well by Adobe Analytics for the Cross Device Analytics (CDA) feature.",
    "type": "http://ns.adobe.com/aep/errors/SMS-2076-400"
},
{
    "status": 400,
    "title": "Warning: Sandbox `{SANDBOX_NAME}` is used for bi-directional segment sharing with Adobe Audience Manager or Audience Core Service.",
    "type": "http://ns.adobe.com/aep/errors/SMS-2077-400"
}

您可以继续重置用于与Audience Manager或Audience Core Service进行双向区段共享的生产沙盒，方法是将ignoreWarnings参数添加到您的请求。

API格式

PUT /sandboxes/{SANDBOX_NAME}?ignoreWarnings=true
参数
描述
{SANDBOX_NAME}
要重置的沙盒的name属性。
ignoreWarnings
一个可选参数，允许您跳过验证检查并强制重置用于与Audience Manager或Audience Core Service双向区段共享的生产沙盒。 此参数无法应用于默认的生产沙盒。

请求

以下请求重置名为“acme”的生产沙盒。

curl -X PUT \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/acme?ignoreWarnings=true \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json'
  -d '{
    "action": "reset"
  }'

响应

成功的响应返回已更新沙盒的详细信息，表明其state正在“重置”。

{
    "id": "d8184350-dbf5-11e9-875f-6bf1873fec16",
    "name": "acme",
    "title": "Acme Business Group prod",
    "state": "resetting",
    "type": "production",
    "region": "VA7"
}

删除沙盒 delete

IMPORTANT
无法删除默认的生产沙盒。

您可以通过在请求路径中包含沙盒的name来发出DELETE请求，以删除沙盒。

NOTE
进行此API调用会将沙盒的status属性更新为“已删除”并停用它。 删除沙盒后，GET请求仍可以检索沙盒的详细信息。

API格式

DELETE /sandboxes/{SANDBOX_NAME}
参数
描述
{SANDBOX_NAME}
要删除的沙盒的name。
validationOnly
一个可选参数，允许您对沙盒删除操作进行预检而不发出实际请求。 将此参数设置为validationOnly=true以检查您即将重置的沙盒是否包含任何Adobe Analytics、Adobe Audience Manager或区段共享数据。
ignoreWarnings
一个可选参数，允许您跳过验证检查并强制删除用于与Audience Manager或Audience Core Service双向区段共享的用户创建的生产沙盒。 此参数无法应用于默认的生产沙盒。

请求

以下请求删除名为“acme”的生产沙盒。

curl -X DELETE \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/acme?ignoreWarnings=true \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'

响应

成功的响应返回沙盒的更新详细信息，表明其state已“删除”。

{
    "name": "acme",
    "title": "Acme Business Group prod",
    "state": "deleted",
    "type": "development",
    "region": "VA7"
}
recommendation-more-help
e243ad8f-a318-46b3-9930-159a80f82b42