Put Trigger
    • PDF

    Put Trigger

    • PDF

    기사 요약

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

    요청

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

    메서드URI
    PUT/triggers/{triggerName}

    요청 헤더

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

    요청 경로 파라미터

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

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

    요청 쿼리 파라미터

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

    필드타입필수 여부설명
    typeStringOptional트리거 유형
    • basic (기본값) | cron | insight | object_storage
    • 생성 후 변경 불가

    요청 바디

    요청 바디에 대한 설명은 다음과 같습니다. 요청 바디에 필드가 없을 경우, {} 빈 JSON Object 형태로 요청해야 합니다.

    공통

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

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

    Basic 트리거

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

    필드타입필수 여부설명
    linkObject[]OptionalAPI Gateway 정보
    link[].productNameStringConditionalAPI Gateway의 상품 이름
    • link 입력 시 필수
    link[].apiNameStringConditionalAPI Gateway의 API 이름
    • link 입력 시 필수
    link[].stageNameStringConditionalAPI Gateway의 스테이지 이름
    • link 입력 시 필수
    link[].authenticationStringOptionalAPI Gateway의 인증 방식
    • NONE (기본값) | IAM

    cron 트리거

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

    필드타입필수 여부설명
    cronOptionStringRequiredcron 실행 옵션

    Cloud Insight 트리거

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

    필드타입필수 여부설명
    insightLinkObject[]Optional연결할 Cloud Insight 이벤트 규칙 정보
    insightLink[].prodKeyStringConditionalCloud Insight 이벤트 규칙의 prodKey
    • insightLink 입력 시 필수
    insightLink[].ruleGrpIdStringConditionalCloud Insight 이벤트 규칙의 ruleGrpId
    • insightLink 입력 시 필수
    insightLink[].reminderTimeIntegerOptionalCloud Insight 이벤트 규칙의 리마인드 알림 주기(분)
    • 5~720
    insightLink[].enableNotiWhenEventCloseBooleanOptional이벤트 종료 시 Cloud Insight 이벤트 규칙 호출 여부
    • true | false (기본값)

    Object Storage 트리거

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

    주의

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

    필드타입필수 여부설명
    objectStorageLinkObject[]Required연결할 Object Storage 이벤트 규칙 정보
    objectStorageLink[].bucketNameStringRequiredObject Storage의 버킷 이름
    objectStorageLink[].eventRuleNameStringRequiredObject Storage의 이벤트 규칙 이름

    요청 예시

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

    curl --location --request PUT 'https://cloudfunctions.apigw.fin-ntruss.com/ncf/api/v2/triggers/trigger001?type=basic' \
    --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 '<하단 참조>'
    
    {
        "description": "Basic Trigger",
        "parameters": {
            "parameter": "Basic"
        },
        "link": [
            {
                "productName": "product",
                "apiName": "api000",
                "stageName": "stage",
                "authentication": "NONE"
            }
        ]
    }
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    공통/Basic 트리거

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

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

    cron 트리거

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

    필드타입설명
    content.cronOptionStringcron 실행 옵션

    Cloud Insight 트리거

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

    필드타입설명
    content.insightLinkObject[]연결된 Cloud Insight 이벤트 규칙 정보
    content.insightLink[].prodKeyStringCloud Insight 이벤트 규칙의 prodKey
    content.insightLink[].ruleGrpIdStringCloud Insight 이벤트의 ruleGrpId
    content.insightLink[].reminderTimeIntegerCloud Insight 이벤트의 리마인드 알림 주기(분)
    content.insightLink[].enableNotiWhenEventCloseBoolean이벤트 종료 시 Cloud Insight 이벤트 규칙 호출 여부

    Object Storage 트리거

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

    필드타입설명
    content.objectStorageLinkObject[]연결된 Object Storage 이벤트 규칙 정보
    content.objectStorageLink[].bucketNameStringObject Storage의 버킷 이름
    content.objectStorageLink[].eventRuleNameStringObject Storage의 이벤트 규칙 이름

    응답 상태 코드

    응답 상태 코드에 대한 설명은 다음과 같습니다.

    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연동 서비스 이용 신청 필요

    응답 예시

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

    {
        "content": {
            "description": "",
            "name": "trigger001",
            "namespace": "****YBNz****",
            "parameters": {
                "parameter": "Basic"
            },
            "resourceId": "4ci**",
            "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.