Dokumentation Experience Platform Handbuch zu Sandboxes

Verfügbare Sandbox-Endpunkte

Last update: Wed Feb 28 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Themen:
Sandboxes

Erstellt für:

Entwickler

NOTE

Im Gegensatz zu anderen Endpunkten, die in der Sandbox-API bereitgestellt werden, steht dieser Endpunkt allen Benutzern zur Verfügung, auch solchen ohne Sandbox Administration-Zugriffsberechtigungen.

Sie können die für den aktuellen Benutzer verfügbaren Sandboxes auflisten, indem Sie eine GET-Anfrage an den verfügbaren Sandbox-Endpunkt senden.

API-Format

GET /{QUERY_PARAMS}

Parameter

Beschreibung

{QUERY_PARAMS}

Optionale Abfrageparameter zum Filtern der Ergebnisse. Siehe Anlagendokument für eine Liste der verfügbaren Parameter.

Anfrage

curl -X GET \
  https://platform.adobe.io/data/foundation/sandbox-management/?limit=3&offset=1 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'

Antwort

Eine erfolgreiche Antwort gibt eine Liste von Sandboxes zurück, die für den aktuellen Benutzer verfügbar sind, einschließlich Details wie name, title, state, und 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}"
        }
    ],
    "_page": {
        "limit": 3,
        "count": 1
    },
    "_links": {
        "page": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/?limit={limit}&offset={offset}",
            "templated": true
        }
    }
}

Eigenschaft

Beschreibung

name

Der Name der Sandbox. Dient zum Suchen in API-Aufrufen.

title

Der Anzeigename für die Sandbox.

state

Der aktuelle Verarbeitungsstatus der Sandbox. Der Status einer Sandbox kann wie folgt lauten:

creating: Die Sandbox wurde erstellt, wird jedoch weiterhin vom System bereitgestellt.
active: Die Sandbox wird erstellt und aktiv.
failed: Aufgrund eines Fehlers konnte die Sandbox nicht vom System bereitgestellt werden und ist deaktiviert.
deleted: Die Sandbox wurde manuell deaktiviert.

type

Der Sandbox-Typ, entweder „Entwicklung“ oder „Produktion“.

isDefault

Eine boolesche Eigenschaft, die angibt, ob diese Sandbox die standardmäßige Produktions-Sandbox für die Organisation ist.

eTag

Eine Kennung für eine bestimmte Version der Sandbox. Dieser Wert erleichtert Versionskontrolle und Caching und wird bei jeder Änderung an der Sandbox aktualisiert.

recommendation-more-help

e243ad8f-a318-46b3-9930-159a80f82b42