Get action

Prev Next

Available in Classic and VPC

View a Cloud Functions action.

Request

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

Method URI
GET /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)

Request example

The following is a sample request.

curl --location --request GET 'https://cloudfunctions.apigw.ntruss.com/api/v2/packages/package003/actions?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}'

Response

The following describes the response format.

Response body

The following describes the response body.

Basic action

The following describes the response body for basic actions.

Field Type Required Description
content.custom-options Boolean - Set header options
  • Only support web actions
content.description String - Action description
content.exec.binary Boolean - Whether the action code file is binary or not
content.exec.code String - Action source code or Base64-encoded code file binary
content.exec.kind String - Language used
content.exec.main String - Functions to execute
content.limits.memory Integer - Size of memory allocated to the action container
content.limits.timeout Integer - Maximum time an action can run
content.name String - Action name
content.parameters Object - Default parameter of the action
content.vpc Object - VPC information
  • It is displayed only if platform is vpc
content.vpc.vpcNo Integer - Number of connected VPC
content.vpc.subnetNo Integer - Number of connected subnet
content.path String - Action path
content.raw-http Boolean - Whether to use HTTP origin
  • Only support web actions
content.resourceId String - Action's resource ID
content.web Boolean - Set web action

Sequence action

The following describes the response body for sequence actions.

Field Type Description
content.description String Action description
content.exec.components Object[] List of connected actions
content.exec.kind String Action type
  • sequence (fixed value)
content.name String Action name
content.path String Action path
content.resourceId String Action's resource ID
content.web Boolean Set web 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": {
        "custom-options": false,
        "description": "Create Action",
        "exec": {
            "binary": false,
            "code": "function main(params) { \nlet name = params.name || \"World\";\nlet place = params.place || \"Naver\"; \n  return {payload:  \"abc\"};\n}",
            "kind": "nodejs:16",
            "main": "main"
        },
        "limits": {
            "memory": 128,
            "timeout": 60000
        },
        "name": "action000",
        "parameters": {
            "name": "action000"
        },
        "path": "****YBNz****/package003",
        "raw-http": false,
        "resourceId": "Sy***",
        "web": false
    }
}