MENU
      getCloudDBImageProductList

        getCloudDBImageProductList


        Article summary

        Overview

        Gets a list of available Cloud DB image products.

        Request

        Request header

        HeaderDescription
        x-ncp-apigw-timestampIt is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid.
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-apigw-api-keyAPI key issued by API Gateway (not used in the API v2)
        x-ncp-apigw-api-key:{API Gateway API Key}
        x-ncp-iam-access-keyAccess Key ID issued from the NAVER Cloud Platform portal.
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2Signature encrypted with your Access Key ID and Secret Key.
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeSet the request body content type to application/json.
        Content-Type: application/json

        Request body

        Field names in the request body are case sensitive.

        ParameterRequiredTypeLimitationsDescription
        exclusionProductCodeNstringMin: 1, Max: 20Product code to exclude
        productCodeNstringMin: 1, Max: 20Product code to get
        dbKindCodeYstringMYSQL, MSSQL, REDISDB type code
        regionNoNstringRegion number
        responseFormatTypeNStringResponse format
        • exclusionProductCode
          • Product code to exclude from the results.
        • productCode
          • Code of the product to get.
        • dbKindCode
          • Cloud DB type. Select among MSSQL, MySQL, and Redis.
        • regionNo
          • Region number
        • responseFormatType
          • Response format. Select between xml and json.

        Response

        FieldTypeDescriptionNote
        requestIdStringRequest ID
        returnMessageStringResponse message
        totalRowsIntegerNumber of response result rows
        productList[]StringList of products

        Examples

        Request example

        curl -X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBImageProductList?dbKindCode=MSSQL&regionNo=1&responseFormatType=json"
        -H "accept: application/json"
        -H "Content-Type: application/x-www-form-urlencoded"
        -H "x-ncp-apigw-api-key: 25bpuog9sz"
        -H "x-ncp-iam-access-key: Y0Z9EG0lKoeWAQCSHRtM"
        -H "x-ncp-apigw-timestamp: 1545976216257"
        -H "x-ncp-apigw-signature-v2: IM4D9Iepn7kp91QXSGKVdYizh0Uoxd1tVGyZDMqXfWs="
        
        https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBImageProductList?dbKindCode=MSSQL&regionNo=1&responseFormatType=json
        HTTP

        Request sample

        • Get a list of images available for Cloud DB for MSSQL
        {
          "dbKindCode": "MSSQL",
          "regionNo": "1",
          "responseFormatType": "json"
        }
        JSON

        Response example

        connection: keep-alive
        content-type: application/json;charset=UTF-8
        date: Mon, 24 Dec 2018 08:59:40 GMT
        server: nginx
        transfer-encoding: chunked
        x-ncp-trace-id: 6acpi6di6apj536ob5cksjcor2
        HTTP
        {
          "getCloudDBImageProductListResponse": {
            "requestId": "a7d58040-5ee9-4895-8921-10383d2a4a99",
            "returnCode": "0",
            "returnMessage": "success",
            "productList": [
              {
                "productCode": "SPSWMSSQLWINNT01",
                "productName": "Windows Server 2012r2 with MSSQL 2016 standard edition",
                "productType": {
                  "code": "WINNT",
                  "codeName": "Windows NT"
                },
                "productDescription": "Windows Server 2012r2 with MSSQL 2016 standard edition",
                "infraResourceType": {
                  "code": "SW",
                  "codeName": "Software"
                },
                "cpuCount": 0,
                "memorySize": 0,
                "baseBlockStorageSize": 53687091200,
                "platformType": {
                  "code": "WND64",
                  "codeName": "Windows 64 Bit"
                },
                "osInformation": "Windows Server 2012r2 with MSSQL 2016 standard edition",
                "dbKindCode": "MSSQL",
                "addBlockStorageSize": 0
              }
            ],
            "totalRows": 1
          }
        }
        JSON

        Error codes

        If a Cloud DB API request is invalid or an error occurs while processing the request, the API returns an HTTP status code representing success or failure with a detailed message in JSON.

        There are two types of error codes: “common error code” of the Cloud DB API and “API Gateway error code.”

        Error codeResponse messageDescription
        200Ok
        500Server Error

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.