Put Trigger

Prev Next

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

Cloud Functions 트리거를 생성, 수정합니다.

요청

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

메서드 URI
PUT /api/v2/triggers/{triggerName}
참고

싱가포르 리전과 일본 리전은 VPC 환경에서만 이용할 수 있습니다.

요청 헤더

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

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
triggerName String Required 트리거 이름
  • 영문자, 숫자, 특수문자 '-', '_'을 조합하여 1~50자 이내로 입력
  • '-'로 시작 불가
  • 다른 리소스(패키지, 액션, 트리거) 이름과 중복 불가

요청 쿼리 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
platform String Optional 플랫폼 구분
  • vpc | classic (기본값)
type String Required 트리거 유형
  • cron | github | insight | object_storage | source_commit
  • 생성 후 변경 불가

요청 바디

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

cron 트리거

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

필드 타입 필수 여부 설명
trigger Object Required 트리거 정보
trigger.description String Optional 트리거 설명(Byte)
  • 0~3,000
trigger.cronOption String Required cron 실행 옵션
trigger.parameters Object Optional 트리거의 기본 파라미터
  • {"key": "value"} 형태의 JSON
  • 트리거 실행 시 파라미터 적용 우선순위
    • 1순위: 실행 시점에 전달되는 런타임 파라미터
    • 2순위: 연결된 트리거의 기본 파라미터
    • 3순위: 액션의 기본 파라미터
    • 4순위: 포함된 패키지의 기본 파라미터

GitHub 트리거

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

필드 타입 필수 여부 설명
trigger Object Required 트리거 정보
trigger.description String Optional 트리거 설명
  • 0~3,000 bytes
trigger.parameters Object Optional 트리거의 기본 파라미터
  • {"key": "value"} 형태의 JSON
  • 트리거 실행 시 파라미터 적용 우선순위
    • 1순위: 실행 시점에 전달되는 런타임 파라미터
    • 2순위: 연결된 트리거의 기본 파라미터
    • 3순위: 액션의 기본 파라미터
    • 4순위: 포함된 패키지의 기본 파라미터
trigger.credentials.username String Required GitHub 사용자 이름
trigger.credentials.accessToken String Required GitHub 액세스 토큰
trigger.credentials.repository String Required GitHub 리포지토리
  • 리포지토리 이름 또는 Organization/리포지토리 이름 형식으로 입력
trigger.events Array Required 트리거할 이벤트
  • * | check_run | check_suite | commit_comment | create | delete | deployment | deployment_status | fork | gollum | issue_comment | issues | label | member | milestone | page_build | project_card | project_column | project | public | pull_request_review_comment | pull_request_review_thread | pull_request_review | pull_request | push | repository | repository_import | repository_vulnerability_alert | release | status | team_add | watch | branch_protection_rule | code_scanning_alert | deploy_key | discussion_comment | discussion | meta | package | registry_package | secret_scanning_alert_location | secret_scanning_alert | security_and_analysis | star | workflow_job | workflow_run
link Object Conditional API Gateway 정보
  • 트리거 생성 시에만 유효하며 입력 필수
link.productId String Conditional API Gateway의 상품 ID
link.apiName String Conditional API Gateway API 이름
link.stageName String Conditional API Gateway의 스테이지 이름

Cloud Insight 트리거

Cloud Insight 트리거 요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
trigger Object Required 트리거 정보
trigger.description String Optional 트리거 설명(Byte)
  • 0~3,000
trigger.parameters Object Optional 트리거의 기본 파라미터
  • {"key": "value"} 형태의 JSON
  • 트리거 실행 시 파라미터 적용 우선순위
    • 1순위: 실행 시점에 전달되는 런타임 파라미터
    • 2순위: 연결된 트리거의 기본 파라미터
    • 3순위: 액션의 기본 파라미터
    • 4순위: 포함된 패키지의 기본 파라미터
trigger.insightLink Array Required Cloud Insight 정보: insightLink

insightLink

insightLink에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
prodKey String Required Cloud Insight 이벤트 규칙의 prodKey
ruleGrpId String Required Cloud Insight 이벤트 규칙의 ruleGrpId
reminderTime Integer Optional Cloud Insight 이벤트 규칙의 리마인드 알림 주기(분)
  • 5~720
enableNotiWhenEventClose Boolean Optional 이벤트 종료 시 Cloud Insight 이벤트 규칙 호출 여부
  • true | false (기본값)

Object Storage 트리거

Object Storage 트리거 요청 바디에 대한 설명은 다음과 같습니다.

주의

Object Storage 트리거에 연결된 액션이 Object Storage 이벤트 규칙과 동일한 버킷을 사용할 경우, 재귀 호출로 인한 사용량 증가 및 과다한 비용이 발생할 수 있습니다.

필드 타입 필수 여부 설명
trigger Object Required 트리거 정보
trigger.description String Optional 트리거 설명(Byte)
  • 0~3,000
trigger.parameters Object Optional 트리거의 기본 파라미터
  • {"key": "value"} 형태의 JSON
  • 트리거 실행 시 파라미터 적용 우선순위
    • 1순위: 실행 시점에 전달되는 런타임 파라미터
    • 2순위: 연결된 트리거의 기본 파라미터
    • 3순위: 액션의 기본 파라미터
    • 4순위: 포함된 패키지의 기본 파라미터
trigger.objectStorageLink Object[] Required Object Storage 정보: objectStorageLink

objectStorageLink

objectStorageLink에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
bucketName String Required Object Storage의 버킷 이름
eventRuleName String Required Object Storage의 이벤트 규칙 이름

Source Commit 트리거

Source Commit 트리거를 생성 또는 수정하는 요청 바디에 대한 설명은 다음과 같습니다.

참고

SourceCommit 트리거는 한국 리전의 VPC 플랫폼에서만 지원합니다.

필드 타입 필수 여부 설명
trigger Object Required 트리거 정보
trigger.description String Optional 트리거 설명(Byte)
  • 0~3,000
trigger.parameters Object Optional 트리거의 기본 파라미터
  • {"key": "value"} 형태의 JSON
  • 트리거 실행 시 파라미터 적용 우선순위
    • 1순위: 실행 시점에 전달되는 런타임 파라미터
    • 2순위: 연결된 트리거의 기본 파라미터
    • 3순위: 액션의 기본 파라미터
    • 4순위: 포함된 패키지의 기본 파라미터
trigger.sourceCommitLink Object[] Required SourceCommit 정보: sourceCommitLink

sourceCommitLink

sourceCommitLink에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
enable Boolean Optional SourceCommit 웹훅 활성화 여부
  • true (기본값) | false
    repositoryName String Required SourceCommit 리포지토리 이름
    webhookName String Required SourceCommit 웹훅 이름

    요청 예시

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

    curl --location --request PUT 'https://cloudfunctions.apigw.ntruss.com/api/v2/triggers/trigger002?platform=vpc' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "trigger": {
        "description": "cron Trigger",
        "cronOption": "0 10 * * *",
        "parameters": {
        }
    }
}'

    응답

    응답 형식을 설명합니다.

    응답 바디

    요청한 트리거에 따른 응답 바디에 대한 설명은 다음과 같습니다.

    Cron 트리거

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

    필드 타입 필수 여부 설명
    content Object - 트리거 생성, 수정 정보
    content.cronOptions String - 트리거 cron 실행 옵션
    content.description String - 트리거 설명
    content.name String - 트리거 이름
    content.namespace String - 사용자 네임스페이스
    content.parameters Object - 트리거의 기본 파라미터
    content.resourceId String - 트리거의 리소스 ID
    content.rules String - 트리거 액션 연결 정보
    content.triggerType String - 트리거 유형

    GitHub 트리거

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

    필드 타입 필수 여부 설명
    content Object - 트리거 생성, 수정 정보
    content.credentials Object - 트리거 GitHub 연동 정보
    content.description String - 트리거 설명
    content.events String - 트리거의 실행 GitHub 이벤트 옵션
    content.name String - 트리거 이름
    content.namespace String - 사용자 네임스페이스
    content.parameters Object - 트리거의 기본 파라미터
    content.resourceId String - 트리거의 리소스 ID
    content.rules String - 트리거 액션 연결 정보
    link.stageName String - 트리거 유형

    Cloud Insight 트리거

    Cloud Insight 트리거 응답 바디에 대한 설명은 다음과 같습니다.

    필드 타입 필수 여부 설명
    content Object - 트리거 생성, 수정 정보
    content.description String - 트리거 설명
    content.name String - 트리거 이름
    content.namespace String - 사용자 네임스페이스
    content.parameters Object - 트리거의 기본 파라미터
    content.insightLink Array - 연결된 Cloud Insight 이벤트 규칙 정보: insightLink
    content.resourceId String - 트리거의 리소스 ID
    content.rules String - 트리거 액션 연결 정보
    content.triggerType String - 트리거 유형

    insightLink

    insightLink에 대한 설명은 다음과 같습니다.

    필드 타입 필수 여부 설명
    prodKey String - Cloud Insight 이벤트 규칙의 prodKey
    ruleGrpId String - Cloud Insight 이벤트 규칙의 groupId
    reminderTime Integer - Cloud Insight 이벤트 규칙의 리마인드 알림 주기(분)
    enableNotiWhenEventClose Boolean - 이벤트 종료 시 Cloud Insight 이벤트 규칙 호출 여부

    Object Storage 트리거

    Object Storage 트리거 응답 바디에 대한 설명은 다음과 같습니다.

    필드 타입 필수 여부 설명
    content Object - 트리거 생성, 수정 정보
    content.description String - 트리거 설명
    content.name String - 트리거 이름
    content.namespace String - 사용자 네임스페이스
    content.parameters Object - 트리거의 기본 파라미터
    content.objectStorageLink Array - 연결된 Object Storage 이벤트 규칙 정보: objectStorageLink
    content.resourceId String - 트리거의 리소스 ID
    content.rules String - 트리거 액션 연결 정보
    content.triggerType String - 트리거 유형

    objectStorageLink

    objectStorageLink에 대한 설명은 다음과 같습니다.

    필드 타입 필수 여부 설명
    bucketName String Object Storage 이벤트 규칙의 버킷 이름
    eventRuleName String Object Storage 이벤트 규칙 이름

    Source Commit 트리거

    Source Commit 트리거 응답 바디에 대한 설명은 다음과 같습니다.

    필드 타입 필수 여부 설명
    content Object - 트리거 생성, 수정 정보
    content.description String - 트리거 설명
    content.name String - 트리거 이름
    content.namespace String - 사용자 네임스페이스
    content.parameters Object - 트리거의 기본 파라미터
    content.sourceCommitLink Array - 연결된 Source Commit의 리포지토리 정보: sourceCommitLink
    content.resourceId String - 트리거의 리소스 ID
    content.rules String - 트리거 액션 연결 정보
    content.triggerType String - 트리거 유형

    sourceCommitLink

    sourceCommitLink에 대한 설명은 다음과 같습니다.

    필드 타입 필수 여부 설명
    enable Boolean - Source Commit 웹훅 활성화 여부
    repositoryName String - Source Commit 리포지토리 이름
    webhookName String - Source Commit 웹훅 이름

    응답 상태 코드

    네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

    응답 예시

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

    {
    "content": {
        "cronOption": "0 10 * * *",
        "description": "cron Trigger",
        "limits": {},
        "name": "trigger002",
        "namespace": "****YBNz****",
        "parameters": {},
        "resourceId": "Nu3**",
        "rules": {},
        "triggerType": "Cron"
    }
}
    사업자등록번호: 129-86-31394 통신판매업신고번호:제2009-경기성남-0510호
    대표이사: 김유원 주소: 경기도 성남시 분당구 불정로 6 네이버 그린팩토리 17~26층, 13561 고객지원 대표전화: 1544-5876
    © NAVER Cloud Corp. All Rights Reserved.