Dokumentation Experience Platform Användarhandbok för sandlådor

Slutpunkt för sandlådehantering

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

Ämnen:

Skapat för:

Utvecklare

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. Med slutpunkten /sandboxes i API:t Sandbox kan du programmässigt hantera sandlådor i plattformen.

Komma igång

API-slutpunkten som används i den här guiden ingår i Sandbox API. Innan du fortsätter bör du läsa kom igång-guiden för att få länkar till relaterad dokumentation, en guide till hur du läser exempelanropen för API i det här dokumentet och viktig information om vilka huvuden som krä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 (aktiva eller andra) genom att göra en GET-förfrågan till slutpunkten /sandboxes.

API-format

GET /sandboxes?{QUERY_PARAMS}

Parameter

Beskrivning

{QUERY_PARAMS}

Valfria frågeparametrar för att filtrera resultat efter. Mer information finns i avsnittet om frågeparametrar.

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}' \

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
        }
    }
}

Egenskap

Beskrivning

name

Namnet på sandlådan. Den här egenskapen används för uppslagssyften i API-anrop.

title

Visningsnamnet för sandlådan.

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 har skapats 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

Sandlådetypen. De sandlådetyper som stöds för närvarande är development och production.

isDefault

En boolesk egenskap som anger om den här sandlådan är standardproduktionssandlådan för organisationen.

eTag

En identifierare för en specifik version av sandlådan. Detta värde används för versionskontroll och cachelagring av effektivitet och uppdateras varje gång en ändring görs i sandlådan.

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-egenskap i sökvägen för begäran.

API-format

GET /sandboxes/{SANDBOX_NAME}

Parameter

Beskrivning

{SANDBOX_NAME}

Egenskapen name 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}"
}

Egenskap

Beskrivning

name

Namnet på sandlådan. Den här egenskapen används för uppslagssyften i API-anrop.

title

Visningsnamnet för sandlådan.

state

Sandlådans aktuella bearbetningstillstånd. En sandlådestatus kan vara något av följande:

skapar: Sandlådan har skapats, men etableras fortfarande av systemet.
active: Sandlådan skapas och är aktiv.
misslyckades: På grund av ett fel kunde inte sandlådan etableras av systemet och är inaktiverad.
borttagen: Sandlådan har inaktiverats manuellt.

type

Sandlådetypen. De sandlådetyper som stöds för närvarande är: development och production.

isDefault

En boolesk egenskap som anger om den här sandlådan är standardsandlådan för organisationen. Vanligtvis är det här produktionssandlådan.

eTag

En identifierare för en specifik version av sandlådan. Detta värde används för versionskontroll och cachelagring av effektivitet och uppdateras varje gång en ändring görs i sandlådan.

Skapa en sandlåda create

NOTE

När en ny sandlåda skapas måste du först lägga till den nya sandlådan i din produktprofil i Adobe Admin Console innan du kan börja använda den nya sandlådan. Mer information om hur du distribuerar en sandlåda till en produktprofil finns i dokumentationen om hantering av behörigheter för en produktprofil .

Du kan skapa en ny utvecklings- eller produktionssandlåda genom att göra en POST-förfrågan till slutpunkten /sandboxes.

Skapa en utvecklingssandlåda

Om du vill skapa en utvecklingssandlåda måste du ange ett 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"
  }'

Egenskap

Beskrivning

name

Den identifierare som ska användas för att komma åt sandlådan i framtida begäranden. Detta värde måste vara unikt och det bästa sättet är att göra det så beskrivande som möjligt. Värdet får inte innehålla blanksteg eller specialtecken.

title

Ett läsbart namn som används för visning i användargränssnittet för plattformen.

type

Den typ av sandlåda som ska skapas. För en icke-produktionssandlåda måste värdet vara development.

Svar

Ett lyckat svar returnerar information om den nyligen skapade sandlådan, vilket visar att state är"skapar".

{
    "name": "acme-dev",
    "title": "Acme Business Group dev",
    "state": "creating",
    "type": "development",
    "region": "VA7"
}

NOTE

Det tar cirka 30 sekunder för sandlådor att etableras av systemet. Därefter blir deras state"aktiv" eller"misslyckades".

Skapa en produktionssandlåda

Om du vill skapa en produktionssandlåda måste du ange ett 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"
}'

Egenskap

Beskrivning

name

title

Ett läsbart namn som används för visning i användargränssnittet för plattformen.

type

Den typ av sandlåda som ska skapas. För en produktionssandlåda måste värdet vara production.

Svar

Ett lyckat svar returnerar information om den nyligen skapade sandlådan, vilket visar att state är"skapar".

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

NOTE

Det tar cirka 30 sekunder för sandlådor att etableras av systemet. Därefter blir deras state"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 för begäran och egenskapen som ska uppdateras i nyttolasten för begäran.

NOTE

För närvarande kan bara egenskapen title i en sandlåda uppdateras.

API-format

PATCH /sandboxes/{SANDBOX_NAME}

Parameter

Beskrivning

{SANDBOX_NAME}

Egenskapen name för den sandlåda som du vill uppdatera.

Begäran

Följande begäran uppdaterar egenskapen 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 för begäran.

API-format

PUT /sandboxes/{SANDBOX_NAME}

Parameter

Beskrivning

{SANDBOX_NAME}

Egenskapen name för den sandlåda som du vill återställa.

validationOnly

En valfri parameter som gör att du kan utföra en kontroll före flygning av sandlådeåterställningsåtgärden utan att göra den faktiska begäran. Ange den här parametern till validationOnly=true för att kontrollera om sandlådan som du ska å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"
  }'

Egenskap

Beskrivning

action

Den här parametern måste anges med värdet "reset" i nyttolasten för begäran för att sandlådan ska kunna återställas.

Svar

NOTE

När en sandlåda har återställts tar det cirka 30 sekunder att etablera den av systemet.

Ett lyckat svar returnerar informationen om den uppdaterade sandlådan, vilket visar att state är "återställ".

{
    "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 funktionen Cross Device Analytics (CDA) eller om identitetsdiagrammet som finns i den också används av Adobe Audience Manager för funktionen People Based Destinations (PBD) .

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 parametern ignoreWarnings i din begäran.

API-format

PUT /sandboxes/{SANDBOX_NAME}?ignoreWarnings=true

Parameter

Beskrivning

{SANDBOX_NAME}

Egenskapen name för den sandlåda som du vill återställa.

ignoreWarnings

En valfri parameter som gör att du kan hoppa över valideringskontrollen och framtvinga återställningen av en produktionssandlåda som används för dubbelriktad segmentdelning med Audience Manager eller Audience Core Service. Den här parametern kan inte tillämpas på en standardproduktionssandlåda.

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 lyckat svar returnerar informationen om den uppdaterade sandlådan, vilket visar att state är "återställ".

{
    "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

IMPORTANT

Det går inte att ta bort standardproduktionssandlådan.

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 för begäran.

NOTE

Om du gör det här API-anropet uppdateras sandlådans status-egenskap till"Borttagen" och inaktiveras. GET-begäranden kan fortfarande hämta sandlådans information efter att den har tagits bort.

API-format

DELETE /sandboxes/{SANDBOX_NAME}

Parameter

Beskrivning

{SANDBOX_NAME}

name för den sandlåda som du vill ta bort.

validationOnly

En valfri parameter som gör att du kan utföra en kontroll före flygning av sandlådeborttagningsåtgärden utan att göra den faktiska begäran. Ange den här parametern till validationOnly=true för att kontrollera om sandlådan som du ska återställa innehåller Adobe Analytics-, Adobe Audience Manager- eller segmentdelningsdata.

ignoreWarnings

En valfri parameter som gör att du kan hoppa över valideringskontrollen och framtvinga borttagning av en användarskapad produktionssandlåda som används för dubbelriktad segmentdelning med Audience Manager eller Audience Core Service. Den här parametern kan inte tillämpas på en standardproduktionssandlåda.

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 har tagits bort.

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

recommendation-more-help

e243ad8f-a318-46b3-9930-159a80f82b42