可用沙箱端点

注意

与沙盒API中提供的其他端点不同,此端点适用于所有用户,包括那些没有沙盒管理访问权限的用户。

通过向可用沙箱端点发出GET请求,可以列出当前用户可用的沙箱。

API格式

GET /{QUERY_PARAMS}
参数 描述
{QUERY_PARAMS} 用于按筛选结果的可选查询参数。 有关可用参数的列表,请参阅附录文档

请求

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

响应

成功响应会返回可供当前用户使用的沙箱列表,包括详细信息,如nametitlestatetype

{
    "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
        }
    }
}
属性 描述
name 沙盒的名称。 用于API调用中的查找目的。
title 沙盒的显示名称。
state 沙盒的当前处理状态。 沙盒的状态可以是以下任一状态:
  • creating:沙盒已创建,但仍由系统进行配置。
  • active:沙盒已创建并处于活动状态。
  • failed:由于错误,系统无法配置沙盒并禁用该沙盒。
  • deleted:已手动禁用沙盒。
type 沙盒类型,“开发”或“生产”。
isDefault 布尔属性,用于指示此沙盒是否为组织的默认生产沙盒。
eTag 沙盒特定版本的标识符。 对于版本控制和缓存效率,每当对沙盒进行更改时,都会更新此值。

在此页面上