Répertorier les environnements de test actifs de l’utilisateur actuel

Remarque

Contrairement aux autres points de terminaison fournis dans l’API Sandbox, ce point de terminaison est disponible pour tous les utilisateurs, y compris ceux ne disposant pas des autorisations d’accès à Sandbox Administration.

Vous pouvez répertorier les environnements de test actifs de l’utilisateur actuel en effectuant une requête GET sur le point de terminaison racine (/).

Format d’API

GET /{QUERY_PARAMS}
Paramètre Description
{QUERY_PARAMS} Paramètres de requête facultatifs pour filtrer les résultats en fonction. See the section on query parameters for more information.

Requête

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie une liste des environnements de test actifs de l’utilisateur actuel, y compris des détails tels que name, title, state et 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
        }
    }
}
Propriété Description
name Le nom de l’environnement de test. Utilisé à des fins de recherche dans les appels API.
title Le nom d’affichage de l’environnement de test.
state L’état de traitement actuel de l’environnement de test. L’état d’un environnement de test peut correspondre à l’un des suivants :
  • création : l’environnement de test a été créé, mais le système continue de le configurer.
  • actif : l’environnement de test est créé et actif.
  • échec : en raison d’une erreur, le système n’a pas pu configurer l’environnement de test et a été désactivé.
  • supprimé : l’environnement de test a été désactivé manuellement.
type Le type d’environnement de test : « développement » ou « production ».
isDefault Une propriété booléenne indiquant s’il s’agit de l’environnement de test par défaut de l’organisation. Il s’agit généralement de l’environnement de test de production.
eTag L’identifiant d’une version spécifique de l’environnement de test. Utilisée pour le contrôle des versions et une mise en cache efficace, cette valeur est mise à jour chaque fois que l’environnement de test est modifié.

Utilisation des paramètres de requête

L’ Sandbox API prend en charge l’utilisation de paramètres de requête pour la page et filtre les résultats lors de l’inscription de sandbox.

Remarque

Les paramètres limit et offset la requête doivent être spécifiés ensemble. Si vous n'en spécifiez qu'un seul, l'API renvoie une erreur. Si vous n’en spécifiez aucune, la limite par défaut est de 50 et le décalage est de 0.

Paramètre Description
limit Nombre maximal d'enregistrements à renvoyer dans la réponse.
offset Nombre d'entités entre le premier enregistrement et le début (décalé) de la liste de réponse.

Sur cette page