Put Trigger

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

개요

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

요청

요청 URL

PUT {CLOUD_FUNCTIONS_API_URL}/triggers/{triggerName}
Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

파라미터	필수 여부	타입	제약 사항	설명
triggerName	Yes	string	영문, 숫자, - , _ 으로 구성하여 50자 이내만 허용함	트리거 이름

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
type	No	string	(basic \| cron \| github)	- 트리거 타입 default basic으로 처리됨

요청 바디

요청 바디는 트리거 타입에 따라 확인해주십시오.

Basic Trigger

{
    "trigger": {
        "description": "string",
        "parameters": {
        }
    },
    "link": {
        "productId": "string",
        "apiName": "string",
        "stageName": "string",
        "authentication": "string"
    }
}

항목	필수 여부	타입	제약 사항	설명
trigger	Yes	object		트리거 정보
trigger.description	No	string	3000 bytes 이내 문자열	트리거 설명
trigger.parameters	No	object	JSON 형식. {"key" : "value"}의 형태	트리거의 디폴트 파라미터 설정 * 액션 실행시 파라미터 적용 우선 순위 1순위: 실행 시점에 전달되는 런타임 파라미터 2순위: 연결된 트리거의 디폴트 파라미터 3순위: 액션의 디폴트 파라미터 4순위: 포함된 패키지의 디폴트 파라미터
link	No			link는 트리거 생성시에만 유효하며 수정시에는 적용되지 않음
link.productId	Conditional	string		외부 연결 주소를 생성하기 위한 API gateway의 productId `link` 입력 시 필수
link.apiName	Conditional	string		외부 연결 주소를 생성하기 위한 API gateway의 apiName `link` 입력 시 필수
link.stageName	Conditional	string		외부 연결 주소를 생성하기 위한 API gateway의 stageName `link` 입력 시 필수
link.authentication	No	string	( NONE \| IAM )	외부 연결 주소 호출시 API gateway의 인증 방식. default NONE

Cron Trigger

{
    "trigger": {
        "description": "string",
        "cronOption": "string",
        "parameters": {
        }
    }
}

항목	필수 여부	타입	제약 사항	설명
trigger	Yes	object		트리거 정보
trigger.description	No	string	3000 bytes 이내 문자열	트리거 설명
trigger.cronOption	Yes	string	cron expression	cron 실행 옵션
trigger.parameters	No	object	JSON 형식. {"key" : "value"}의 형태	트리거의 디폴트 파라미터 설정 * 액션 실행시 파라미터 적용 우선 순위 1순위: 실행 시점에 전달되는 런타임 파라미터 2순위: 연결된 트리거의 디폴트 파라미터 3순위: 액션의 디폴트 파라미터 4순위: 포함된 패키지의 디폴트 파라미터

GitHub Trigger

{
    "trigger": {
        "parameters": {
        },
        "description": "string",
        "credentials": {
            "username": "string",
            "accessToken": "string",
            "repository": "string"
        },
        "events": [
            "string"
        ]
    },
    "link": {
    	"productID" : "string",
    	"apiName" : "string",
    	"stageName" : "string"
    }
}

항목	필수 여부	타입	제약 사항	설명
trigger	Yes	object		트리거 정보
trigger.description	No	string	3000 bytes 이내 문자열	트리거 설명
trigger.parameters	No	object	JSON 형식. {"key" : "value"}의 형태	트리거의 디폴트 파라미터 설정 * 액션 실행시 파라미터 적용 우선 순위 1순위: 실행 시점에 전달되는 런타임 파라미터 2순위: 연결된 트리거의 디폴트 파라미터 3순위: 액션의 디폴트 파라미터 4순위: 포함된 패키지의 디폴트 파라미터
trigger.credentials.username	Yes	string		Github 유저 이름
trigger.credentials.accessToken	Yes	string		Github 액세스 토큰
trigger.credentials.repository	Yes	string	URL 형식이 아닌 '레파지토리명' 혹은 'Organization/레파지토리명'의 형식으로 작성 바람	Github 레파지토리
trigger.events	Yes	string array	이벤트 종류로 "*", "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", "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", "release", "secret_scanning_alert_location", "secret_scanning_alert", "security_and_analysis", "star", "workflow_job", "workflow_run" 중 다중 선택 가능	트리거할 이벤트 리스트
link	No			link 데이터는 트리거 생성시에만 유효하며 수정시에는 적용되지 않음
link.productId	Yes	string		외부 연결 주소를 생성하기 위한 API gateway의 productId
link.apiName	Yes	string		외부 연결 주소를 생성하기 위한 API gateway의 apiName
link.stageName	Yes	string		외부 연결 주소를 생성하기 위한 API gateway의 stageName

응답

응답 바디

Basic Trigger

{
    "content": {
        "name": "string",
        "namespace": "string",
        "description": "string",
        "limits": {},
        "parameters": {
        },
        "resourceId": "string",
        "rules": {},
        "triggerType": "string"
    }
}

항목	타입	설명	비고
content.name	string	트리거 이름
content.namespace	string	사용자의 네임스페이스
content.description	string	트리거 설명
content.triggerType	string	트리거 타입
content.resourceId	string	트리거의 resourceId
content.parameters	object	트리거의 디폴트 파라미터
content.limits			사용하지 않음
content.rules	string	트리거 액션 연결 정보

Cron Trigger

{
    "content": {
        "cronOption": "string",
        "description": "string",
        "limits": {},
        "name": "string",
        "namespace": "string",
        "parameters": {
        },
        "resourceId": "string",
        "rules": {},
        "triggerType": "string"
    }
}

항목	타입	설명	비고
content.description	string	트리거 설명
content.triggerType	string	트리거 타입
content.resourceId	string	트리거의 resourceId
content.cronOptions	string	트리거의 Cron 실행옵션
content.limits			사용하지 않음
content.name	string	트리거 이름
content.namespace	string	사용자의 네임스페이스
content.parameters	object	트리거의 디폴트 파라미터
content.rules	string	트리거 액션 연결 정보

GitHub Trigger

{
    "content": {
        "credentials": {
            "accessToken": "string",
            "repository": "string",
            "username": "string"
        },
        "description": "string",
        "events": "string",
        "limits": {},
        "name": "string",
        "namespace": "string",
        "parameters": {
        },
        "resourceId": "string",
        "rules": {},
        "triggerType": "string"
    }
}

항목	타입	설명	비고
content.credentials		트리거 github 연동 정보
content.description	string	트리거 설명
content.events	string	트리거의 실행 github event 옵션
content.limits			사용하지 않음
content.name	string	트리거 이름
content.namespace	string	사용자의 네임스페이스
content.parameters	object	트리거의 디폴트 파라미터
content.resourceId	string	트리거의 resourceId
content.rules	string	트리거 액션 연결 정보
content.triggerType	string	트리거 타입

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

What's Next

Post Trigger

개요
요청
응답

태그

Cloud Functions