- 인쇄
- PDF
Put Trigger
- 인쇄
- PDF
Cloud Functions 트리거를 생성, 수정합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
PUT | /triggers/{triggerName} |
요청 헤더
Cloud Funtions API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud Functions 공통 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
triggerName | String | Required | 트리거 이름
|
요청 쿼리 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
type | String | Optional | 트리거 유형
|
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
Basic 트리거
Basic 트리거 요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
trigger | Object | Required | 트리거 정보 |
trigger.description | String | Optional | 트리거 설명(Byte)
|
trigger.parameters | Object | Optional | 트리거의 기본 파라미터
|
link | Object | Conditional | API Gateway 정보
|
link.productId | String | Conditional | API Gateway의 상품 ID |
link.apiName | String | Conditional | API Gateway의 API 이름 |
link.stageName | String | Conditional | API Gateway의 스테이지 이름 |
link.authentication | String | Optional | API Gateway의 인증 방식
|
cron 트리거
cron 트리거 요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
trigger | Object | Required | 트리거 정보 |
trigger.description | String | Optional | 트리거 설명(Byte)
|
trigger.cronOption | String | Required | cron 실행 옵션 |
trigger.parameters | Object | Optional | 트리거의 기본 파라미터
|
Cloud Insight 트리거
Cloud Insight 트리거 요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
trigger | Object | Required | 트리거 정보 |
trigger.description | String | Optional | 트리거 설명(Byte)
|
trigger.parameters | Object | Optional | 트리거의 기본 파라미터
|
trigger.insightLink | Object[] | Required | Cloud Insight 정보 |
trigger.insightLink[].prodKey | String | Required | Cloud Insight 이벤트 규칙의 prodKey |
trigger.insightLink[].ruleGrpId | String | Required | Cloud Insight 이벤트 규칙의 ruleGrpId |
trigger.insightLink[].reminderTime | Integer | Optional | Cloud Insight 이벤트 규칙의 리마인드 알림 주기(분)
|
trigger.insightLink[].enableNotiWhenEventClose | Boolean | Optional | 이벤트 종료 시 Cloud Insight 이벤트 규칙 호출 여부
|
Object Storage 트리거
Object Storage 트리거 요청 바디에 대한 설명은 다음과 같습니다.
Object Storage 트리거에 연결된 액션이 Object Storage 이벤트 규칙과 동일한 버킷을 사용할 경우, 재귀 호출로 인한 사용량 증가 및 과다한 비용이 발생할 수 있습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
trigger | Object | Required | 트리거 정보 |
trigger.description | String | Optional | 트리거 설명(Byte)
|
trigger.parameters | Object | Optional | 트리거의 기본 파라미터
|
trigger.objectStorageLink | Object[] | Required | Object Storage 정보 |
trigger.objectStorageLink[].bucketName | String | Required | Object Storage의 버킷 이름 |
trigger.objectStorageLink[].eventRuleName | String | Required | Object Storage의 이벤트 규칙 이름 |
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request PUT 'https://cloudfunctions.apigw.fin-ntruss.com/api/v2/triggers/trigger002' \
--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 '<하단 참조>'
{
"trigger": {
"description": "cron Trigger",
"cronOption": "0 10 * * *",
"parameters": {
}
}
}
응답
응답 형식을 설명합니다.
응답 바디
요청한 트리거에 따른 응답 바디에 대한 설명은 다음과 같습니다.
Basic 트리거
Basic 트리거 응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 설명 |
---|---|---|
content.name | String | 트리거 이름 |
content.namespace | String | 사용자 네임스페이스 |
content.description | String | 트리거 설명 |
content.triggerType | String | 트리거 유형 |
content.resourceId | String | 트리거의 리소스 ID |
content.parameters | Object | 트리거의 기본 파라미터 |
content.rules | String | 트리거 액션 연결 정보 |
Cron 트리거
Cron 트리거 응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 설명 |
---|---|---|
content.cronOptions | String | 트리거 cron 실행 옵션 |
content.description | String | 트리거 설명 |
content.name | String | 트리거 이름 |
content.namespace | String | 사용자 네임스페이스 |
content.parameters | Object | 트리거의 기본 파라미터 |
content.resourceId | String | 트리거의 리소스 ID |
content.rules | String | 트리거 액션 연결 정보 |
content.triggerType | String | 트리거 유형 |
Cloud Insight 트리거
Cloud Insight 트리거 응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 설명 |
---|---|---|
content.description | String | 트리거 설명 |
content.name | String | 트리거 이름 |
content.namespace | String | 사용자 네임스페이스 |
content.parameters | Object | 트리거의 기본 파라미터 |
content.insightLink | Object[] | 연결된 Cloud Insight 이벤트 규칙 정보 |
content.insightLink[].prodKey | String | Cloud Insight 이벤트 규칙의 prodKey |
content.insightLink[].ruleGrpId | String | Cloud Insight 이벤트 규칙의 groupId |
content.insightLink[].reminderTime | Integer | Cloud Insight 이벤트 규칙의 리마인드 알림 주기(분) |
content.insightLink[].enableNotiWhenEventClose | Boolean | 이벤트 종료 시 Cloud Insight 이벤트 규칙 호출 여부 |
content.resourceId | String | - |
content.rules | String | - |
content.triggerType | String | - |
Object Storage 트리거
Object Storage 트리거 응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 설명 |
---|---|---|
content.description | String | 트리거 설명 |
content.name | String | 트리거 이름 |
content.namespace | String | 사용자 네임스페이스 |
content.parameters | Object | 트리거의 기본 파라미터 |
content.objectStorageLink | Object[] | 연결된 Object Storage 이벤트 규칙 정보 |
content.objectStorageLink[].bucketName | String | Object Storage 이벤트 규칙의 버킷 이름 |
content.objectStorageLink[].eventRuleName | String | Object Storage 이벤트 규칙 이름 |
content.resourceId | String | 트리거의 리소스 ID |
content.rules | String | 트리거 액션 연결 정보 |
content.triggerType | String | 트리거 유형 |
응답 상태 코드
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"content": {
"cronOption": "0 10 * * *",
"description": "cron Trigger",
"limits": {},
"name": "trigger002",
"namespace": "****YBNz****",
"parameters": {},
"resourceId": "Nu3**",
"rules": {},
"triggerType": "Cron"
}
}