Show Menu
トピック×

現在のユーザー用のリストアクティブサンドボックス

Sandbox APIで提供される他のエンドポイントとは異なり、このエンドポイントは、Sandbox管理アクセス権限のないユーザーも含め、すべてのユーザーが使用できます。
ルート( / )エンドポイントにGETリクエストを行うことで、現在のユーザーに対してアクティブなサンドボックスをリストできます。
API形式
GET /

リクエスト
curl -X GET \
  https://platform.adobe.io/data/foundation/sandbox-management \
  -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 ます。
{
    "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
サンドボックスの名前です。 API呼び出しで参照用に使用されます。
title
サンドボックスの表示名です。
state
サンドボックスの現在の処理状態です。 サンドボックスの状態は、次のいずれかになります。
  • 作成 : サンドボックスは作成されましたが、システムによってプロビジョニングされています。
  • active : サンドボックスが作成され、アクティブになります。
  • 失敗 : エラーが発生したため、サンドボックスはシステムでプロビジョニングできず、無効になっています。
  • 削除済み : サンドボックスは手動で無効になっています。
type
サンドボックスタイプ(「開発版」または「実稼働版」)。
isDefault
このサンドボックスが組織のデフォルトのサンドボックスであるかどうかを示すブールプロパティです。 通常、これは実稼働用サンドボックスです。
eTag
サンドボックスの特定のバージョンの識別子。 バージョン管理とキャッシュの効率性を考慮して、この値はサンドボックスに対して変更が行われるたびに更新されます。