getCloudHadoopNotebookComponentList

Prev Next

VPC環境で利用できます。

Cloud Hadoopで使用可能なノートブックコンポーネントを照会します。

リクエスト

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

メソッド URI
GET | POST /vhadoop/v2/getCloudHadoopNotebookComponentList
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
cloudHadoopNotebookImageProductCode String Required ノートブックイメージコード
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vhadoop/v2/getCloudHadoopNotebookComponentList?regionCode=KR&cloudHadoopNotebookImageProductCode=SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
getCloudHadoopNotebookComponentListResponse Object - レスポンスの結果
getCloudHadoopNotebookComponentListResponse.requestId String - リクエスト ID
  • UUID形式
getCloudHadoopNotebookComponentListResponse.returnCode String - レスポンスコード
getCloudHadoopNotebookComponentListResponse.returnMessage String - レスポンスメッセージ

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

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

レスポンス例

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

{
    "getCloudHadoopNotebookComponentListResponse": {
        "totalRows": 1,
        "cloudHadoopNotebookComponentList": [
            {
                "code": "NOTEBOOK_1.0",
                "codeName": "Jupyter notebook 6.4.10 , JupyterLab : 3.2.9"
            }
        ],
        "requestId": "a3ae4016-****-****-****-6e143e7ad22a",
        "returnCode": "0",
        "returnMessage": "success"
    }
}