getCloudDBProductList
    • PDF

    getCloudDBProductList

    • PDF

    Article summary

    Overview

    View the list of available Cloud DB products.

    Request

    Request headers

    Header nameDescription
    x-ncp-apigw-timestampIt indicates the time elapsed since January 1, 1970, 00:00:00 UTC in milliseconds and the request is considered invalid if the time difference from the API Gateway server is greater than 5 minutes
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-apigw-api-keyKey value issued by APIGW; api-key is not used when using v2
    x-ncp-apigw-api-key:{API Gateway API Key}
    x-ncp-iam-access-keyAccess key ID value issued from the NAVER Cloud Platform portal
    x-ncp-iam-access-key:{Sub Account Access Key}
    x-ncp-apigw-signature-v2Signature encrypted with the access key ID value and secret key
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeSpecify the request body content type as application/json
    Content-Type: application/json

    Request body

    For API request, field names should be case-sensitive.

    Parameter nameRequirement statusTypeRestrictionsDescription
    exclusionProductCodeNstringMin : 1, Max : 20Product code to exclude
    cloudDBImageProductCodeYstringImage product code to query
    productCodeNstringProduct code to query
    regionNoNstringRegion number
    zoneNoNstringZone number
    responseFormatTypeNStringSets the results format of the response
    • exclusionProductCode
      • Enter the product code to be excluded from the query results.
    • cloudDBImageProductCode
    • productCode
      • Enter the code of the product to query.
    • regionNo
      • Enter a region number.
    • zoneNo
      • Enter a zone number.
    • responseFormatType
      • Determine the format of the API execution result to be received. You may select from xml and json.

    Response

    Field nameTypeDescriptionRemarks
    requestIdStringRequest ID value
    returnCodeIntegerResponse code value
    returnMessageStringResponse message
    productList[]StringProduct list information

    Examples

    Request examples

    curl
    -X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBProductList?cloudDBImageProductCode=SPSWMYSQLLINUX01&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: 1545982751940"
    -H "x-ncp-apigw-signature-v2: z2nVurpvxfctfQ9csfzgo2qKD2+iOsJhUTdniuaJVCI="
    
    https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBProductList?cloudDBImageProductCode=SPSWMYSQLLINUX01&responseFormatType=json
    

    Request sample

    • View the Cloud DB for MySQL product list
    {
      "cloudDBImageProductCode": "SPSWMYSQLLINUX01",
      "responseFormatType": "json"
    }
    

    Response examples

    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
    
    {
      "getCloudDBProductListResponse": {
        "requestId": "e8531972-c127-4ec0-aa32-86e6ad98a82c",
        "returnCode": "0",
        "returnMessage": "success",
        "productList": [
          {
            "productCode": "SPSVRDBAAS000001",
            "productName": "vCPU 2EA, Memory 4GB",
            "productType": {
              "code": "STAND",
              "codeName": "Standard"
            },
            "productDescription": "vCPU 2EA, Memory 4GB",
            "infraResourceType": {
              "code": "DBAAS",
              "codeName": "Cloud DB"
            },
            "cpuCount": 2,
            "memorySize": 4294967296,
            "baseBlockStorageSize": 53687091200,
            "osInformation": "",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "dbKindCode": "",
            "addBlockStorageSize": 0
          },
          {
            "productCode": "SPSVRDBAAS000005",
            "productName": "vCPU 2EA, Memory 8GB",
            "productType": {
              "code": "STAND",
              "codeName": "Standard"
            },
            "productDescription": "vCPU 2EA, Memory 8GB",
            "infraResourceType": {
              "code": "DBAAS",
              "codeName": "Cloud DB"
            },
            "cpuCount": 2,
            "memorySize": 8589934592,
            "baseBlockStorageSize": 53687091200,
            "osInformation": "",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "dbKindCode": "",
            "addBlockStorageSize": 0
          },
          {
            "productCode": "SPSVRDBAAS000002",
            "productName": "vCPU 4EA, Memory 8GB",
            "productType": {
              "code": "STAND",
              "codeName": "Standard"
            },
            "productDescription": "vCPU 4EA, Memory 8GB",
            "infraResourceType": {
              "code": "DBAAS",
              "codeName": "Cloud DB"
            },
            "cpuCount": 4,
            "memorySize": 8589934592,
            "baseBlockStorageSize": 53687091200,
            "osInformation": "",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "dbKindCode": "",
            "addBlockStorageSize": 0
          },
          {
            "productCode": "SPSVRDBAAS000006",
            "productName": "vCPU 4EA, Memory 16GB",
            "productType": {
              "code": "STAND",
              "codeName": "Standard"
            },
            "productDescription": "vCPU 4EA, Memory 16GB",
            "infraResourceType": {
              "code": "DBAAS",
              "codeName": "Cloud DB"
            },
            "cpuCount": 4,
            "memorySize": 17179869184,
            "baseBlockStorageSize": 53687091200,
            "osInformation": "",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "dbKindCode": "",
            "addBlockStorageSize": 0
          },
          {
            "productCode": "SPSVRDBAAS000003",
            "productName": "vCPU 8EA, Memory 16GB",
            "productType": {
              "code": "STAND",
              "codeName": "Standard"
            },
            "productDescription": "vCPU 8EA, Memory 16GB",
            "infraResourceType": {
              "code": "DBAAS",
              "codeName": "Cloud DB"
            },
            "cpuCount": 8,
            "memorySize": 17179869184,
            "baseBlockStorageSize": 53687091200,
            "osInformation": "",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "dbKindCode": "",
            "addBlockStorageSize": 0
          },
          {
            "productCode": "SPSVRDBAAS000007",
            "productName": "vCPU 8EA, Memory 32GB",
            "productType": {
              "code": "STAND",
              "codeName": "Standard"
            },
            "productDescription": "vCPU 8EA, Memory 32GB",
            "infraResourceType": {
              "code": "DBAAS",
              "codeName": "Cloud DB"
            },
            "cpuCount": 8,
            "memorySize": 34359738368,
            "baseBlockStorageSize": 53687091200,
            "osInformation": "",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "dbKindCode": "",
            "addBlockStorageSize": 0
          },
          {
            "productCode": "SPSVRDBAAS000004",
            "productName": "vCPU 16EA, Memory 32GB",
            "productType": {
              "code": "STAND",
              "codeName": "Standard"
            },
            "productDescription": "vCPU 16EA, Memory 32GB",
            "infraResourceType": {
              "code": "DBAAS",
              "codeName": "Cloud DB"
            },
            "cpuCount": 16,
            "memorySize": 34359738368,
            "baseBlockStorageSize": 53687091200,
            "osInformation": "",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "dbKindCode": "",
            "addBlockStorageSize": 0
          },
          {
            "productCode": "SPSVRDBAAS000020",
            "productName": "vCPU 8EA, Memory 64GB",
            "productType": {
              "code": "HIMEM",
              "codeName": "High Memory"
            },
            "productDescription": "vCPU 8EA, Memory 64GB",
            "infraResourceType": {
              "code": "DBAAS",
              "codeName": "Cloud DB"
            },
            "cpuCount": 8,
            "memorySize": 68719476736,
            "baseBlockStorageSize": 53687091200,
            "osInformation": "",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "dbKindCode": "",
            "addBlockStorageSize": 0
          },
          {
            "productCode": "SPSVRDBAAS000021",
            "productName": "vCPU 16EA, Memory 64GB",
            "productType": {
              "code": "HIMEM",
              "codeName": "High Memory"
            },
            "productDescription": "vCPU 16EA, Memory 64GB",
            "infraResourceType": {
              "code": "DBAAS",
              "codeName": "Cloud DB"
            },
            "cpuCount": 16,
            "memorySize": 68719476736,
            "baseBlockStorageSize": 53687091200,
            "osInformation": "",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "dbKindCode": "",
            "addBlockStorageSize": 0
          },
          {
            "productCode": "SPSVRDBAAS000022",
            "productName": "vCPU 16EA, Memory 128GB",
            "productType": {
              "code": "HIMEM",
              "codeName": "High Memory"
            },
            "productDescription": "vCPU 16EA, Memory 128GB",
            "infraResourceType": {
              "code": "DBAAS",
              "codeName": "Cloud DB"
            },
            "cpuCount": 16,
            "memorySize": 137438953472,
            "baseBlockStorageSize": 53687091200,
            "osInformation": "",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "dbKindCode": "",
            "addBlockStorageSize": 0
          },
          {
            "productCode": "SPSVRDBAAS000023",
            "productName": "vCPU 32EA, Memory 128GB",
            "productType": {
              "code": "HIMEM",
              "codeName": "High Memory"
            },
            "productDescription": "vCPU 32EA, Memory 128GB",
            "infraResourceType": {
              "code": "DBAAS",
              "codeName": "Cloud DB"
            },
            "cpuCount": 32,
            "memorySize": 137438953472,
            "baseBlockStorageSize": 53687091200,
            "osInformation": "",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "dbKindCode": "",
            "addBlockStorageSize": 0
          },
          {
            "productCode": "SPSVRDBAAS000024",
            "productName": "vCPU 32EA, Memory 256GB",
            "productType": {
              "code": "HIMEM",
              "codeName": "High Memory"
            },
            "productDescription": "vCPU 32EA, Memory 256GB",
            "infraResourceType": {
              "code": "DBAAS",
              "codeName": "Cloud DB"
            },
            "cpuCount": 32,
            "memorySize": 274877906944,
            "baseBlockStorageSize": 53687091200,
            "osInformation": "",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "dbKindCode": "",
            "addBlockStorageSize": 0
          }
        ],
        "totalRows": 12
      }
    }
    

    Errors

    If the Cloud DB API request fails or an error has occurred while processing, a success or failure is returned with the HTTP status code and a detailed message is returned in JSON format.

    The errors are divided into two, "common error code" of the Cloud DB API and "API Gateway error code."

    ErrorsResponse 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.