Post action

Prev Next

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:

Method URI
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.

Field Type Required Description
packageName String Required Package name
  • Enter the special character "-" for actions that are not part of a package
    • <E.g.> /packages/-/actions/myaction
actionName String Required Action name

Request query parameters

The following describes the parameters.

Field Type Required Description
platform String Optional Platform type
  • vpc | classic (default)
timeout Integer Optional Action 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.

Field Type Required Description
User-defined Object Optional Action 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>'

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

Response

The following describes the response format.

Response body

The following describes the response body.

Field Type Description
content.activationId String Action execution ID
content.duration Integer Execution time
content.start Integer Action execution start time (milliseconds)
  • Unix timestamp
content.end Integer Action execution end time (milliseconds)
  • Unix timestamp
content.name String Action name
content.namespace String User namespace
content.response Object Action execution result information
content.response.result Object Action execution result
content.response.status String Action status
content.response.success Boolean Whether the action execution was successful
content.subject String Information 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****"
    }
}