Entornos limitados de lista en la API

Para lista de todos los entornos limitados que pertenecen a su organización de IMS (activa o de otro modo), realice una solicitud de GET al extremo /sandboxes.

Formato API

GET /sandboxes?{QUERY_PARAMS}
Parámetro Descripción
{QUERY_PARAMS} Parámetros de consulta opcionales para filtrar los resultados. Consulte la sección sobre parámetros de consulta para obtener más información.

Solicitud

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

Respuesta

Una respuesta correcta devuelve una lista de entornos limitados que pertenecen a su organización, incluidos detalles como name, title, state y 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-int.adobe.io:443/data/foundation/sandbox-management/sandboxes?offset=1&limit=1",
            "templated": null
        }
    }
}
Propiedad Descripción
name Nombre del simulador para pruebas. Se utiliza con fines de búsqueda en llamadas de API.
title Nombre para mostrar del simulador para pruebas.
state Estado de procesamiento actual del simulador para pruebas. El estado de un simulador para pruebas puede ser cualquiera de los siguientes:
  • creación: Se ha creado el simulador para pruebas, pero el sistema sigue aprovisionándolo.
  • activo: El simulador para pruebas se crea y se activa.
  • error: Debido a un error, el sistema no pudo aprovisionar el simulador para pruebas y está deshabilitado.
  • eliminado: El simulador para pruebas se ha deshabilitado manualmente.
type El tipo de entorno limitado, ya sea "desarrollo" o "producción".
isDefault Una propiedad booleana que indica si este entorno limitado es el entorno limitado predeterminado para la organización. Generalmente este es el entorno limitado de producción.
eTag Identificador de una versión específica del simulador para pruebas. Este valor se utiliza para el control de versiones y la eficacia del almacenamiento en caché y se actualiza cada vez que se realiza un cambio en el simulador para pruebas.

Uso de parámetros de consulta

La API Sandbox admite el uso de parámetros de consulta para filtrar los resultados de la página al enumerar los entornos limitados.

NOTA

Los parámetros de consulta limit y offset deben especificarse juntos. Si solo especifica uno, la API devolverá un error. Si especifica ninguno, el límite predeterminado es 50 y el desplazamiento es 0.

Parámetro Descripción
limit El número máximo de registros que se devolverá en la respuesta.
offset Número de entidades desde el primer registro hasta el inicio (desplazamiento) de la lista de respuesta.

En esta página

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free