Put Action
  • PDF

Put Action

  • PDF

概要

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

リクエスト

リクエスト 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 ウェブアクションの設定
raw-http No Boolean true/false - HTTP原文使用の有無
- web設定が falseの場合、falseのみ許可
custom-options No Boolean true/false - ヘッダオプションの設定
- web設定が falseの場合、falseのみ許可
parameters Yes JSON形式。{"key" : "value"}の形式 - アクションのデフォルトパラメータを設定
- パラメータ適用の優先順位の適用基準
  1位: 実行時点で転送されるパラメータ
  2位: アクションのデフォルトパラメータ
  3位: パッケージのパラメータ
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 | 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 ウェブアクションの設定
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.namespace string アクションの path
content.description string アクションの説明
content.parameters
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.namespace string アクションの path
content.description string アクションの説明
content.resourceId string アクションの resourceId
content.web boolean ウェブアクションの設定
content.exec.kind string シーケンスアクション
content.exec.components string array 繋げられたアクションリスト

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

What's Next