MENU
      Post action

        Post action


        Article summary

        Available in Classic and VPC

        Run a Cloud Functions action.

        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
          • <E.g.> /packages/-/actions/myaction
        actionNameStringRequiredAction name

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        platformStringOptionalPlatform type
        • vpc | classic (default)
        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.

        FieldTypeRequiredDescription
        User-definedObjectOptionalAction runtime parameters
        • JSON in the form of {"key": "value"}

        Request example

        The following is a sample request.

        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 '<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.

        FieldTypeDescription
        content.activationIdStringAction execution ID
        content.durationIntegerExecution time
        content.startIntegerAction execution start time (milliseconds)
        • Unix timestamp
        content.endIntegerAction execution end time (milliseconds)
        • Unix timestamp
        content.nameStringAction name
        content.namespaceStringUser namespace
        content.responseObjectAction execution result information
        content.response.resultObjectAction execution result
        content.response.statusStringAction status
        content.response.successBooleanWhether the action execution was successful
        content.subjectStringInformation of user who executed the action

        Response status codes

        For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

        Response example

        The following is a sample response.

        {
            "content": {
                "activationId": "*****6a1fcab420490f6a1fcab0*****",
                "duration": 33,
                "end": 1714021538121,
                "name": "action000",
                "namespace": "****YBNz****",
                "response": {
                    "result": {
                        "payload": "abc"
                    },
                    "status": "success",
                    "success": true
                },
                "start": 1714021538088,
                "subject": "****YBNz****"
            }
        }
        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.