Get package

Prev Next

Available in Classic and VPC

View details of a Cloud Functions package.

Request

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

Method URI
GET /packages/{packageName}

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

Request query parameters

The following describes the parameters.

Field Type Required Description
platform String Optional Platform type
  • vpc (default) | classic

Request example

The following is a sample request.

curl --location --request GET 'https://cloudfunctions.apigw.ntruss.com/ncf/api/v2/packages/package001?platform=vpc' \
--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.

Field Type Description
content.action Object[] Action contained in the package
content.description String Package description
content.name String Package name
content.parameters Object Default parameter of the package
content.platform String Platform in which the package is created
content.resourceId String Package's resource ID

Response status codes

The following describes the response status codes.

HTTP status code Code Message Description
400 80102 PACKAGE_PLATFORM_MISMATCH Invalid platform parameter
403 80002 SUB_ACC_NO_PERMISSION Resource viewing permission error
404 80101 PACKAGE_NOT_FOUND Package not found

Response example

The following is a sample response.

{
    "content": {
        "actions": [],
        "description": "Create package",
        "name": "package001",
        "parameters": {
            "name": "Cloud Funtions",
            "place": "Naver Cloud Platform"
        },
        "platform": "vpc",
        "resourceId": "xS***"
    }
}