샌드박스 관리 엔드포인트
Adobe Experience Platform의 샌드박스는 프로덕션 환경에 영향을 주지 않고 기능을 테스트하고 실험을 실행하며 사용자 지정 구성을 만들 수 있는 격리된 개발 환경을 제공합니다. 다음 /sandboxes
의 엔드포인트 Sandbox API를 사용하면 플랫폼에서 샌드박스를 프로그래밍 방식으로 관리할 수 있습니다.
시작하기
이 안내서에 사용된 API 끝점은 Sandbox API. 계속하기 전에 다음을 검토하십시오. 시작 안내서 관련 설명서에 대한 링크, 이 문서의 샘플 API 호출 읽기에 대한 안내서 및 Experience Platform API를 성공적으로 호출하는 데 필요한 필수 헤더에 대한 중요 정보입니다.
샌드박스 목록 검색 list
에 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: {ORG_ID}' \
-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": "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.adobe.io:443/data/foundation/sandbox-management/sandboxes?offset=1&limit=1",
"templated": null
}
}
}
name
title
state
샌드박스의 현재 처리 상태입니다. 샌드박스의 상태는 다음 중 하나일 수 있습니다.
creating
: 샌드박스가 생성되었지만 시스템에 의해 아직 프로비저닝되고 있습니다.active
: 샌드박스가 생성되고 활성화됩니다.failed
: 오류로 인해 시스템에서 샌드박스를 프로비저닝할 수 없어 샌드박스가 비활성화되었습니다.deleted
: 샌드박스가 수동으로 비활성화되었습니다.
type
development
및 production
.isDefault
eTag
샌드박스 조회 lookup
샌드박스를 포함하는 GET 요청을 만들어 개별 샌드박스를 조회할 수 있습니다. name
요청 경로의 속성입니다.
API 형식
GET /sandboxes/{SANDBOX_NAME}
{SANDBOX_NAME}
name
조회할 샌드박스의 속성입니다.요청
다음 요청은 "dev-2"라는 샌드박스를 검색합니다.
curl -X GET \
https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/dev-2 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
응답
성공한 응답은 다음을 포함하여 샌드박스의 세부 정보를 반환합니다. name
, title
, state
, 및 type
.
{
"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}"
}
name
title
state
샌드박스의 현재 처리 상태입니다. 샌드박스의 상태는 다음 중 하나일 수 있습니다.
- 생성 중: 샌드박스가 생성되었지만 시스템에 의해 아직 프로비저닝되고 있습니다.
- 활성: 샌드박스가 생성되고 활성화됩니다.
- 실패: 오류로 인해 시스템에서 샌드박스를 프로비저닝할 수 없어 샌드박스가 비활성화되었습니다.
- 삭제됨: 샌드박스가 수동으로 비활성화되었습니다.
type
development
및 production
.isDefault
eTag
샌드박스 만들기 create
에 POST 요청을 하여 새 개발 또는 프로덕션 샌드박스를 만들 수 있습니다. /sandboxes
엔드포인트.
개발 샌드박스 만들기
개발 샌드박스를 생성하려면 다음을 제공해야 합니다. type
값이 인 속성 development
요청 페이로드에서.
API 형식
POST /sandboxes
요청
다음 요청은 "acme-dev"라는 새 개발 샌드박스를 생성합니다.
curl -X POST \
https://platform.adobe.io/data/foundation/sandbox-management/sandboxes \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json' \
-d '{
"name": "acme-dev",
"title": "Acme Business Group dev",
"type": "development"
}'
name
title
type
development
.응답
성공적인 응답은 새로 생성된 샌드박스의 세부 정보를 반환하며 state
은(는) "생성 중"입니다.
{
"name": "acme-dev",
"title": "Acme Business Group dev",
"state": "creating",
"type": "development",
"region": "VA7"
}
state
은 "활성" 또는 "실패"가 됩니다.프로덕션 샌드박스 만들기
프로덕션 샌드박스를 만들려면 다음을 제공해야 합니다. type
값이 인 속성 production
요청 페이로드에서.
API 형식
POST /sandboxes
요청
다음 요청은 "acme"라는 새 프로덕션 샌드박스를 생성합니다.
curl -X POST \
https://platform.adobe.io/data/foundation/sandbox-management/sandboxes \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H `Accept: application/json` \
-H 'Content-Type: application/json' \
-d '{
"name": "acme",
"title": "Acme Business Group",
"type": "production"
}'
name
title
type
production
.응답
성공적인 응답은 새로 생성된 샌드박스의 세부 정보를 반환하며 state
은(는) "생성 중"입니다.
{
"name": "acme",
"title": "Acme Business Group",
"state": "creating",
"type": "production",
"region": "VA7"
}
state
은 "활성" 또는 "실패"가 됩니다.샌드박스 업데이트 put
샌드박스를 포함하는 PATCH 요청을 만들어 샌드박스에서 하나 이상의 필드를 업데이트할 수 있습니다 name
요청 경로 및 요청 페이로드에서 업데이트할 속성입니다.
title
속성을 업데이트할 수 있습니다.API 형식
PATCH /sandboxes/{SANDBOX_NAME}
{SANDBOX_NAME}
name
업데이트할 샌드박스의 속성입니다.요청
다음 요청은 title
"acme"라는 샌드박스의 속성입니다.
curl -X PATCH \
https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/acme \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json'
-d '{
"title": "Acme Business Group prod"
}'
응답
성공한 응답은 새로 업데이트된 샌드박스의 세부 정보와 함께 HTTP 상태 200(OK)을 반환합니다.
{
"name": "acme",
"title": "Acme Business Group prod",
"state": "active",
"type": "production",
"region": "VA7"
}
샌드박스 재설정 reset
샌드박스에는 샌드박스에서 기본값이 아닌 모든 리소스를 삭제하는 "공장 재설정" 기능이 있습니다. 샌드박스를 포함하는 PUT 요청을 수행하여 샌드박스를 재설정할 수 있습니다 name
요청 경로에서.
API 형식
PUT /sandboxes/{SANDBOX_NAME}
{SANDBOX_NAME}
name
재설정할 샌드박스의 속성입니다.validationOnly
validationOnly=true
을(를) 사용하여 재설정하려는 샌드박스에 Adobe Analytics, Adobe Audience Manager 또는 세그먼트 공유 데이터가 포함되어 있는지 확인합니다.요청
다음 요청은 "acme-dev"라는 샌드박스를 재설정합니다.
curl -X PUT \
https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/acme-dev?validationOnly=true \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json'
-d '{
"action": "reset"
}'
action
응답
성공한 응답은 업데이트된 샌드박스의 세부 정보를 반환하며 state
은(는) "재설정 중"입니다.
{
"id": "d8184350-dbf5-11e9-875f-6bf1873fec16",
"name": "acme-dev",
"title": "Acme Business Group dev",
"state": "resetting",
"type": "development",
"region": "VA7"
}
기본 프로덕션 샌드박스와 사용자가 만든 모든 프로덕션 샌드박스는 그 안에 호스팅되는 ID 그래프가 Adobe Analytics에서 용으로 사용되는 경우에도 재설정할 수 없습니다. CDA(Cross Device Analytics) 기능 또는 ID 그래프 내에서 호스팅되는 를 Adobe Audience Manager에서 사용자 기반 대상(PBD) 기능.
다음은 샌드박스가 재설정되지 않도록 할 수 있는 가능한 예외 목록입니다.
{
"status": 400,
"title": "Sandbox `{SANDBOX_NAME}` cannot be reset. The identity graph hosted in this sandbox is also being used by Adobe Analytics for the Cross Device Analytics (CDA) feature.",
"type": "http://ns.adobe.com/aep/errors/SMS-2074-400"
},
{
"status": 400,
"title": "Sandbox `{SANDBOX_NAME}` cannot be reset. The identity graph hosted in this sandbox is also being used by Adobe Audience Manager for the People Based Destinations (PBD) feature.",
"type": "http://ns.adobe.com/aep/errors/SMS-2075-400"
},
{
"status": 400,
"title": "Sandbox `{SANDBOX_NAME}` cannot be reset. The identity graph hosted in this sandbox is also being used by Adobe Audience Manager for the People Based Destinations (PBD) feature, as well by Adobe Analytics for the Cross Device Analytics (CDA) feature.",
"type": "http://ns.adobe.com/aep/errors/SMS-2076-400"
},
{
"status": 400,
"title": "Warning: Sandbox `{SANDBOX_NAME}` is used for bi-directional segment sharing with Adobe Audience Manager or Audience Core Service.",
"type": "http://ns.adobe.com/aep/errors/SMS-2077-400"
}
과 공유하는 양방향 세그먼트에 사용되는 프로덕션 샌드박스를 재설정하도록 진행할 수 있습니다 Audience Manager 또는 Audience Core Service 를 추가하여 ignoreWarnings
매개 변수를 요청에 추가합니다.
API 형식
PUT /sandboxes/{SANDBOX_NAME}?ignoreWarnings=true
{SANDBOX_NAME}
name
재설정할 샌드박스의 속성입니다.ignoreWarnings
요청
다음 요청은 "acme"라는 프로덕션 샌드박스를 재설정합니다.
curl -X PUT \
https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/acme?ignoreWarnings=true \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json'
-d '{
"action": "reset"
}'
응답
성공한 응답은 업데이트된 샌드박스의 세부 정보를 반환하며 state
은(는) "재설정 중"입니다.
{
"id": "d8184350-dbf5-11e9-875f-6bf1873fec16",
"name": "acme",
"title": "Acme Business Group prod",
"state": "resetting",
"type": "production",
"region": "VA7"
}
샌드박스 삭제 delete
샌드박스를 포함하는 DELETE 요청을 만들어 샌드박스를 삭제할 수 있습니다 name
요청 경로에서.
status
속성을 "삭제"로 변경하고 비활성화합니다. GET 요청은 삭제된 후에도 샌드박스의 세부 정보를 검색할 수 있습니다.API 형식
DELETE /sandboxes/{SANDBOX_NAME}
{SANDBOX_NAME}
name
을(를) 삭제하려는 샌드박스 입니다.validationOnly
validationOnly=true
을(를) 사용하여 재설정하려는 샌드박스에 Adobe Analytics, Adobe Audience Manager 또는 세그먼트 공유 데이터가 포함되어 있는지 확인합니다.ignoreWarnings
요청
다음 요청은 "acme"라는 프로덕션 샌드박스를 삭제합니다.
curl -X DELETE \
https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/acme?ignoreWarnings=true \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}'
응답
성공한 응답은 샌드박스의 업데이트된 세부 정보를 반환하며 state
은(는) "삭제됨"입니다.
{
"name": "acme",
"title": "Acme Business Group prod",
"state": "deleted",
"type": "development",
"region": "VA7"
}