Put Action

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

概要

アクションを作成、修正します。

リクエスト

リクエスト URL

PUT {CLOUD_FUNCTIONS_API_URL}/packages/{packageName}/actions/{actionName}

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

パラメータ	要否	タイプ	制約事項	説明
packageName	Yes	string	アルファベット、数字、ハイフン(-)、アンダーバー(_)で構成された50字以内の文字列	- パッケージ名 - packageに属していない actionを作成する場合、packageNameにハイフン(-)を入力
actionName	Yes	string	アルファベット、数字、ハイフン(-)、アンダーバー(_)で構成された50字以内の文字列	アクション名

リクエストパラメータ

パラメータ名	要否	タイプ	制約事項	説明
platform	No	string	(classic \| vpc)	- プラットフォームタイプ - default classicで処理

リクエストボディ

Basic Action

{
    "description" : "string",
    "web" : "boolean",
    "raw-http" : "boolean",
    "custom-options" : "boolean",
    "parameters": {

    },
    "limits": {
        "timeout": "number",
        "memory": "number"
    },
    "exec": {
        "kind": "string",
        "code": "string",
        "binary": "boolean",
        "main": "string"
    },
    "vpc": {
        "vpcNo" : "number",
        "subnetNo" : "number"
    }
}

項目	要否	タイプ	制約事項	説明
description	No	string	3000byte以内の文字列	アクションの説明
web	No	Boolean	true/false	- ウェブアクション設定アクションを修正する場合、アクションタイプの変更が制限されます。 default valueは、以下のように作成/修正によって異なるように適用されます。 - 新規アクション作成の場合: false - 既存のアクションを修正する場合: アクションの既存タイプ
raw-http	No	Boolean	true/false	- HTTPソース使用の有無 - web設定が falseの場合、falseのみ許可
custom-options	No	Boolean	true/false	- ヘッダオプションの設定 - web設定が falseの場合、falseのみ許可
parameters	No		JSON形式。{"key" : "value"}の形式	アクションのデフォルトパラメータ設定 * アクション実行時のパラメータ適用優先順位 1順位: 実行時点で伝達されるランタイムパラメータ 2順位: 接続されたトリガーのデフォルトパラメータ 3順位: アクションのデフォルトパラメータ 4順位: 含まれるパッケージのデフォルトパラメータ
limits.timeout	Yes	number	MIN 500 MAX 300000	- アクションが実行される最大時間この時間を超えると強制終了 - ms単位、default: 60000ms
limits.memory	Yes	number	( 128 \| 256 \| 512 )	アクションコンテナに割り当てられるメモリ容量(default: 256)
exec.kind	Yes	string	( swift:3.1.1 \| python:3.6 \| python:3.7 \| python:3.11 \| php:7.1 \| php:7.3 \| nodejs:6 \| nodejs:8 \| nodejs:12 \| nodejs:16 \| java \| go:1.11 \| go:1.19 \| dotnet:2.2)	使用言語
exec.binary	Yes	boolean		- コードを直接入力する場合は false、ファイルバイナリを入力する場合は trueに設定 - 使用言語が javaあるいは dotnetの場合、ファイルバイナリのみ許可 - Javaは圧縮された.jarファイル形式でのみ登録可能、.net(dotnet)の場合.zipファイル(圧縮ファイル)形式でのみアップロード可能
exec.code	Yes	string		- ソースコード - コードを直接入力する場合、escape処理が必要
exec.main	Yes	string		コード内の実行する関数名を入力
vpc	No			- 連携する vpc情報を入力 - platformが vpcの場合にのみ入力
vpc.vpcNo	No	number		連携する vpc Noを入力
vpc.subnetNo	No	number		連携する subnet Noを入力

Sequence Action

{
    "description" : "string",
    "web" : "boolean",
    "exec": {
        "kind": "string",
        "components": [
          "string"
        ]
    }
}

項目	要否	タイプ	制約事項	説明
description	No	string	3000byte以内の文字列	アクションの説明
web	No	Boolean	true/false	- ウェブアクション設定アクションを修正する場合、アクションタイプの変更が制限されます。 default valueは、以下のように作成/修正によって異なるように適用されます。 - 新規アクション作成の場合: false - 既存のアクションを修正する場合: アクションの既存タイプ
exec.kind	Yes	string	sequence	シーケンスアクションを作成する場合、sequenceと入力
exec.components	Yes	string array	「{packageName}/{actionName}」の形で packageに属していない actionを連携する場合、packageNameに -を入力	シーケンスアクションに連携するアクションを順次に入力

レスポンス

レスポンスボディ

Basic Action

{
    "content": {
        "name": "string",
        "path": "string",
        "description": "string",
        "parameters": {},
        "resourceId": "string",
        "web": "boolean",
        "raw-http": "boolean",
        "custom-options": "boolean",
        "exec": {
            "binary": "boolean",
            "code": "string",
            "kind": "string",
            "main": "string"
        },
        "limits": {
            "memory": "number",
            "timeout": "number"
        },
        "vpc" : {
            "vpcNo": "number",
            "subnetNo": "number"
        }
    }
}

項目	タイプ	説明	備考
content.name	string	アクション名
content.path	string	アクションの path
content.description	string	アクションの説明
content.parameters	object	アクションのデフォルトパラメータ
content.resourceId	string	アクションの resourceId
content.web	boolean	ウェブアクション設定
content.raw-http	boolean	HTTPソース使用の有無
content.custom-options	boolean	ヘッダオプションの設定
content.exec.binary	boolean	コードのファイルバイナリの有無
content.exec.code	string	ソースコード
content.exec.kind	string	使用言語
content.exec.main	string	コード内の実行する関数
content.limits.memory	number	アクションコンテナに割り当てられるメモリサイズ
content.limits.timeout	number	アクションが実行される最大時間
content.vpc		vpc情報	Platformが vpcの場合にのみ表示
content.vpc.vpcNo	number	繋げられた vpcの No
content.vpc.vpcNo	number	繋げられた subnetの No

Sequence Action

{
    "content": {
        "name": "string",
        "path": "string",
        "description": "string",
        "resourceId": "string",
        "web": "boolean",
        "exec": {
            "kind": "string",
            "components": [
              "string"
            ]
        }
    }
}

項目	タイプ	説明
content.name	string	アクション名
content.path	string	アクションの path
content.description	string	アクションの説明
content.resourceId	string	アクションの resourceId
content.web	boolean	ウェブアクション設定
content.exec.kind	string	シーケンスアクション
content.exec.components	string array	繋げられたアクションリスト

この記事は役に立ちましたか?

What's Next

Post Action

概要
リクエスト
レスポンス

タグ

Cloud Functions