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/api/v2/packages/package003?platform=classic' \
--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": "package003",
    }
}

レスポンス

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

レスポンスボディ

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

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

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

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "content": {
        "description": "put package",
        "name": "package003",
        "namespace": "****YBN*****",
        "parameters": {
            "name": "package003"
        },
        "resourceId": "xn***"
    }
}