createTrigger

VPC 환경에서 이용 가능합니다.

트리거를 생성합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/api/v1/triggers

요청 헤더

Data Flow API에서 공통으로 사용하는 헤더에 대한 정보는 Data Flow 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`name`	String	Required	작업 이름 영문자, 숫자, 특수 문자 '_', '-'를 조합하여 3~100자 이내로 입력 문자열의 시작은 영문자 또는 '_'로 구성
`type`	String	Required	트리거 유형 `SCHEDULED` \| `EVENT` \| `NONE` `SCHEDULED`: 주기 또는 특정일 실행 `EVENT`: 특정 이벤트 발생 시 실행(추후 지원 예정) `NONE`: 트리거 미설정(수동 실행)
`triggerRule`	Object	Required	트리거 실행 옵션
`triggerRule.type`	String	Required	트리거 실행 옵션 유형 `RECURRING` \| `ONE_TIME` \| `NONE` `RECURRING`: 주기 실행 `ONE_TIME`: 특정일 실행 `NONE`: 실행 옵션 없음
`triggerRule.interval`	String	Conditional	트리거 실행 주기 `HOUR` \| `DAY` \| `WEEK` \| `MONTH` `HOUR`: 매시간 `DAY`: 매일 `WEEK`: 매주 `MONTH`: 매월 `triggerRule.type`이 `RECURRING`인 경우, 필수 입력
`triggerRule.time`	String	Conditional	트리거 반복 실행 시간(분 또는 시각) `triggerRule.type`이 `RECURRING`인 경우, 필수 입력 `triggerRule.interval`이 `HOUR`인 경우, 반복할 분 입력 (00~59) `triggerRule.interval`이 `DAY`, `WEEK`, `MONTH`인 경우, 반복할 시각 입력
`triggerRule.dayOfWeek[]`	Array	Conditional	트리거 반복 실행 요일 `MONDAY` \| `TUESDAY` \| `WEDNESDAY` \| `THURSDAY` \| `FRIDAY` \| `SATURDAY` \| `SUNDAY` `triggerRule.interval`이 `WEEK`인 경우, 필수 입력
`triggerRule.dateOfMonth`	String	Conditional	트리거 반복 실행 날짜 1~31 사이의 날짜, -1(매월 말일) `triggerRule.interval`이 `MONTH`인 경우, 필수 입력
`triggerRule.executionDate`	String	Conditional	트리거 실행 일시 `triggerRule.type`이 `ONE_TIME`인 경우, 필수 입력

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://dataflow.apigw.ntruss.com/api/v1/triggers' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "name": "trigger001",
  "type": "SCHEDULED",
  "triggerRule": {
    "type": "RECURRING",
    "interval": "DAY",
    "time": "10:00"
  }
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`triggerId`	String	-	트리거 아이디
`name`	String	-	트리거 이름
`type`	String	-	트리거 실행 옵션 `SCHEDULED` \| `NONE` `SCHEDULED`: 주기 또는 특정일 실행 `NONE`: 실행 옵션 없음
`triggerRule`	Object	-	트리거 실행 옵션 정보
`triggerRule.type`	String	-	트리거 실행 옵션 유형 `RECURRING` \| `ONE_TIME` \| `NONE` `RECURRING`: 주기 실행 `ONE_TIME`: 특정일 실행 `NONE`: 실행 옵션 없음
`triggerRule.interval`	String	-	트리거 실행 주기 `HOUR` \| `DAY` \| `WEEK` \| `MONTH` `HOUR`: 매시간 `DAY`: 매일 `WEEK`: 매주 `MONTH`: 매월 `triggerRule.type`이 `RECURRING`인 경우, 표시
`triggerRule.time`	String	-	트리거 반복 실행 시간(분 또는 시각) `triggerRule.type`이 `RECURRING`인 경우, 표시 `triggerRule.interval`이 `HOUR`인 경우, 반복할 분 표시(00~59) `triggerRule.interval`이 `DAY`, `WEEK`, `MONTH`인 경우, 반복할 시각 표시
`triggerRule.dayOfWeek[]`	Array	-	트리거 반복 실행 요일 `MONDAY` \| `TUESDAY` \| `WEDNESDAY` \| `THURSDAY` \| `FRIDAY` \| `SATURDAY` \| `SUNDAY` `triggerRule.interval`이 `WEEK`인 경우, 표시
`triggerRule.dateOfMonth`	String	-	트리거 반복 실행 날짜 1~31 사이의 날짜, -1(매월 말일) `triggerRule.interval`이 `MONTH`인 경우, 표시
`triggerRule.executionDate`	String	-	트리거 실행 일시 `triggerRule.type`이 `ONE_TIME`인 경우, 표시
`createdDate`	String	-	트리거 생성 일시 ISO 8601 형식(UTC+9 포함)
`updatedDate`	String	-	트리거 수정 일시 ISO 8601 형식(UTC+9 포함)

응답 상태 코드

Data Flow API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Data Flow API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "triggerId": "rWOjcW******",
    "name": "trigger1",
    "type": "SCHEDULED",
    "triggerRule": {
        "type": "RECURRING",
        "interval": "DAY",
        "time": "10:00"
    },
    "createdDate": "2025-03-21T15:26:51+09:00",
    "updatedDate": "2025-03-21T15:26:51+09:00"
}