DocumentaçãoExperience PlatformGuia de Sandoxes

Ponto de extremidade de sandboxes disponível

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Desenvolvedor
NOTE
Ao contrário de outros endpoints fornecidos na API de sandbox, esse endpoint está disponível para todos os usuários, incluindo aqueles sem permissões de acesso de Administração de sandbox.

Você pode listar as sandboxes que estão disponíveis para o usuário atual fazendo uma solicitação GET para o ponto de extremidade das sandboxes disponíveis.

Formato da API

GET /{QUERY_PARAMS}
Parâmetro
Descrição
{QUERY_PARAMS}
Parâmetros de consulta opcionais para filtrar os resultados. Consulte o documento do apêndice para obter uma lista de parâmetros disponíveis.

Solicitação

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

Resposta

Uma resposta bem-sucedida retorna uma lista de sandboxes disponíveis para o usuário atual, incluindo detalhes como name, title, state e 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
        }
    }
}
Propriedade
Descrição
name
O nome da sandbox. Usado para fins de pesquisa em chamadas de API.
title
O nome de exibição da sandbox.
state

O estado de processamento atual da sandbox. O estado de uma sandbox pode ser qualquer um dos seguintes:

  • creating: a sandbox foi criada, mas ainda está sendo provisionada pelo sistema.
  • active: a sandbox foi criada e está ativa.
  • failed: devido a um erro, a sandbox não pôde ser provisionada pelo sistema e está desabilitada.
  • deleted: a sandbox foi desabilitada manualmente.
type
O tipo de sandbox, "desenvolvimento" ou "produção".
isDefault
Uma propriedade booleana que indica se essa sandbox é a sandbox de produção padrão da organização.
eTag
Um identificador para uma versão específica da sandbox. Usado para controlar a versão e a eficiência do armazenamento em cache, esse valor é atualizado sempre que uma alteração é feita na sandbox.
recommendation-more-help
e243ad8f-a318-46b3-9930-159a80f82b42