Put Trigger

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

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

요청

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

메서드	URI
PUT	/triggers/{triggerName}

요청 헤더

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

요청 경로 파라미터

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

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`type`	String	Required	트리거 유형 `cron` \| `github` 생성 후 변경 불가

요청 바디

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

cron 트리거

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

필드	타입	필수 여부	설명
`trigger`	Object	Required	트리거 정보
`trigger.description`	String	Optional	트리거 설명(Byte) 0~3,000
`trigger.cronOption`	String	Required	cron 실행 옵션 cron 트리거 (Classic) 참조
`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의 스테이지 이름

요청 예시

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

curl --location --request PUT 'https://cloudfunctions.apigw.gov-ntruss.com/api/v2/triggers/trigger002?type=cron' \
--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.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.credentials`	Object	트리거 GitHub 연동 정보
`content.description`	String	트리거 설명
`content.events`	String	트리거의 실행 GitHub 이벤트 옵션
`content.name`	String	트리거 이름
`content.namespace`	String	사용자 네임스페이스
`content.parameters`	Object	트리거의 기본 파라미터
`content.resourceId`	String	-
`content.rules`	String	트리거 액션 연결 정보
`link.stageName`	String	트리거 유형

응답 상태 코드

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

응답 예시

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

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