Post Action

最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

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

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

参考

web、sequence-webタイプアクションで HTTPリクエスト/レスポンスを直接処理できません。関連機能は API Gatewayタイプトリガーをご使用ください。

リクエスト

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

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

リクエストヘッダ

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

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

リクエストパスパラメータの説明は次の通りです。

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

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

リクエストクエリパラメータの説明は次の通りです。

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

リクエストボディ

リクエストボディの説明は次の通りです。
トリガーの種類に応じて必要なアクションのランタイムパラメータを JSON形式で渡すことができます。

フィールド	タイプ	必須の有無	説明
ユーザー定義	Object	Optional	アクションのランタイムパラメータ

リクエスト例

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

curl -X POST 'https://cloudfunctions.apigw.ntruss.com/ncf/api/v2/packages/{packageName}/actions/{actionName}?platform=vpc&timeout=60000' \
--header 'Content-Type: application/json; charset=utf-8' \
--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.end`	Integer	-	アクション実行の終了時間(ミリ秒) Unix Timestamp
`content.name`	String	-	アクションの名前
`content.namespace`	String	-	ユーザーのネームスペース
`content.response`	Object	-	アクションの実行結果情報
`content.response.result`	Object	-	アクションの実行結果
`content.response.result.payload`	String	-	アクションの実行結果に対してメイン関数が返す値
`content.response.status`	String	-	アクションの状態
`content.response.success`	Boolean	-	アクション実行は成功したかどうか
`content.start`	Integer	-	アクション実行の開始時間(ミリ秒) Unix Timestamp
`content.subject`	String	-	アクションを実行したユーザー情報

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

Cloud Functions APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Functionsのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "content": {
        "activationId": "***fe30d270d4bc29fe30d270debc2f7",
        "duration": 3,
        "end": 1713936450102,
        "name": "myaction",
        "namespace": "***QK06kFG8C",
        "response": {
            "result": {
                "payload": "abc"
            },
            "status": "success",
            "success": true
        },
        "start": 1713936450099,
        "subject": "***QK06kFG8C"
    }
}