Slutpunkt för sandlådehantering
Sandlådor i Adobe Experience Platform har isolerade utvecklingsmiljöer där du kan testa funktioner, köra experiment och göra anpassade konfigurationer utan att påverka produktionsmiljön. The /sandboxes
slutpunkt i Sandbox Med API kan du programmässigt hantera sandlådor i plattformen.
Komma igång
API-slutpunkten som används i den här guiden är en del av Sandbox API. Innan du fortsätter bör du granska komma igång-guide för länkar till relaterad dokumentation, en guide till hur du läser exempelanrop till API:er i det här dokumentet och viktig information om vilka huvuden som behövs för att kunna anropa ett Experience Platform-API.
Hämta en lista med sandlådor list
Du kan lista alla sandlådor som tillhör din organisation (aktiv eller annan) genom att göra en GET-förfrågan till /sandboxes
slutpunkt.
API-format
GET /sandboxes?{QUERY_PARAMS}
{QUERY_PARAMS}
Begäran
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}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Svar
Ett lyckat svar returnerar en lista med sandlådor som tillhör din organisation, inklusive information som name
, title
, state
och 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
title
state
Sandlådans aktuella bearbetningstillstånd. En sandlådestatus kan vara något av följande:
creating
: Sandlådan har skapats, men etableras fortfarande av systemet.active
: Sandlådan skapas och är aktiv.failed
: På grund av ett fel kunde sandlådan inte etableras av systemet och är inaktiverad.deleted
: Sandlådan har inaktiverats manuellt.
type
development
och production
.isDefault
eTag
Söka efter en sandlåda lookup
Du kan söka efter en enskild sandlåda genom att göra en GET-begäran som innehåller sandlådans name
i sökvägen för begäran.
API-format
GET /sandboxes/{SANDBOX_NAME}
{SANDBOX_NAME}
name
egenskapen för den sandlåda som du vill söka efter.Begäran
Följande begäran hämtar en sandlåda med namnet "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}' \
Svar
Ett lyckat svar returnerar informationen om sandlådan, inklusive dess name
, title
, state
och 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
title
state
Sandlådans aktuella bearbetningstillstånd. En sandlådestatus kan vara något av följande:
- skapa: Sandlådan har skapats, men etableras fortfarande av systemet.
- aktiv: Sandlådan skapas och är aktiv.
- misslyckades: På grund av ett fel kunde sandlådan inte etableras av systemet och är inaktiverad.
- borttagen: Sandlådan har inaktiverats manuellt.
type
development
och production
.isDefault
eTag
Skapa en sandlåda create
Du kan skapa en ny utvecklings- eller produktionssandlåda genom att göra en POST-förfrågan till /sandboxes
slutpunkt.
Skapa en utvecklingssandlåda
Om du vill skapa en utvecklingssandlåda måste du ange en type
attribut med värdet development
i nyttolasten för begäran.
API-format
POST /sandboxes
Begäran
Följande begäran skapar en ny utvecklingssandlåda med namnet"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
.Svar
Ett lyckat svar returnerar informationen om den nya sandlådan, vilket visar att dess state
är "creating".
{
"name": "acme-dev",
"title": "Acme Business Group dev",
"state": "creating",
"type": "development",
"region": "VA7"
}
state
blir "aktiv" eller "misslyckades".Skapa en produktionssandlåda
Om du vill skapa en produktionssandlåda måste du ange en type
attribut med värdet production
i nyttolasten för begäran.
API-format
POST /sandboxes
Begäran
Följande begäran skapar en ny produktionssandlåda med namnet"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
.Svar
Ett lyckat svar returnerar informationen om den nya sandlådan, vilket visar att dess state
är "creating".
{
"name": "acme",
"title": "Acme Business Group",
"state": "creating",
"type": "production",
"region": "VA7"
}
state
blir "aktiv" eller "misslyckades".Uppdatera en sandlåda put
Du kan uppdatera ett eller flera fält i en sandlåda genom att göra en PATCH-begäran som innehåller sandlådans name
i sökvägen till begäran och egenskapen som ska uppdateras i nyttolasten för begäran.
title
kan uppdateras.API-format
PATCH /sandboxes/{SANDBOX_NAME}
{SANDBOX_NAME}
name
egenskapen för den sandlåda som du vill uppdatera.Begäran
Följande begäran uppdaterar title
i sandlådan med namnet"acme".
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"
}'
Svar
Ett lyckat svar returnerar HTTP-status 200 (OK) med information om den nyligen uppdaterade sandlådan.
{
"name": "acme",
"title": "Acme Business Group prod",
"state": "active",
"type": "production",
"region": "VA7"
}
Återställ en sandlåda reset
Sandlådor har en "fabriksåterställningsfunktion" som tar bort alla icke-standardresurser från en sandlåda. Du kan återställa en sandlåda genom att göra en PUT-begäran som innehåller sandlådans name
i sökvägen till begäran.
API-format
PUT /sandboxes/{SANDBOX_NAME}
{SANDBOX_NAME}
name
egenskapen för den sandlåda som du vill återställa.validationOnly
validationOnly=true
om du vill kontrollera om sandlådan du håller på att återställa innehåller Adobe Analytics-, Adobe Audience Manager- eller segmentdelningsdata.Begäran
Följande begäran återställer en sandlåda med namnet"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
Svar
Ett godkänt svar returnerar informationen om den uppdaterade sandlådan, vilket visar att state
är "resetting".
{
"id": "d8184350-dbf5-11e9-875f-6bf1873fec16",
"name": "acme-dev",
"title": "Acme Business Group dev",
"state": "resetting",
"type": "development",
"region": "VA7"
}
Standardproduktionssandlådan och alla användarskapade produktionssandlådor kan inte återställas om identitetsdiagrammet som finns i den också används av Adobe Analytics för CDA (Cross Device Analytics) eller om identitetsdiagrammet som finns i det också används av Adobe Audience Manager för Personbaserade mål (PBD) -funktion.
Nedan följer en lista över möjliga undantag som kan förhindra att en sandlåda återställs:
{
"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"
}
Du kan återställa en produktionssandlåda som används för dubbelriktad segmentdelning med Audience Manager eller Audience Core Service genom att lägga till ignoreWarnings
parameter till din begäran.
API-format
PUT /sandboxes/{SANDBOX_NAME}?ignoreWarnings=true
{SANDBOX_NAME}
name
egenskapen för den sandlåda som du vill återställa.ignoreWarnings
Begäran
Följande begäran återställer en produktionssandlåda med namnet "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"
}'
Svar
Ett godkänt svar returnerar informationen om den uppdaterade sandlådan, vilket visar att state
är "resetting".
{
"id": "d8184350-dbf5-11e9-875f-6bf1873fec16",
"name": "acme",
"title": "Acme Business Group prod",
"state": "resetting",
"type": "production",
"region": "VA7"
}
Ta bort en sandlåda delete
Du kan ta bort en sandlåda genom att göra en DELETE-begäran som innehåller sandlådans name
i sökvägen till begäran.
status
egenskapen till"deleted" och inaktiverar den. GET-begäranden kan fortfarande hämta sandlådans information efter att den har tagits bort.API-format
DELETE /sandboxes/{SANDBOX_NAME}
{SANDBOX_NAME}
name
för den sandlåda som du vill ta bort.validationOnly
validationOnly=true
om du vill kontrollera om sandlådan du håller på att återställa innehåller Adobe Analytics-, Adobe Audience Manager- eller segmentdelningsdata.ignoreWarnings
Begäran
Följande begäran tar bort en produktionssandlåda med namnet "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}'
Svar
Ett lyckat svar returnerar sandlådans uppdaterade information, vilket visar att dess state
är "deleted".
{
"name": "acme",
"title": "Acme Business Group prod",
"state": "deleted",
"type": "development",
"region": "VA7"
}