Put Trigger
    • PDF

    Put Trigger

    • PDF

    기사 요약

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

    요청

    요청을 위한 파라미터, 헤더, 바디 정보를 설명합니다.

    요청 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}
    

    요청 경로 파라미터

    파라미터명타입필수 여부설명제약 사항
    triggerNameStringY트리거 이름영문, 숫자, 붙임표( - ), 밑줄 문자( _ )로 구성한 50자 이내의 문자열

    요청 파라미터

    요청 파라미터는 다음과 같습니다.

    파라미터명타입필수 여부설명제약 사항
    typeStringN트리거 타입
    - options: basic/cron/insight/object_storage
    - default: basic
    다른 타입으로 변경 불가

    요청 바디

    요청 바디에 필드가 없을 경우, {} 빈 JSON Object 형태로 요청해야 합니다.

    공통 필드

    필드명타입필수 여부설명제약 사항
    descriptionStringN트리거 설명최대 3000 bytes
    parametersObjectN트리거 디폴트 파라미터
    - JSON 형식. {"key" : "value"}의 형태
    - 액션 실행 시 파라미터 적용 우선 순위
    ** 1순위: 실행 시점에 전달되는 런타임 파라미터
    ** 2순위: 연결된 트리거의 디폴트 파라미터
    ** 3순위: 액션의 디폴트 파라미터
    ** 4순위: 포함된 패키지의 디폴트 파라미터

    Basic 트리거

    공통 필드 참조

    필드명타입필수 여부설명제약 사항
    linkObject[]N외부 연결 주소 생성을 위한 API Gateway 정보
    link[].productNameStringY외부 연결 주소 생성을 위한 API Gateway의 Product 이름
    link[].apiNameStringY외부 연결 주소 생성을 위한 API Gateway의 API 이름
    link[].stageNameStringY외부 연결 주소 생성을 위한 API Gateway의 Stage 이름
    link[].authenticationStringN외부 연결 주소 생성을 위한 API Gateway의 인증방식
    - options: NONE/IAM
    - default: IAM

    Cron 트리거

    공통 필드 참조

    필드명타입필수 여부설명제약 사항
    cronOptionStringYCron 실행 옵션Cron 트리거 실행 옵션 참조

    Cloud Insight 트리거

    공통 필드 참조

    필드명타입필수 여부설명제약 사항
    insightLinkObject[]N연결할 Cloud Insight Event Rule 정보
    insightLink[].prodKeyStringYCloud Insight Event Rule의 prodKey
    insightLink[].ruleGrpIdStringYCloud Insight Event Rule의 ruleGrpId
    insightLink[].reminderTimeIntegerNCloud Insight Event Rule의 리마인드 알림 주기 (분 단위)
    - options: 5~720
    insightLink[].enableNotiWhenEventCloseBooleanNCloud Insight Event Rule을 Event 종료 시에도 호출할 지 여부
    - default: false

    Object Storage 트리거

    주의

    Object Storage Trigger에 연결된 액션이 Object Storage Event Rule과 동일한 Bucket을 사용할 경우 재귀 호출로 인한 사용량 증가 및 과다한 비용이 발생할 수 있습니다.

    공통 필드 참조

    필드명타입필수 여부설명제약 사항
    objectStorageLinkObject[]N연결할 Object Storage Event Rule 정보
    objectStorageLink[].bucketNameStringYObject Storage의 Bucket 이름
    objectStorageLink[].eventRuleNameStringYObject Storage의 Event Rule 이름

    응답

    응답 바디

    공통 필드

    필드명타입설명비고
    content.nameString트리거 이름
    content.resourceIdString트리거 Resource ID
    content.triggerTypeString트리거 타입
    content.namespaceString사용자의 네임스페이스
    content.descriptionString트리거 설명
    content.parametersObject트리거 디폴트 파라미터
    content.rulesObject트리거 액션 연결 정보

    Basic 트리거

    공통 필드 참조

    Cron 트리거

    공통 필드 참조

    필드명타입설명비고
    content.cronOptionStringCron 실행 옵션

    Cloud Insight 트리거

    공통 필드 참조

    필드명타입설명비고
    content.credentialObjectGitHub 정보
    content.insightLinkObject[]연결된 Cloud Insight Event Rule 정보
    content.insightLink[].prodKeyString연결된 Cloud Insight Event Rule의 prodKey
    content.insightLink[].ruleGrpIdString연결된 Cloud Insight Event Rule의 ruleGrpId
    content.insightLink[].reminderTimeInteger연결된 Cloud Insight Event Rule의 리마인드 알림 주기(분 단위)
    content.insightLink[].enableNotiWhenEventCloseBoolean연결된 Cloud Insight Event Rule을 Event 종료 시에도 호출할 지 여부

    Object Storage 트리거

    공통 필드 참조

    필드명타입설명비고
    content.objectStorageLinkObject[]연결된 Object Storage Event Rule 정보
    content.objectStorageLink[].bucketNameString연결된 Object Storage의 Bucket 이름
    content.objectStorageLink[].eventRuleNameString연결된 Object Storage의 Event Rule 이름

    오류 코드

    HTTP 상태 코드오류 코드오류 메시지설명
    40080500TRIGGER_INVALID_NAME잘못된 트리거 이름
    40080503TRIGGER_INVALID_TYPE잘못된 트리거 타입
    40080504TRIGGER_TYPE_MISMATCH트리거의 타입 변경 불가
    40080505TRIGGER_BODY_INVALID_TYPE잘못된 요청 바디 필드 타입
    40080506TRIGGER_BODY_MISSING_FIELD요청 바디 필수 필드 누락
    40080507TRIGGER_BODY_INVALID_VALUE잘못된 요청 바디 필드 값
    40080700NO_APIGW_SUBSCRIPTIONAPI Gateway 서비스 이용 신청 필요
    40080710NO_INSIGHT_SUBSCRIPTIONCloud Insight 이용 신청 필요
    40080711INSIGHT_INVALID_EVENT_RULE잘못된 Cloud Insight 이벤트 규칙 정보
    40080730NO_OBJECT_STORAGE_SUBSCRIPTIONObject Storage 이용 신청 필요
    40080731OBJECT_STORAGE_INVALID_EVENT_RULE잘못된 Object Storage 이벤트 규칙 정보
    40380002SUB_ACC_NO_PERMISSION상세 권한 오류
    40980011RESOURCE_NAME_CONFLICT중복된 리소스 이름
    42280508TRIGGER_COUNT_EXCEED최대 트리거 수 초과
    -80005INTEGRATION_EXCEPTION연동 서비스 이용 신청 필요

    예시

    요청 예시

    curl -X PUT "https://cloudfunctions.apigw.fin-ntruss.com/ncf/api/v2/triggers/mytrigger?type=basic"
    -H "Content-Type: application/json"
    -H "x-ncp-iam-access-key: Y0Z9EG0lKoeWAQCSHRtM"
    -H "x-ncp-apigw-timestamp: 1546398302273"
    -H "x-ncp-apigw-signature-v2: VXjaLhHB2CdowCrqDNYg7w7GR3TYxZzM2eIZ+i3IH0Q="
    -d '<하단 참조>'
    
    {
        "description" : "My trigger",
        "parameters": {
            "name": "Cloud Functions",
            "place": "NCloud"
        },
        "link": [
            {
                "productName": "functions",
                "apiName": "api",
                "stageName": "v1",
                "authentication": "IAM"
            }
        ]
    }
    

    응답 예시

    {
        "content": {
            "description": "My trigger",
            "name": "mytrigger",
            "namespace": "kHbJQSZDDh3m",
            "parameters": {
                "name": "Cloud Functions",
                "place": "NCloud"
            },
            "resourceId": "xWnct",
            "rules": {},
            "triggerType": "basic"
        }
    }
    

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

    What's Next
    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.