列表所有沙箱

要列表属于您的IMS组织(活动或其他)的所有沙箱,请向端点发出GET请 /sandboxes 求。

API格式

GET /sandboxes?{QUERY_PARAMS}
参数 描述
{QUERY_PARAMS} 可选查询参数,用于筛选结果。 有关详细信息,请 参阅查询 参数一节。

请求

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

响应

成功的响应会返回属于您的组织的一列表沙箱,包括诸如 nametitle、和 state等详细信息 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
        }
    }
}
属性 描述
name 沙箱的名称。 用于API调用中的查找目的。
title 沙箱的显示名称。
state 沙箱的当前处理状态。 沙箱的状态可以是以下任一状态:
  • 创建:沙箱已创建,但系统仍在提供。
  • 活动:沙箱已创建并处于活动状态。
  • 失败:由于出错,沙箱无法由系统提供并被禁用。
  • 已删除:已手动禁用沙箱。
type 沙箱类型,“开发”或“生产”。
isDefault 一个布尔属性,用于指示此沙箱是否是组织的默认沙箱。 通常,这是生产沙箱。
eTag 沙箱的特定版本的标识符。 用于版本控制和缓存效率,每次对沙箱进行更改时都会更新此值。

使用查询参数

API Sandbox 支持在列出沙箱时使用查询参数进行页面和筛选结果。

注意

必须 limit 同时 offset 指定查询和参数。 如果仅指定一个,API将返回错误。 如果指定无,则默认限制为50,偏移为0。

参数 描述
limit 响应中要返回的最大记录数。
offset 从第一个记录到响应开始(偏移)的实体数。

在此页面上