Sandbox-beheereindpunt

4 april 2025
  • 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 Experience 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 welke Experience Platform API met succes te maken.

Een lijst met sandboxen ophalen

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

API formaat

GET /sandboxes?{QUERY_PARAMS}
ParameterBeschrijving
{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
        }
    }
}
EigenschapBeschrijving
nameDe naam van de sandbox. Deze eigenschap wordt gebruikt voor opzoekdoeleinden in API-aanroepen.
titleDe 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.
typeHet type sandbox. Tot de momenteel ondersteunde sandboxtypen behoren development en production .
isDefaultEen Booleaanse eigenschap die aangeeft of deze sandbox de standaardproductiesandbox voor de organisatie is.
eTagEen 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

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

API formaat

GET /sandboxes/{SANDBOX_NAME}
ParameterBeschrijving
{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}"
}
EigenschapBeschrijving
nameDe naam van de sandbox. Deze eigenschap wordt gebruikt voor opzoekdoeleinden in API-aanroepen.
titleDe 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.
typeHet type sandbox. De volgende sandboxtypen worden momenteel ondersteund: development en production .
isDefaultEen Booleaanse eigenschap die aangeeft of deze sandbox de standaardsandbox voor de organisatie is. Dit is doorgaans de productiesandbox.
eTagEen 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.