Get Package

Prev Next

Available in Classic and VPC

Get details of a Cloud Functions package.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /ncf/api/v2/packages/{packageName}
Note

Singapore and Japan Regions are available only in the VPC environment.

Request headers

For information about the headers common to all Cloud Functions APIs, see Cloud Functions request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
packageName String Required Package name

Request query parameters

You can use the following query parameters with your request:

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

Request example

The request example is as follows:

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

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
content Object - Package details
content.action Array - Action contained in the package
content.description String - Package description
content.name String - Package name
content.parameters Object - Default parameters of the package
content.platform String - Platform where the package was created
content.resourceId String - Package's resource ID

Response status codes

For information about the HTTP status codes common to all Cloud Functions APIs, see Cloud Functions response status codes.

Response example

The response example is as follows:

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