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 | NAVERクラウドプラットフォームから発行された Access Key
|
x-ncp-apigw-signature-v2 |
Required | NAVERクラウドプラットフォームから発行された 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 Webhook情報 |
| 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 | 連携サービスご利用の申し込みが必要 |
参考
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。
{
"error": {
"errorCode": "string",
"message": "string",
"details": "string"
}
}