MENU
      Post action

        Post action


        Article summary

        Available in Classic and VPC

        Run a Cloud Functions action.

        Note

        Only the basic and sequence type actions can be executed.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        POST/packages/{packageName}/actions/{actionName}

        Request headers

        For headers common to all Cloud Functions APIs, see Cloud Functions common headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        packageNameStringRequiredPackage name
        • Enter the special character "-" for actions that are not part of a package
        actionNameStringRequiredAction name

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        platformStringOptionalPlatform type
        • vpc (default) | classic
        timeoutIntegerOptionalAction response maximum wait time (milliseconds)
        • 0 - 60,000 (default: 60,000)
        • If the action is executed beyond the set timeout, the response body contains only the action execution ID value

        Request body

        The following describes the request body.
        Depending on the type of the trigger, you can pass the runtime parameters of the required action in JSON format.

        FieldTypeRequiredDescription
        User-definedObjectOptionalAction runtime parameter

        Request example

        The following is a sample request.

        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}'
        -d '<See below>'
        Curl
        {
            "name": "Cloud Functions",
            "place": "NAVER Cloud"
        }
        JSON

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        Common fields

        FieldTypeDescription
        content.activationIdStringAction execution history ID
        content.durationIntegerAction execution time (milliseconds)
        content.endIntegerAction execution end time (milliseconds)
        • Unix timestamp
        content.nameStringAction name
        content.namespaceStringNamespace of the user
        content.responseObjectAction execution result information
        content.response.resultObjectAction execution result
        content.response.result.payloadStringMain function return value for action execution result
        content.response.statusStringAction status
        content.response.successBooleanWhether the action execution was successful
        content.startIntegerAction execution start time (milliseconds)
        • Unix timestamp
        content.subjectStringInformation of user who executed the action

        Response status codes

        The following describes the response status codes.

        HTTP status codeCodeMessageDescription
        40080302ACTION_PLATFORM_MISMATCHInvalid platform parameter
        40080316ACTION_INVALID_RUNTIME_PARAMSInvalid request body format
        40380002SUB_ACC_NO_PERMISSIONResource viewing permission error
        40480301ACTION_NOT_FOUNDAction not found

        Response example

        The following is a sample response.

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

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.