Get Package

Prev Next

Classic/VPC環境で利用できます。

Cloud Functionsパッケージの詳細情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /ncf/api/v2/packages/{packageName}

リクエストヘッダ

Cloud Functions APIで共通して使用されるヘッダの詳細は、Cloud Functionsのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
packageName String Required パッケージ名

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
platform String Optional プラットフォーム区分
  • vpc(デフォルト) | classic

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
content.action Array - パッケージに含まれたアクション
content.description String - パッケージの説明
content.name String - パッケージ名
content.parameters Object - パッケージの基本パラメータ
content.platform String - パッケージが作成されたプラットフォーム
content.resourceId String - パッケージのリソース ID

レスポンスステータスコード

Cloud Functions APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Functionsのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "content": {
        "actions": [],
        "description": "パッケージの作成",
        "name": "package001",
        "parameters": {
            "name": "Cloud Funtions",
            "place": "Naver Cloud Platform"
        },
        "platform": "vpc",
        "resourceId": "xS***"
    }
}