Post Action

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

Cloud Functionsアクションを実行します。

リクエスト

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

メソッド	URI
POST	/packages/{packageName}/actions/{actionName}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`packageName`	String	Required	パッケージ名パッケージに属さないアクションの場合、記号の「-」を入力 <例> `/packages/-/actions/myaction`
`actionName`	String	Required	アクション名

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

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

フィールド	タイプ	必須の有無	説明
`platform`	String	Optional	プラットフォーム区分 `vpc` \| `classic`(デフォルト)
`timeout`	Integer	Optional	アクションレスポンス最大待機時間(ミリ秒) 0~60,000 (デフォルト: 60,000) アクションが設定されたタイムアウトを超えて実行される場合、レスポンスボディにアクション実行 IDのみ含まれる

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
ユーザー定義	Object	Optional	アクションランタイムパラメータ `{"key": "value"}`形式の JSON

リクエスト例

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

curl --location --request POST 'https://cloudfunctions.apigw.ntruss.com/api/v2/packages/package003/actions/action000?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 '<下記参照>'

{
    "name": "Cloud Functions",
    "place": "NAVER Cloud"
}

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	説明
`content.activationId`	String	アクション実行 ID
`content.duration`	Integer	実行時間
`content.start`	Integer	アクション実行開始時間(ミリ秒) Unix Timestamp
`content.end`	Integer	アクション実行終了時間(ミリ秒) Unix Timestamp
`content.name`	String	アクション名
`content.namespace`	String	ユーザーのネームスペース
`content.response`	Object	アクション実行結果情報
`content.response.result`	Object	アクション実行結果
`content.response.status`	String	アクションの状態
`content.response.success`	Boolean	アクション実行は成功したかどうか
`content.subject`	String	アクションを実行したユーザー情報

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

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

レスポンス例

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

{
    "content": {
        "activationId": "*****6a1fcab420490f6a1fcab0*****",
        "duration": 33,
        "end": 1714021538121,
        "name": "action000",
        "namespace": "****YBNz****",
        "response": {
            "result": {
                "payload": "abc"
            },
            "status": "success",
            "success": true
        },
        "start": 1714021538088,
        "subject": "****YBNz****"
    }
}