Classic/VPC 환경에서 이용 가능합니다.
Cloud Functions는 코드를 작성하고 액션으로 등록함으로써 손쉽게 코드를 실행할 수 있는 서비스입니다. 서버 관리에 대한 부담 없이 손쉽게 원하는 비즈니스 로직을 실행할 수 있습니다.
Cloud Functions의 API 사용 방법은 아래 가이드를 참고하시기 바랍니다.
Cloud Functions 공통 설정
Cloud Functions API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.
요청
공통 요청 형식을 설명합니다.
API URL
요청 API URL은 다음과 같습니다.
| 리전 | 버전 | API URL | 플랫폼 |
|---|---|---|---|
| 한국 | v2.1 | https://cloudfunctions.apigw.ntruss.com | Classic, VPC |
| 한국 | v2.0 | https://cloudfunctions.apigw.ntruss.com | Classic, VPC |
| 싱가포르 | v2.1 | https://sg-cloudfunctions.apigw.ntruss.com | VPC |
| 싱가포르 | v2.0 | https://sg-cloudfunctions.apigw.ntruss.com | VPC |
| 일본 | v2.1 | https://jp-cloudfunctions.apigw.ntruss.com | VPC |
| 일본 | v2.0 | https://jp-cloudfunctions.apigw.ntruss.com | VPC |
요청 헤더
요청 헤더에 대한 설명은 다음과 같습니다.
| 필드 | 필수 여부 | 설명 |
|---|---|---|
x-ncp-apigw-timestamp |
Required | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
|
x-ncp-iam-access-key |
Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key |
x-ncp-apigw-signature-v2 |
Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 |
Content-type |
Required | 요청 데이터의 형식
|
응답
공통 응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
ErrorResponse
ErrorResponse는 API 호출 실패 정보를 정의합니다. ErrorResponse에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
error |
Object | - | 오류 코드 및 메시지 |
error.errorCode |
String | Required | 오류 코드 |
error.message |
String | Required | 오류 메시지 |
error.details |
String | Required | 오류 메시지 상세 설명 |
응답 상태 코드
응답 상태 코드에 대한 설명은 다음과 같습니다.
| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
|---|---|---|---|
| 400 | 80000 | INTERNAL_EXCEPTION | 요청 파라미터 오류 |
| 400 | 80100 | PACKAGE_INVALID_NAME | 잘못된 이름 형식 |
| 400 | 80102 | PACKAGE_PLATFORM_MISMATCH | 잘못된 플랫폼 파라미터 |
| 400 | 80102 | PACKAGE_PLATFORM_MISMATCH | 액션 상위 패키지의 플랫폼 변경 불가 |
| 400 | 80103 | PACKAGE_BODY_INVALID_TYPE | 잘못된 요청 바디 필드 타입 |
| 400 | 80104 | PACKAGE_BODY_MISSING_FIELD | 필수 요청 바디 필드 누락 |
| 400 | 80105 | PACKAGE_BODY_INVALID_VALUE | 잘못된 요청 바디 필드 값 |
| 400 | 80300 | ACTION_INVALID_NAME | 잘못된 액션 이름 |
| 400 | 80302 | ACTION_PLATFORM_MISMATCH | 잘못된 플랫폼 파라미터 |
| 400 | 80302 | ACTION_PLATFORM_MISMATCH | 액션 플랫폼 파라미터 오류 |
| 400 | 80302 | ACTION_PLATFORM_MISMATCH | 액션의 플랫폼 변경 불가 |
| 400 | 80303 | ACTION_INVALID_TYPE | 잘못된 액션 타입 |
| 400 | 80304 | ACTION_TYPE_MISMATCH | 액션의 타입 변경 불가 |
| 400 | 80305 | ACTION_BODY_INVALID_TYPE | 잘못된 요청 바디 필드 타입 |
| 400 | 80306 | ACTION_BODY_MISSING_FIELD | 필수 요청 바디 필드 누락 |
| 400 | 80307 | ACTION_BODY_INVALID_VALUE | 잘못된 요청 바디 필드 값 |
| 400 | 80316 | ACTION_INVALID_RUNTIME_PARAMS | 잘못된 요청 바디 형식 |
| 400 | 80324 | ACTION_RULE_EXCEED | 대상 액션의 트리거 연결 한도 초과 |
| 400 | 80500 | TRIGGER_INVALID_NAME | 잘못된 트리거 이름 |
| 400 | 80502 | TRIGGER_PLATFORM_MISMATCH | 잘못된 플랫폼 파라미터 |
| 400 | 80502 | TRIGGER_PLATFORM_MISMATCH | 트리거의 플랫폼 변경 불가 |
| 400 | 80502 | TRIGGER_PLATFORM_MISMATCH | 트리거 플랫폼 파라미터 오류 |
| 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 | 80519 | TRIGGER_RULE_EXCEED | 대상 트리거의 액션 연결 한도 초과 |
| 400 | 80520 | RULE_BODY_INVALID_TYPE | 잘못된 요청 바디 필드 타입 |
| 400 | 80521 | RULE_BODY_MISSING_FIELD | 요청 바디 필수 필드 누락 |
| 400 | 80511 | TRIGGER_INVALID_RUNTIME_PARAMS | 요청 바디 오류 |
| 400 | 80512 | TRIGGER_INVOKE_FAIL | 트리거에 연결된 액션이 없어 실행 불가 |
| 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 이벤트 규칙 정보 |
| 400 | 80740 | SOURCE_COMMIT_INVALID_WEBHOOK | 잘못된 SourceCommit 웹훅 정보 |
| 400 | 80750 | NO_SECRET_MANGER_SUBSCRIPTION | Secret Manager 이용 신청 필요 |
| 400 | 80751 | SECRET_MANAGER_INVALID_SECRET | 잘못된 Secret Manager 시크릿 정보 |
| 400 | 80752 | SECRET_MANAGER_SECRET_ROTATING | 교체 중인 Secret Manager 시크릿 |
| 400 | 80901 | DUPLICATED_RULE | 중복된 연결 요청 |
| 403 | 80002 | SUB_ACC_NO_PERMISSION | 리소스 조회 권한 오류 |
| 403 | 80002 | SUB_ACC_NO_PERMISSION | 상세 권한 오류 |
| 404 | 80101 | PACKAGE_NOT_FOUND | 패키지를 찾을 수 없음 |
| 404 | 80301 | ACTION_NOT_FOUND | 액션을 찾을 수 없음 |
| 404 | 80322 | ACTION_ACTIVATION_NOT_FOUND | 실행 이력을 찾을 수 없음 |
| 404 | 80501 | TRIGGER_NOT_FOUND | 트리거를 찾을 수 없음 |
| 404 | 80517 | TRIGGER_ACTIVATION_NOT_FOUND | 실행 이력을 찾을 수 없음 |
| 404 | 80900 | RULE_NOT_FOUND | 트리거와 액션이 연결되어 있지 않음 |
| 409 | 80109 | PACKAGE_NOT_EMPTY | 패키지에 연결된 액션이 있어 삭제 불가 |
| 409 | 80011 | RESOURCE_NAME_CONFLICT | 중복된 리소스 이름 |
| 422 | 80106 | PACKAGE_COUNT_EXCEED | 최대 패키지 수 초과 |
| 422 | 80308 | ACTION_COUNT_EXCEED | 최대 액션 개수 초과 |
| 422 | 80508 | TRIGGER_COUNT_EXCEED | 최대 트리거 수 초과 |
| 500 | 81311 | ACTION_NAT_EXCEPTION | 서브넷 조회 실패 |
| 500 | 81312 | NAT_CREATE_FAIL | 서브넷 연결 실패 |
| 500 | 81313 | NAT_BEING_CREATED | 서브넷 연결 중 |
| 500 | 81314 | NAT_RETURN_FAIL | 서브넷 연결 해지 중 |
| - | 80005 | INTEGRATION_EXCEPTION | 연동 서비스 이용 신청 필요 |
참고
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.
응답 예시
호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다.
{
"error": {
"errorCode": "string",
"message": "string",
"details": "string"
}
}