Show Menu
主题×

查找沙箱

通过发出GET请求(请求路径中包含沙箱的属性),可以查 name 找单个沙箱。
API格式
GET /sandboxes/{SANDBOX_NAME}

参数
描述
{SANDBOX_NAME}
name 查找的沙箱的属性。
请求
以下请求检索名为“dev-2”的沙箱。
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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应
成功的响应会返回沙箱的详细信息, name 包括 title 沙箱 state 、和 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}"
}

属性
描述
name
沙箱的名称。 用于API调用中的查找目的。
title
沙箱的显示名称。
state
沙箱的当前处理状态。 沙箱的状态可以是以下任一状态:
  • 创建 :沙箱已创建,但系统仍在提供。
  • 活动 :沙箱已创建并处于活动状态。
  • 失败 :由于出错,沙箱无法由系统提供并被禁用。
  • 已删除 :已手动禁用沙箱。
type
沙箱类型,“开发”或“生产”。
isDefault
一个布尔属性,用于指示此沙箱是否是组织的默认沙箱。 通常,这是生产沙箱。
eTag
沙箱的特定版本的标识符。 用于版本控制和缓存效率,每次对沙箱进行更改时都会更新此值。