일정 끝점
예약은 하루에 한 번 배치 세분화 작업을 자동으로 실행하는 데 사용할 수 있는 도구입니다. 다음을 사용할 수 있습니다. /config/schedules
일정 목록을 검색하거나, 새 일정을 만들거나, 특정 일정의 세부 정보를 검색하거나, 특정 일정을 업데이트하거나, 특정 일정을 삭제하는 끝점입니다.
시작하기
이 안내서에 사용된 끝점은 Adobe Experience Platform Segmentation Service API. 계속하기 전에 다음을 검토하십시오. 시작 안내서 필수 헤더와 예제 API 호출을 읽는 방법 등 API를 성공적으로 호출하기 위해 알아야 하는 중요한 정보입니다.
일정 목록 검색 retrieve-list
에 GET 요청을 하여 조직의 모든 일정 목록을 검색할 수 있습니다. /config/schedules
엔드포인트.
API 형식
다음 /config/schedules
엔드포인트는 결과를 필터링하는 데 도움이 되는 몇 가지 쿼리 매개 변수를 지원합니다. 이러한 매개 변수는 선택 사항이지만 값비싼 오버헤드를 줄이는 데 도움이 되도록 사용하는 것이 좋습니다. 매개 변수 없이 이 끝점을 호출하면 조직에서 사용할 수 있는 모든 일정을 검색합니다. 여러 매개 변수를 포함할 수 있으며 앰퍼샌드(&
).
GET /config/schedules
GET /config/schedules?start={START}
GET /config/schedules?limit={LIMIT}
{START}
{LIMIT}
요청
다음 요청은 조직 내에 게시된 마지막 10개의 일정을 검색합니다.
curl -X GET https://platform.adobe.io/data/core/ups/config/schedules?limit=10 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공적인 응답은 지정된 조직에 대한 일정 목록이 JSON인 HTTP 상태 200을 반환합니다.
{
"_page": {
"totalCount": 10,
"pageSize": 1
},
"children": [
{
"id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"sandboxName": "prod",
"type": "production",
"default": true
},
"name": "Batch Segmentation",
"state": "active",
"type": "batch_segmentation",
"schedule": "0 0 1 * * ?",
"properties": {
"segments": []
},
"createEpoch": 1573158851,
"updateEpoch": 1574365202
}
],
"_links": {
"next": {}
}
}
_page.totalCount
_page.pageSize
children.name
children.type
children.properties
children.properties.segments
["*"]
는 모든 세그먼트가 포함되어 있는지 확인합니다.children.schedule
children.state
새 일정 만들기 create
에 POST 요청을 하여 새 일정을 만들 수 있습니다. /config/schedules
엔드포인트.
API 형식
POST /config/schedules
요청
curl -X POST https://platform.adobe.io/data/core/ups/config/schedules \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '
{
"name":"profile-default",
"type":"batch_segmentation",
"properties":{
"segments":[
"*"
]
},
"schedule":"0 0 1 * * ?",
"state":"inactive"
}'
name
type
properties
properties.segments
type
은 "batch_segmentation"과 같습니다. 사용 ["*"]
는 모든 세그먼트가 포함되어 있는지 확인합니다.schedule
이 문자열을 제공하지 않으면 시스템에서 생성한 일정이 자동으로 생성됩니다.
state
응답
성공한 응답은 새로 만든 일정의 세부 정보와 함께 HTTP 상태 200을 반환합니다.
{
"id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "e7e17720-c5bb-11e9-aafb-87c71c35cac8",
"sandboxName": "prod",
"type": "production",
"default": true
},
"name": "{SCHEDULE_NAME}",
"state": "inactive",
"type": "batch_segmentation",
"schedule": "0 0 1 * * ?",
"properties": {
"segments": [
"*"
]
},
"createEpoch": 1568267948,
"updateEpoch": 1568267948
}
특정 일정 검색 get
에 GET 요청을 하여 특정 일정에 대한 자세한 정보를 검색할 수 있습니다. /config/schedules
엔드포인트 및 요청 경로에서 검색할 예약의 ID를 제공합니다.
API 형식
GET /config/schedules/{SCHEDULE_ID}
{SCHEDULE_ID}
id
검색할 일정의 값입니다.요청
curl -X GET https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공한 응답은 지정된 일정에 대한 자세한 정보와 함께 HTTP 상태 200을 반환합니다.
{
"id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "e7e17720-c5bb-11e9-aafb-87c71c35cac8",
"sandboxName": "prod",
"type": "production",
"default": true
},
"name": "{SCHEDULE_NAME}",
"state": "inactive",
"type": "batch_segmentation",
"schedule": "0 0 1 * * ?",
"properties": {
"segments": [
"*"
]
},
"createEpoch": 1568267948,
"updateEpoch": 1568267948
}
name
type
batch_segmentation
및 export
.properties
properties.segments
["*"]
는 모든 세그먼트가 포함되어 있는지 확인합니다.schedule
state
active
및 inactive
. 기본적으로 상태는 로 설정됩니다. inactive
.특정 일정에 대한 세부 정보 업데이트 update
에 PATCH 요청을 하여 특정 일정을 업데이트할 수 있습니다. /config/schedules
엔드포인트 및 요청 경로에서 업데이트하려는 예약의 ID를 제공합니다.
PATCH 요청을 사용하면 다음 중 하나를 업데이트할 수 있습니다. 상태 또는 cron 일정 개별 일정에 대해.
일정 상태 업데이트 update-state
JSON 패치 작업을 사용하여 스케줄의 상태를 업데이트할 수 있습니다. 상태를 업데이트하려면 다음을 선언합니다. path
다음으로 속성: /state
및 설정 value
다음 중 하나로 active
또는 inactive
. JSON 패치에 대한 자세한 내용은 JSON 패치 설명서를 참조하십시오.
API 형식
PATCH /config/schedules/{SCHEDULE_ID}
{SCHEDULE_ID}
id
업데이트할 일정의 값입니다.요청
curl -X PATCH https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '
[
{
"op": "add",
"path": "/state",
"value": "active"
}
]'
path
path
to "/state".value
응답
성공적인 응답은 HTTP 상태 204(콘텐츠 없음)를 반환합니다.
cron 일정 업데이트 update-schedule
JSON 패치 작업을 사용하여 cron 일정을 업데이트할 수 있습니다. 일정을 업데이트하려면 다음을 선언합니다. path
다음으로 속성: /schedule
및 설정 value
유효한 cron 일정에 따라. JSON 패치에 대한 자세한 내용은 JSON 패치 설명서를 참조하십시오. cron 일정에 대한 자세한 내용은 cron 표현식 형식.
API 형식
PATCH /config/schedules/{SCHEDULE_ID}
{SCHEDULE_ID}
id
업데이트할 일정의 값입니다.요청
curl -X PATCH https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '
[
{
"op":"add",
"path":"/schedule",
"value":"0 0 2 * * ?"
}
]'
path
path
끝 /schedule
.value
응답
성공적인 응답은 HTTP 상태 204(콘텐츠 없음)를 반환합니다.
특정 일정 삭제
에 DELETE 요청을 하여 특정 일정을 삭제하도록 요청할 수 있습니다. /config/schedules
엔드포인트 및 요청 경로에서 삭제하려는 예약의 ID를 제공합니다.
API 형식
DELETE /config/schedules/{SCHEDULE_ID}
{SCHEDULE_ID}
id
삭제할 일정의 값입니다.요청
curl -X DELETE https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공적인 응답은 HTTP 상태 204(콘텐츠 없음)를 반환합니다.
다음 단계
이 안내서를 읽고 나면 이제 일정이 어떻게 돌아가는지에 대해 더 잘 이해할 수 있습니다.
부록 appendix
다음 부록에서는 일정에 사용되는 cron 표현식의 형식을 설명합니다.
형식
cron 표현식은 6개 또는 7개의 필드로 구성된 문자열입니다. 표현식은 다음과 유사합니다.
0 0 12 * * ?
cron 표현식 문자열에서 첫 번째 필드는 초를 나타내고, 두 번째 필드는 분을 나타내고, 세 번째 필드는 시간을 나타내고, 네 번째 필드는 요일을 나타내고, 다섯 번째 필드는 월을 나타내고, 여섯 번째 필드는 요일을 나타냅니다. 연도를 나타내는 일곱 번째 필드를 선택적으로 포함할 수도 있습니다.
, - * /
, - * /
, - * /
, - * ? / L W
, - * /
, - * ? / L #
, - * /
SUN
는 을 사용하는 것과 같습니다 sun
.허용되는 특수 문자는 다음 의미를 나타냅니다.
*
*
시간 필드에서 는 다음을 의미합니다 매 시간.?
3
날짜 필드 및 ?
(요일 필드)을 참조하십시오.-
9-15
시간 필드에서 시간은 9, 10, 11, 12, 13, 14 및 15를 의미합니다.,
MON, FRI, SAT
요일 필드에서 요일은 월요일, 금요일 및 토요일을 의미합니다./
/
에서 증가하는 위치를 결정하지만 값은 뒤에 배치됩니다. /
증분의 양을 결정합니다. 예를 들어 1/7
분 필드에서 분은 1, 8, 15, 22, 29, 36, 43, 50 및 57을 포함합니다.L
Last
는 사용되는 필드에 따라 다른 의미를 갖습니다. 날짜 필드와 함께 사용하는 경우 해당 월의 마지막 날을 나타냅니다. 요일 필드와 함께 단독으로 사용하는 경우 해당 주의 마지막 날인 토요일(SAT
). 다른 값과 함께 요일 필드를 사용하는 경우 해당 월의 해당 유형의 마지막 날을 나타냅니다. 예를 들어 5L
요일 필드에서는 전용 해당 월의 마지막 금요일을 포함합니다.W
18W
날짜 필드는 해당 월의 18일이 토요일인 경우 가장 가까운 평일인 17일 금요일에 트리거됩니다. 만약 그달 18일이 일요일이었다면 월요일과 평일이 가장 가까운 19일에 트리거됩니다. 다음을 넣으면 주의하십시오. 1W
날짜 필드에서 가장 가까운 요일이 이전 달에 있는 경우에도 이벤트는 가장 가까운 요일에 트리거됩니다. 현재 월.또한 결합할 수 있습니다
L
및 W
제작 LW
: 해당 월의 마지막 요일을 지정합니다.#
#
은 요일을 나타내고, 값은 다음 뒤에 배치됩니다. #
해당 월의 발생 횟수를 나타냅니다. 예를 들어 1#3
, 이벤트는 그 달의 세 번째 일요일에 트리거됩니다. 다음을 넣으면 주의하십시오. X#5
그리고 그 달에는 그 주의 그 날에 다섯 번째 발생하는 일이 없습니다. 아님 트리거됩니다. 예를 들어 1#5
, 그리고 그 달에는 다섯 번째 일요일이 없습니다. 이 이벤트는 아님 트리거됩니다.예시
다음 표에서는 샘플 cron 표현식 문자열을 보여 주고 그 의미를 설명합니다.
0 0 13 * * ?
0 30 9 * * ? 2022
0 * 18 * * ?
0 0/10 17 * * ?
0 13,38 5 ? 6 WED
0 30 12 ? * 4#3
0 30 12 ? * 6L
0 45 11 ? * MON-THU