MENU
      Put Trigger

        Put Trigger


        기사 요약

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

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

        요청

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

        메서드URI
        PUT/triggers/{triggerName}

        요청 헤더

        Cloud Funtions API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud Functions 공통 헤더를 참조해 주십시오.

        요청 경로 파라미터

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

        필드타입필수 여부설명
        triggerNameStringRequired트리거 이름
        • 1~50자로 영문자, 숫자, 특수문자 '-', '_'를 허용하며 '-'로 시작 불가
        • 다른 리소스(패키지, 액션, 트리거) 이름과 중복 불가

        요청 쿼리 파라미터

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

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

        요청 바디

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

        cron 트리거

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

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

        GitHub 트리거

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

        필드타입필수 여부설명
        triggerObjectRequired트리거 정보
        trigger.descriptionStringOptional트리거 설명
        • 0~3,000 bytes
        trigger.parametersObjectOptional트리거의 기본 파라미터
        • {"key": "value"} 형태의 JSON
        • 트리거 실행 시 파라미터 적용 우선순위
          • 1순위: 실행 시점에 전달되는 런타임 파라미터
          • 2순위: 연결된 트리거의 기본 파라미터
          • 3순위: 액션의 기본 파라미터
          • 4순위: 포함된 패키지의 기본 파라미터
        trigger.credentials.usernameStringRequiredGitHub 사용자 이름
        trigger.credentials.accessTokenStringRequiredGitHub 액세스 토큰
        trigger.credentials.repositoryStringRequiredGitHub 리포지토리
        • 리포지토리 이름 또는 Organization/리포지토리 이름 형식으로 입력
        trigger.eventsArrayRequired트리거할 이벤트
        • * | 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
        linkObjectConditionalAPI Gateway 정보
        • 트리거 생성 시에만 유효하며 입력 필수
        link.productIdStringConditionalAPI Gateway의 상품 ID
        link.apiNameStringConditionalAPI Gateway API 이름
        link.stageNameStringConditionalAPI Gateway의 스테이지 이름

        Cloud Insight 트리거

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

        필드타입필수 여부설명
        triggerObjectRequired트리거 정보
        trigger.descriptionStringOptional트리거 설명(Byte)
        • 0~3,000
        trigger.parametersObjectOptional트리거의 기본 파라미터
        • {"key": "value"} 형태의 JSON
        • 트리거 실행 시 파라미터 적용 우선순위
          • 1순위: 실행 시점에 전달되는 런타임 파라미터
          • 2순위: 연결된 트리거의 기본 파라미터
          • 3순위: 액션의 기본 파라미터
          • 4순위: 포함된 패키지의 기본 파라미터
        trigger.insightLinkObject[]RequiredCloud Insight 정보
        trigger.insightLink[].prodKeyStringRequiredCloud Insight 이벤트 규칙의 prodKey
        trigger.insightLink[].ruleGrpIdStringRequiredCloud Insight 이벤트 규칙의 ruleGrpId
        trigger.insightLink[].reminderTimeIntegerOptionalCloud Insight 이벤트 규칙의 리마인드 알림 주기(분)
        • 5~720
        trigger.insightLink[].enableNotiWhenEventCloseBooleanOptional이벤트 종료 시 Cloud Insight 이벤트 규칙 호출 여부
        • true | false (기본값)

        Object Storage 트리거

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

        주의

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

        필드타입필수 여부설명
        triggerObjectRequired트리거 정보
        trigger.descriptionStringOptional트리거 설명(Byte)
        • 0~3,000
        trigger.parametersObjectOptional트리거의 기본 파라미터
        • {"key": "value"} 형태의 JSON
        • 트리거 실행 시 파라미터 적용 우선순위
          • 1순위: 실행 시점에 전달되는 런타임 파라미터
          • 2순위: 연결된 트리거의 기본 파라미터
          • 3순위: 액션의 기본 파라미터
          • 4순위: 포함된 패키지의 기본 파라미터
        trigger.objectStorageLinkObject[]RequiredObject Storage 정보
        trigger.objectStorageLink[].bucketNameStringRequiredObject Storage의 버킷 이름
        trigger.objectStorageLink[].eventRuleNameStringRequiredObject Storage의 이벤트 규칙 이름

        Source Commit 트리거

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

        참고

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

        필드타입필수 여부설명
        triggerObjectRequired트리거 정보
        trigger.descriptionStringOptional트리거 설명(Byte)
        • 0~3,000
        trigger.parametersObjectOptional트리거의 기본 파라미터
        • {"key": "value"} 형태의 JSON
        • 트리거 실행 시 파라미터 적용 우선순위
          • 1순위: 실행 시점에 전달되는 런타임 파라미터
          • 2순위: 연결된 트리거의 기본 파라미터
          • 3순위: 액션의 기본 파라미터
          • 4순위: 포함된 패키지의 기본 파라미터
        trigger.sourceCommitLinkObject[]RequiredSourceCommit 정보
        trigger.sourceCommitLink[].enableBooleanOptionalSourceCommit 웹훅 활성화 여부
        • true (기본값) | false
          trigger.sourceCommitLink[].repositoryNameStringRequiredSourceCommit 리포지토리 이름
          trigger.sourceCommitLink[].webhookNameStringRequiredSourceCommit 웹훅 이름

          요청 예시

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

          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 '<하단 참조>'
          Curl
          {
              "trigger": {
                  "description": "cron Trigger",
                  "cronOption": "0 10 * * *",
                  "parameters": {
          
                  }
              }
          }
          JSON

          응답

          응답 형식을 설명합니다.

          응답 바디

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

          Cron 트리거

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

          필드타입설명
          content.cronOptionsString트리거 cron 실행 옵션
          content.descriptionString트리거 설명
          content.nameString트리거 이름
          content.namespaceString사용자 네임스페이스
          content.parametersObject트리거의 기본 파라미터
          content.resourceIdString트리거의 리소스 ID
          content.rulesString트리거 액션 연결 정보
          content.triggerTypeString트리거 유형

          GitHub 트리거

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

          필드타입설명
          content.credentialsObject트리거 GitHub 연동 정보
          content.descriptionString트리거 설명
          content.eventsString트리거의 실행 GitHub 이벤트 옵션
          content.nameString트리거 이름
          content.namespaceString사용자 네임스페이스
          content.parametersObject트리거의 기본 파라미터
          content.resourceIdString-
          content.rulesString트리거 액션 연결 정보
          link.stageNameString트리거 유형

          Cloud Insight 트리거

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

          필드타입설명
          content.descriptionString트리거 설명
          content.nameString트리거 이름
          content.namespaceString사용자 네임스페이스
          content.parametersObject트리거의 기본 파라미터
          content.insightLinkObject[]연결된 Cloud Insight 이벤트 규칙 정보
          content.insightLink[].prodKeyStringCloud Insight 이벤트 규칙의 prodKey
          content.insightLink[].ruleGrpIdStringCloud Insight 이벤트 규칙의 groupId
          content.insightLink[].reminderTimeIntegerCloud Insight 이벤트 규칙의 리마인드 알림 주기(분)
          content.insightLink[].enableNotiWhenEventCloseBoolean이벤트 종료 시 Cloud Insight 이벤트 규칙 호출 여부
          content.resourceIdString-
          content.rulesString-
          content.triggerTypeString-

          Object Storage 트리거

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

          필드타입설명
          content.descriptionString트리거 설명
          content.nameString트리거 이름
          content.namespaceString사용자 네임스페이스
          content.parametersObject트리거의 기본 파라미터
          content.objectStorageLinkObject[]연결된 Object Storage 이벤트 규칙 정보
          content.objectStorageLink[].bucketNameStringObject Storage 이벤트 규칙의 버킷 이름
          content.objectStorageLink[].eventRuleNameStringObject Storage 이벤트 규칙 이름
          content.resourceIdString트리거의 리소스 ID
          content.rulesString트리거 액션 연결 정보
          content.triggerTypeString트리거 유형

          Source Commit 트리거

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

          필드타입설명
          content.descriptionString트리거 설명
          content.nameString트리거 이름
          content.namespaceString사용자 네임스페이스
          content.parametersObject트리거의 기본 파라미터
          content.sourceCommitLinkObject[]연결된 Source Commit의 리포지토리 정보
          content.sourceCommitLink[].enableBooleanSource Commit 웹훅 활성화 여부
          content.sourceCommitLink[].repositoryNameStringSource Commit 리포지토리 이름
          content.sourceCommitLink[].webhookNameStringSource Commit 웹훅 이름
          content.resourceIdString트리거의 리소스 ID
          content.rulesString트리거 액션 연결 정보
          content.triggerTypeString트리거 유형

          응답 상태 코드

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

          응답 예시

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

          {
              "content": {
                  "cronOption": "0 10 * * *",
                  "description": "cron Trigger",
                  "limits": {},
                  "name": "trigger002",
                  "namespace": "****YBNz****",
                  "parameters": {},
                  "resourceId": "Nu3**",
                  "rules": {},
                  "triggerType": "Cron"
              }
          }
          JSON

          이 문서가 도움이 되었습니까?

          Changing your password will log you out immediately. Use the new password to log back in.
          First name must have atleast 2 characters. Numbers and special characters are not allowed.
          Last name must have atleast 1 characters. Numbers and special characters are not allowed.
          Enter a valid email
          Enter a valid password
          Your profile has been successfully updated.