Documentatie Experience Platform Handleiding voor Sandboxes

Sandbox-beheereindpunt

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

Onderwerpen:

Gemaakt voor:

Ontwikkelaar

Sandboxen in Adobe Experience Platform bieden geïsoleerde ontwikkelomgevingen waarmee u functies kunt testen, experimenten kunt uitvoeren en aangepaste configuraties kunt maken zonder dat dit gevolgen heeft voor uw productieomgeving. Met het eindpunt /sandboxes in de Sandbox API kunt u sandboxen in Platform programmatisch beheren.

Aan de slag

Het API eindpunt dat in deze gids wordt gebruikt maakt deel uit van Sandbox API. Alvorens verder te gaan, te herzien gelieve begonnen gidsvoor verbindingen aan verwante documentatie, een gids aan het lezen van de steekproefAPI vraag in dit document, en belangrijke informatie betreffende vereiste kopballen die nodig zijn om vraag aan om het even welk Experience Platform API met succes te maken.

Een lijst met sandboxen ophalen list

U kunt alle sandboxen weergeven die tot uw organisatie behoren (actief of anderszins) door een aanvraag voor een GET in te dienen bij het eindpunt /sandboxes .

API formaat

GET /sandboxes?{QUERY_PARAMS}

Parameter

Beschrijving

{QUERY_PARAMS}

Optionele queryparameters om resultaten te filteren op. Zie de sectie over vraagparametersvoor meer informatie.

Verzoek

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

Reactie

Een succesvol antwoord retourneert een lijst met sandboxen die tot uw organisatie behoren, inclusief details zoals name , title , state en 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
        }
    }
}

Eigenschap

Beschrijving

name

De naam van de sandbox. Deze eigenschap wordt gebruikt voor opzoekdoeleinden in API-aanroepen.

title

De weergavenaam voor de sandbox.

state

De huidige verwerkingsstatus van de sandbox. De status van een sandbox kan een van de volgende zijn:

creating: De sandbox is gemaakt, maar wordt nog steeds geleverd door het systeem.
active: De sandbox wordt gemaakt en actief.
failed: Als gevolg van een fout kon de sandbox niet door het systeem worden ingericht en is deze uitgeschakeld.
deleted: De sandbox is handmatig uitgeschakeld.

type

Het type sandbox. Tot de momenteel ondersteunde sandboxtypen behoren development en production .

isDefault

Een Booleaanse eigenschap die aangeeft of deze sandbox de standaardproductiesandbox voor de organisatie is.

eTag

Een id voor een specifieke versie van de sandbox. Deze waarde wordt gebruikt voor versiebeheer en caching-efficiëntie en wordt telkens bijgewerkt wanneer een wijziging in de sandbox wordt aangebracht.

Sandbox opzoeken lookup

U kunt een afzonderlijke sandbox opzoeken door een aanvraag voor een GET in te dienen die de eigenschap name van de sandbox bevat in het aanvraagpad.

API formaat

GET /sandboxes/{SANDBOX_NAME}

Parameter

Beschrijving

{SANDBOX_NAME}

De eigenschap name van de sandbox die u wilt opzoeken.

Verzoek

Met de volgende aanvraag wordt een sandbox met de naam "dev-2" opgehaald.

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

Reactie

Een succesvol antwoord retourneert de details van de sandbox, inclusief name , title , state en 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}"
}

Eigenschap

Beschrijving

name

De naam van de sandbox. Deze eigenschap wordt gebruikt voor opzoekdoeleinden in API-aanroepen.

title

De weergavenaam voor de sandbox.

state

De huidige verwerkingsstatus van de sandbox. De status van een sandbox kan een van de volgende zijn:

creërend: De zandbak is gecreeerd, maar nog wordt provisioned door het systeem.
actief: De zandbak wordt gecreeerd en actief.
ontbroken: wegens een fout, kon zandbak niet worden provisioned door het systeem en is gehandicapt.
geschrapt: De zandbak is manueel onbruikbaar gemaakt.

type

Het type sandbox. De volgende sandboxtypen worden momenteel ondersteund: development en production .

isDefault

Een Booleaanse eigenschap die aangeeft of deze sandbox de standaardsandbox voor de organisatie is. Dit is doorgaans de productiesandbox.

eTag

Een sandbox maken create

NOTE

Wanneer een nieuwe zandbak wordt gecreeerd, moet u die nieuwe zandbak aan uw productprofiel in Adobe Admin Consoleeerst toevoegen alvorens u kunt beginnen de nieuwe zandbak te gebruiken. Zie de documentatie over het leiden toestemmingen voor een productprofielvoor informatie over hoe te om een zandbak aan een productprofiel te verstrekken.

U kunt een nieuwe ontwikkelings- of productiestandaard maken door een POST aan te vragen bij het eindpunt /sandboxes .

Een ontwikkelingssandbox maken

Als u een ontwikkelingssandbox wilt maken, moet u een type -kenmerk met de waarde development opgeven in de payload van de aanvraag.

API formaat

POST /sandboxes

Verzoek

Met het volgende verzoek wordt een nieuwe ontwikkelingssandbox gemaakt met de naam "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"
  }'

Eigenschap

Beschrijving

name

De id die wordt gebruikt voor toegang tot de sandbox in toekomstige aanvragen. Deze waarde moet uniek zijn, en de beste praktijken moeten het zo beschrijvend mogelijk maken. Deze waarde mag geen spaties of speciale tekens bevatten.

title

Een leesbare naam die voor weergavedoeleinden in de gebruikersinterface van het platform wordt gebruikt.

type

Het type sandbox dat moet worden gemaakt. Voor een niet-productiesandbox moet deze waarde development zijn.

Reactie

Een succesvol antwoord retourneert de details van de nieuwe sandbox, waarbij wordt getoond dat de state ervan 'creeert' is.

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

NOTE

Sandboxen nemen ongeveer 30 seconden in beslag om door het systeem te worden ingericht, waarna hun state ''actief'' of ''mislukt'' worden.

Een productiesandbox maken

Als u een productiesandbox wilt maken, moet u een type -kenmerk met de waarde production opgeven in de payload van de aanvraag.

API formaat

POST /sandboxes

Verzoek

Met het volgende verzoek wordt een nieuwe productiesandbox gemaakt met de naam "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"
}'

Eigenschap

Beschrijving

name

title

Een leesbare naam die voor weergavedoeleinden in de gebruikersinterface van het platform wordt gebruikt.

type

Het type sandbox dat moet worden gemaakt. Voor een productiesandbox moet deze waarde production zijn.

Reactie

Een succesvol antwoord retourneert de details van de nieuwe sandbox, waarbij wordt getoond dat de state ervan 'creeert' is.

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

NOTE

Sandboxen nemen ongeveer 30 seconden in beslag om door het systeem te worden ingericht, waarna hun state ''actief'' of ''mislukt'' worden.

Een sandbox bijwerken put

U kunt een of meer velden in een sandbox bijwerken door een PATCH-aanvraag in te dienen die de sandbox name bevat in het aanvraagpad en de eigenschap die moet worden bijgewerkt in de aanvraaglading.

NOTE

Momenteel kan alleen de eigenschap title van een sandbox worden bijgewerkt.

API formaat

PATCH /sandboxes/{SANDBOX_NAME}

Parameter

Beschrijving

{SANDBOX_NAME}

De eigenschap name van de sandbox die u wilt bijwerken.

Verzoek

Met de volgende aanvraag wordt de eigenschap title van de sandbox met de naam "acme" bijgewerkt.

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

Reactie

Een geslaagde reactie retourneert HTTP-status 200 (OK) met de details van de zojuist bijgewerkte sandbox.

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

Een sandbox opnieuw instellen reset

Sandboxen hebben een functie voor fabrieksinstellingen waarmee alle niet-standaardbronnen uit een sandbox worden verwijderd. U kunt een sandbox opnieuw instellen door een PUT-aanvraag in te dienen die de sandbox name bevat in het aanvraagpad.

API formaat

PUT /sandboxes/{SANDBOX_NAME}

Parameter

Beschrijving

{SANDBOX_NAME}

De eigenschap name van de sandbox die u wilt herstellen.

validationOnly

Een optionele parameter waarmee u een controle voorafgaand aan de vlucht kunt uitvoeren op de sandbox-herstelbewerking zonder de eigenlijke aanvraag in te dienen. Stel deze parameter in op validationOnly=true om te controleren of de sandbox die u wilt herstellen Adobe Analytics-, Adobe Audience Manager- of segmentdelingsgegevens bevat.

Verzoek

Met de volgende aanvraag wordt een sandbox met de naam "acme-dev" opnieuw ingesteld.

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

Eigenschap

Beschrijving

action

Deze parameter moet in de payload van de aanvraag worden opgegeven met de waarde "reset" om de sandbox opnieuw in te stellen.

Reactie

NOTE

Wanneer een sandbox opnieuw is ingesteld, duurt het ongeveer 30 seconden voordat het systeem de sandbox heeft ingericht.

Wanneer de reactie met succes is uitgevoerd, worden de details van de bijgewerkte sandbox geretourneerd, waarbij wordt getoond dat de waarde van de sandbox state opnieuw wordt ingesteld.

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

De standaardproductiezandbak en om het even welke gebruiker-gecreeerde productiesandboxes kunnen niet worden teruggesteld als de identiteitsgrafiek binnen het ook door Adobe Analytics voor de Analyse van het Apparaat van het Kruis (CDA) wordt ontvangeneigenschap, of als de identiteitsgrafiek binnen het ook door Adobe Audience Manager voor de Mensen Gebaseerde Doelen (PBD)wordt gebruikt eigenschap.

Hieronder volgt een lijst met mogelijke uitzonderingen die kunnen voorkomen dat een sandbox opnieuw wordt ingesteld:

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

U kunt doorgaan met het opnieuw instellen van een productiesandbox die wordt gebruikt voor bidirectioneel segmentdelen met Audience Manager of Audience Core Service door de parameter ignoreWarnings aan uw aanvraag toe te voegen.

API formaat

PUT /sandboxes/{SANDBOX_NAME}?ignoreWarnings=true

Parameter

Beschrijving

{SANDBOX_NAME}

De eigenschap name van de sandbox die u wilt herstellen.

ignoreWarnings

Een optionele parameter waarmee u de validatiecontrole kunt overslaan en de reset kunt forceren van een productiesandbox die wordt gebruikt voor bidirectioneel segmentdelen met Audience Manager of Audience Core Service . Deze parameter kan niet worden toegepast op een standaardproductiesandbox.

Verzoek

In het volgende verzoek wordt een productiesandbox met de naam "acme" opnieuw ingesteld.

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

Reactie

Wanneer de reactie met succes is uitgevoerd, worden de details van de bijgewerkte sandbox geretourneerd, waarbij wordt getoond dat de waarde van de sandbox state opnieuw wordt ingesteld.

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

Een sandbox verwijderen delete

IMPORTANT

De standaardproductiesandbox kan niet worden verwijderd.

U kunt een sandbox verwijderen door een DELETE-aanvraag in te dienen die de sandbox name bevat in het aanvraagpad.

NOTE

Als u deze API-aanroep maakt, wordt de eigenschap status van de sandbox bijgewerkt naar "verwijderd" en wordt deze gedeactiveerd. Met GET-aanvragen kunnen de gegevens van de sandbox nog steeds worden opgehaald nadat deze zijn verwijderd.

API formaat

DELETE /sandboxes/{SANDBOX_NAME}

Parameter

Beschrijving

{SANDBOX_NAME}

De name van de sandbox die u wilt verwijderen.

validationOnly

Een optionele parameter waarmee u een controle voorafgaand aan de vlucht kunt uitvoeren op de sandbox-verwijderbewerking zonder de eigenlijke aanvraag in te dienen. Stel deze parameter in op validationOnly=true om te controleren of de sandbox die u wilt herstellen Adobe Analytics-, Adobe Audience Manager- of segmentdelingsgegevens bevat.

ignoreWarnings

Een optionele parameter waarmee u de validatiecontrole kunt overslaan en de verwijdering kunt forceren van een door de gebruiker gemaakte productiesandbox die wordt gebruikt voor bidirectioneel segmentdelen met Audience Manager of Audience Core Service . Deze parameter kan niet worden toegepast op een standaardproductiesandbox.

Verzoek

Met het volgende verzoek wordt een productiesandbox met de naam "acme" verwijderd.

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

Reactie

Een succesvol antwoord retourneert de bijgewerkte details van de sandbox, waarbij wordt getoond dat de state ervan is "verwijderd".

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

recommendation-more-help

e243ad8f-a318-46b3-9930-159a80f82b42