getCloudHadoopNotebookImageProductList

Prev Next

Available in VPC

Get notebook images available for use in Cloud Hadoop.

Request

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

Method URI
GET | POST /vhadoop/v2/getCloudHadoopNotebookImageProductList
Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

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

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
regionCode String Optional Region code
productCode String Optional Filter by notebook image code.
exclusionProductCode String Optional Filter by excluding notebook image code.
responseFormatType String Optional Format of the response data
  • xml (default) | json

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vhadoop/v2/getCloudHadoopNotebookImageProductList?regionCode=KR&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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
getCloudHadoopNotebookImageProductListResponse Object - Response result
getCloudHadoopNotebookImageProductListResponse.requestId String - ID for the request
  • UUID format
getCloudHadoopNotebookImageProductListResponse.returnCode String - Response code
getCloudHadoopNotebookImageProductListResponse.returnMessage String - Response message

Response status codes

For response status codes common to all Cloud Hadoop APIs, see Cloud Hadoop response status codes.

Response example

The response example is as follows:

{
    "getCloudHadoopNotebookImageProductListResponse": {
        "totalRows": 2,
        "productList": [
            {
                "productCode": "SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050",
                "productName": "Notebook 1.0",
                "productType": {
                    "code": "LINUX",
                    "codeName": "Linux"
                },
                "productDescription": "CentOS 7.8 with Notebook 1.0",
                "infraResourceType": {
                    "code": "SW",
                    "codeName": "Software"
                },
                "baseBlockStorageSize": 53687091200,
                "platformType": {
                    "code": "LNX64",
                    "codeName": "Linux 64 Bit"
                },
                "osInformation": "CentOS 7.8 with Notebook 1.0 (64-bit)",
                "generationCode": "G2",
                "engineVersionCode": "NOTEBOOK1.0"
            },
            {
                "productCode": "SW.VCHDP.OS.LNX64.ROCKY.0810.HDNTB.B050",
                "productName": "Cloud Hadoop - Notebook",
                "productType": {
                    "code": "LINUX",
                    "codeName": "Linux"
                },
                "productDescription": "Rocky Linux 8.10 with Cloud Hadoop",
                "infraResourceType": {
                    "code": "SW",
                    "codeName": "Software"
                },
                "baseBlockStorageSize": 53687091200,
                "platformType": {
                    "code": "LNX64",
                    "codeName": "Linux 64 Bit"
                },
                "osInformation": "Rocky Linux 8.10 with Cloud Hadoop (64-bit)",
                "generationCode": "G2",
                "engineVersionCode": "NOTEBOOK1.1"
            }
        ],
        "requestId": "281e7037-****-****-****-885894dcafbc",
        "returnCode": "0",
        "returnMessage": "success"
    }
}