Put Trigger

개요

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

요청

요청 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 Yes string (basic | cron | github) 트리거 타입. default basic으로 처리됩니다.

요청 바디

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

Basic Trigger

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

      }
  },
    "link": {
        "productId": "string",
        "apiName": "string",
        "stageName": "string"
    }
}
항목 필수 여부 타입 제약 사항 설명
trigger.description No string 3000 bytes 이내 문자열 트리거 설명
trigger.parameter No JSON 형식. {“key” : “value”}의 형태 액션의 디폴트 파라미터를 설정합니다.
파라미터 적용 우선순위는 실행 시점에 전달되는 파라미터가 1순위, 액션의 디폴트 파라미터가 2순위, 패키지의 파라미터가 3순위로 적용됩니다.
link No link는 트리거 생성시에만 유효합니다. 수정시에는 적용되지 않습니다.
link.productId Yes string 외부 연결 주소를 생성하기 위한 API gateway의 productId
link.apiName Yes string 외부 연결 주소를 생성하기 위한 API gateway의 apiName
link.stageName Yes string 외부 연결 주소를 생성하기 위한 API gateway의 stageName

Cron Trigger

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

        }
    }
}
항목 필수 여부 타입 제약 사항 설명
trigger.description No string 3000 bytes 이내 문자열 트리거 설명
trigger.cronOption Yes string cron expression cron 실행 옵션
trigger.parameter No JSON 형식. {“key” : “value”}의 형태 액션의 디폴트 파라미터를 설정합니다.
파라미터 적용 우선순위는 실행 시점에 전달되는 파라미터가 1순위, 액션의 디폴트 파라미터가 2순위, 패키지의 파라미터가 3순위로 적용됩니다.

GitHub Trigger

{
    "trigger": {
        "parameters": {

        },
        "description": "string",
        "credentials": {
            "username": "string",
            "accessToken": "string",
            "repository": "string"
        },
        "events": [
            "string"
        ]
    },
    "link": {
    	"productID" : "string",
    	"apiName" : "string",
    	"stageName" : "string"
    }
}
항목 필수 여부 타입 제약 사항 설명
trigger.description No string 3000 bytes 이내 문자열 트리거 설명
trigger.parameter No JSON 형식. {“key” : “value”}의 형태 액션의 디폴트 파라미터를 설정합니다.
파라미터 적용 우선순위는 실행 시점에 전달되는 파라미터가 1순위, 액션의 디폴트 파라미터가 2순위, 패키지의 파라미터가 3순위로 적용됩니다.
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” 중 다중 선택 가능합니다. 트리거할 이벤트 리스트.
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 string 트리거의 디폴트 파라미터
content.limit 사용하지 않음
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.limit 사용하지 않음
content.name string 트리거 이름
content.namespace string 사용자의 네임스페이스
content.parameters string 트리거의 디폴트 파라미터
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 map araay 트리거의 디폴트 파라미터
content.resourceId string 트리거의 resourceId
content.rules string 트리거 액션 연결 정보
content.triggerType string 트리거 타입