可用的沙箱端點

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

主題：

建立對象：

開發人員

NOTE

與沙箱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: {ORG_ID}'

回應

成功的回應會傳回目前使用者可用的沙箱清單，包括name、title、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}"
        }
    ],
    "_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

特定版本沙箱的識別碼。用於版本控制和快取效率，每次對沙箱進行變更時都會更新此值。

recommendation-more-help

e243ad8f-a318-46b3-9930-159a80f82b42