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}
요청 경로 파라미터
파라미터명 | 타입 | 필수 여부 | 설명 | 제약 사항 |
---|---|---|---|---|
triggerName | String | Y | 트리거 이름 | 영문, 숫자, 붙임표( - ), 밑줄 문자( _ )로 구성한 50자 이내의 문자열 |
요청 파라미터
요청 파라미터는 다음과 같습니다.
파라미터명 | 타입 | 필수 여부 | 설명 | 제약 사항 |
---|---|---|---|---|
type | String | N | 트리거 타입 - options: basic/cron/insight/object_storage - default: basic | 다른 타입으로 변경 불가 |
요청 바디
요청 바디에 필드가 없을 경우, {}
빈 JSON Object 형태로 요청해야 합니다.
공통 필드
필드명 | 타입 | 필수 여부 | 설명 | 제약 사항 |
---|---|---|---|---|
description | String | N | 트리거 설명 | 최대 3000 bytes |
parameters | Object | N | 트리거 디폴트 파라미터 - JSON 형식. {"key" : "value"}의 형태 - 액션 실행 시 파라미터 적용 우선 순위 ** 1순위: 실행 시점에 전달되는 런타임 파라미터 ** 2순위: 연결된 트리거의 디폴트 파라미터 ** 3순위: 액션의 디폴트 파라미터 ** 4순위: 포함된 패키지의 디폴트 파라미터 |
Basic 트리거
공통 필드 참조
필드명 | 타입 | 필수 여부 | 설명 | 제약 사항 |
---|---|---|---|---|
link | Object[] | N | 외부 연결 주소 생성을 위한 API Gateway 정보 | |
link[].productName | String | Y | 외부 연결 주소 생성을 위한 API Gateway의 Product 이름 | |
link[].apiName | String | Y | 외부 연결 주소 생성을 위한 API Gateway의 API 이름 | |
link[].stageName | String | Y | 외부 연결 주소 생성을 위한 API Gateway의 Stage 이름 | |
link[].authentication | String | N | 외부 연결 주소 생성을 위한 API Gateway의 인증방식 - options: NONE/IAM - default: IAM |
Cron 트리거
공통 필드 참조
필드명 | 타입 | 필수 여부 | 설명 | 제약 사항 |
---|---|---|---|---|
cronOption | String | Y | Cron 실행 옵션 | Cron 트리거 실행 옵션 참조 |
Cloud Insight 트리거
공통 필드 참조
필드명 | 타입 | 필수 여부 | 설명 | 제약 사항 |
---|---|---|---|---|
insightLink | Object[] | N | 연결할 Cloud Insight Event Rule 정보 | |
insightLink[].prodKey | String | Y | Cloud Insight Event Rule의 prodKey | |
insightLink[].ruleGrpId | String | Y | Cloud Insight Event Rule의 ruleGrpId | |
insightLink[].reminderTime | Integer | N | Cloud Insight Event Rule의 리마인드 알림 주기 (분 단위) - options: 5~720 | |
insightLink[].enableNotiWhenEventClose | Boolean | N | Cloud Insight Event Rule을 Event 종료 시에도 호출할 지 여부 - default: false |
Object Storage 트리거
주의
Object Storage Trigger에 연결된 액션이 Object Storage Event Rule과 동일한 Bucket을 사용할 경우 재귀 호출로 인한 사용량 증가 및 과다한 비용이 발생할 수 있습니다.
공통 필드 참조
필드명 | 타입 | 필수 여부 | 설명 | 제약 사항 |
---|---|---|---|---|
objectStorageLink | Object[] | N | 연결할 Object Storage Event Rule 정보 | |
objectStorageLink[].bucketName | String | Y | Object Storage의 Bucket 이름 | |
objectStorageLink[].eventRuleName | String | Y | Object Storage의 Event Rule 이름 |
응답
응답 바디
공통 필드
필드명 | 타입 | 설명 | 비고 |
---|---|---|---|
content.name | String | 트리거 이름 | |
content.resourceId | String | 트리거 Resource ID | |
content.triggerType | String | 트리거 타입 | |
content.namespace | String | 사용자의 네임스페이스 | |
content.description | String | 트리거 설명 | |
content.parameters | Object | 트리거 디폴트 파라미터 | |
content.rules | Object | 트리거 액션 연결 정보 |
Basic 트리거
공통 필드 참조
Cron 트리거
공통 필드 참조
필드명 | 타입 | 설명 | 비고 |
---|---|---|---|
content.cronOption | String | Cron 실행 옵션 |
Cloud Insight 트리거
공통 필드 참조
필드명 | 타입 | 설명 | 비고 |
---|---|---|---|
content.credential | Object | GitHub 정보 | |
content.insightLink | Object[] | 연결된 Cloud Insight Event Rule 정보 | |
content.insightLink[].prodKey | String | 연결된 Cloud Insight Event Rule의 prodKey | |
content.insightLink[].ruleGrpId | String | 연결된 Cloud Insight Event Rule의 ruleGrpId | |
content.insightLink[].reminderTime | Integer | 연결된 Cloud Insight Event Rule의 리마인드 알림 주기(분 단위) | |
content.insightLink[].enableNotiWhenEventClose | Boolean | 연결된 Cloud Insight Event Rule을 Event 종료 시에도 호출할 지 여부 |
Object Storage 트리거
공통 필드 참조
필드명 | 타입 | 설명 | 비고 |
---|---|---|---|
content.objectStorageLink | Object[] | 연결된 Object Storage Event Rule 정보 | |
content.objectStorageLink[].bucketName | String | 연결된 Object Storage의 Bucket 이름 | |
content.objectStorageLink[].eventRuleName | String | 연결된 Object Storage의 Event Rule 이름 |
오류 코드
HTTP 상태 코드 | 오류 코드 | 오류 메시지 | 설명 |
---|---|---|---|
400 | 80500 | TRIGGER_INVALID_NAME | 잘못된 트리거 이름 |
400 | 80503 | TRIGGER_INVALID_TYPE | 잘못된 트리거 타입 |
400 | 80504 | TRIGGER_TYPE_MISMATCH | 트리거의 타입 변경 불가 |
400 | 80505 | TRIGGER_BODY_INVALID_TYPE | 잘못된 요청 바디 필드 타입 |
400 | 80506 | TRIGGER_BODY_MISSING_FIELD | 요청 바디 필수 필드 누락 |
400 | 80507 | TRIGGER_BODY_INVALID_VALUE | 잘못된 요청 바디 필드 값 |
400 | 80700 | NO_APIGW_SUBSCRIPTION | API Gateway 서비스 이용 신청 필요 |
400 | 80710 | NO_INSIGHT_SUBSCRIPTION | Cloud Insight 이용 신청 필요 |
400 | 80711 | INSIGHT_INVALID_EVENT_RULE | 잘못된 Cloud Insight 이벤트 규칙 정보 |
400 | 80730 | NO_OBJECT_STORAGE_SUBSCRIPTION | Object Storage 이용 신청 필요 |
400 | 80731 | OBJECT_STORAGE_INVALID_EVENT_RULE | 잘못된 Object Storage 이벤트 규칙 정보 |
403 | 80002 | SUB_ACC_NO_PERMISSION | 상세 권한 오류 |
409 | 80011 | RESOURCE_NAME_CONFLICT | 중복된 리소스 이름 |
422 | 80508 | TRIGGER_COUNT_EXCEED | 최대 트리거 수 초과 |
- | 80005 | INTEGRATION_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"
}
}
이 문서가 도움이 되었습니까?