Put Package

Prev Next

Classic/VPC環境で利用できます。

Cloud Functionsパッケージを作成したり、変更したりします。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
PUT /packages/{packageName}

リクエストヘッダ

Cloud Funtions APIで共通して使用されるヘッダの詳細は、Cloud Functionsの共通ヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
packageName String Required パッケージ名
  • 英数字、記号「-」、「_」のみ使用して1~50文字以内で入力、先頭文字に「-」は使用不可

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
platform String Optional プラットフォーム区分
  • vpc(デフォルト) | classic

リクエストボディ

リクエストボディの説明は次の通りです。リクエストボディにフィールドがない場合、{}空の JSON Object形式でリクエストします。

フィールド タイプ 必須の有無 説明
description String Optional パッケージの説明(Byte)
  • 0~3,000
parameters Object Optional パッケージの基本パラメータ
  • {"key" : "value"}形式の JSON
  • アクション実行時、パラメータ適用の優先順位
    • 1番目: 実行時に渡されるランタイムパラメータ
    • 2番目: 関連付けられているトリガーの基本パラメータ
    • 3番目: アクションの基本パラメータ
    • 4番目: 含まれているパッケージの基本パラメータ

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request PUT 'https://cloudfunctions.apigw.ntruss.com/ncf/api/v2/packages/package001?platform=vpc' \
--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": "パッケージの作成",
    "parameters": {
        "name": "Cloud Funtions",
        "place": "Naver Cloud Platform"
    }
}

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 説明
content.description String パッケージの説明
content.name String パッケージ名
content.namespace String ユーザーのネームスペース
content.parameters Object パッケージの基本パラメータ
content.resourceId String パッケージのリソース ID

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード メッセージ 説明
400 80100 PACKAGE_INVALID_NAME 無効な名前形式
400 80102 PACKAGE_PLATFORM_MISMATCH 無効なプラットフォームパラメータ
400 80103 PACKAGE_BODY_INVALID_TYPE 無効なリクエストボディフィールドタイプ
400 80104 PACKAGE_BODY_MISSING_FIELD 必須リクエストボディフィールド漏れ
400 80105 PACKAGE_BODY_INVALID_VALUE 無効なリクエストボディフィールドの値
403 80002 SUB_ACC_NO_PERMISSION 詳細権限エラー
409 80011 RESOURCE_NAME_CONFLICT 重複したリソース名
422 80106 PACKAGE_COUNT_EXCEED 最大パッケージ数を超過

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "content": {
        "description": "パッケージの作成",
        "name": "package001",
        "namespace": "****YBN*****",
        "parameters": {
            "name": "Cloud Funtions",
            "place": "Naver Cloud Platform"
        },
        "resourceId": "xS***"
    }
}