Show Menu
トピック×

現在のユーザーのアクティブなサンドボックスを一覧表示

Sandbox API で提供される他のエンドポイントとは異なり、このエンドポイントは、サンドボックス管理のアクセス権限を持たないユーザーも含め、すべてのユーザーが使用できます。
現在のユーザーのアクティブなサンドボックスのリストを作成するには、ルート( / )エンドポイントに 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
サンドボックスの現在の処理状態。サンドボックスの状態は、次のいずれかになります。
  • 作成 :サンドボックスは作成されましたが、システムによって引き続きプロビジョニングされています。
  • アクティブ :サンドボックスが作成され、アクティブです。
  • 失敗 :エラーが原因で、サンドボックスはシステムでプロビジョニングできず、無効になっています。
  • 削除 :サンドボックスは手動で無効にされています。
type
サンドボックスタイプ(「開発」または「実稼働」)。
isDefault
このサンドボックスが組織のデフォルトのサンドボックスであるかどうかを示すブール型のプロパティです。通常、これは実稼働用サンドボックスです。
eTag
サンドボックスの特定のバージョンの識別子。バージョン管理とキャッシュの効率化に使用され、この値はサンドボックスに変更が追加されるたびに更新されます。