Get package

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	/ncf/api/v2/packages/{packageName}

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 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	Required	Description
`content.action`	Array	Action contained in the package: action

`action`

The following describes messages.

Field	Type	Required	Description
`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

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

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***"
    }
}