createCloudDBInstance

Prev Next

概要

CloudDBインスタンスを作成します。

リクエスト

リクエストヘッダ

ヘッダ名 説明
x-ncp-apigw-timestamp 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとしてみなす。
x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key APIGWで発行されたキーの値、v2を使用する場合、api-keyは使いません。
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key Naverクラウドプラットフォームで発行されたAccess Key ID値
x-ncp-iam-access-key:{Sub Account Access Key}
x-ncp-apigw-signature-v2 Access Key ID値とSecret Keyで暗号化した署名
x-ncp-apigw-signature-v2:{API Gateway Signature}
Content-Type Request body content typeをapplication/jsonに指定
Content-Type: application/json

リクエストボディ

APIリクエスト時には、フィールド名の大小文字区分が必要です。

フィールド名 必須 タイプ 制約事項 説明
cloudDBImageProductCode No String Cloud DBイメージ商品コード
getCloudDBImageProductList APIを通じて必要な入力値を照会できます。
cloudDBProductCode No String default : 最小仕様で選択 Cloud DB商品スペックコード
getCloudDBProductList APIを通じて必要な入力値を照会できます。
dbKindCode Yes String MYSQL | MSSQL | REDIS DBタイプコード
作成するCloud DBタイプの選択
collation No String Korean_Wansung_CI_AS | SQL_Latin1_General_CP1_CI_AS 文字セット
文字照合、比較方法の選択
dbKindCodeがMSSQLの場合に設定可能
dataStorageTypeCode No String HDD | SSD
default: SSD
データストレージタイプ
isHa No boolean default : true 高可用性(HA)区分
高可用性を選択すると、2台のサーバーが作成され、自動フェイルバックをサポート。
hostIp Conditional String 接続したいクライアントIPの入力
dbKindCodeがMYSQLの場合は必ず入力
cloudDBServerName Conditional String MYSQL 最小文字数: 3、最大文字数: 25
REDIS 最小文字数: 3、最大文字数: 15
Cloud DBサーバ名
Cloud DB サーバーの名前を入力
重複を使用できず、サーバー名に 3 桁の数字が自動的に採番されて生成される
dbKindCode が MSSQL の場合、入力不可
cloudDBServiceName Yes String MYSQL 最小文字数: 3、最大文字数: 30
MSSQL、REDIS 最小文字数: 3、最大文字数: 15
Cloud DBサービス名
Cloud DBで使おうとするサービス名を入力します。
cloudDBBasicName Conditional String 最小文字数: 1、最大文字数: 30 Cloud DBのデフォルト名
デフォルトで作成するDB名を入力
dbKindCodeがMYSQLの場合は必ず入力
cloudDBUserName Conditional String 英語、数字、「_」文字のみを許可、
必ず英語で始める
最小文字数: 4、最大文字数: 16
アクセスユーザー名
dbKindCodeがMYSQL、MSSQLの場合は必ず入力
cloudDBUserPassword Conditional String 最小文字数: 8、最大文字数: 20 アクセスパスワード
dbKindCodeがMYSQL、MSSQLの場合は必ず入力
cloudDBPort No integer MYSQL default: 3306,
MSSQL default: 1433,
REDIS default: 6379
デフォルト値 or 10000~20000
Cloud DBポート
アクセス用のTCPポート番号の入力
cloudDBConfigGroupoNo No String default : 0 (mssql_2016_default) Config Group番号
getCloudDBConfigGroupList APIを利用して照会可能であり
dbKindCodeがMSSQLの場合に設定可能
isBackup No bool default : true バックアップ区分
dbKindCodeがMYSQL、REDISの場合に設定可能
高可用性(isHa)がtrueの場合はtrueに固定されています
backupFileRetentionPeriod No integer default : 1日 (1~30まで入力可能) バックアップファイル保管期間
バックアップファイルを保管する期間を入力します。
isAutomaticBackup No bool default : true 自動バックアップ区分
自動でバックアップ時間を設定するかを選択します。
backupTime Conditional String HHMMフォーマット。 15分単位のみ入力可能 バックアップ時間
バックアップ開始時刻の入力
isAutomaticBackupがfalseの場合は必ず入力
regionNo No String リージョン番号
getRegionList APIを通じて必要な入力値を照会できます。
zoneNo Yes String Zone番号
getZoneList APIを通じて必要な入力値を照会できます。
responseFormatType No String XML | JSON
default: XML
応答結果のフォーマットタイプ

レスポンス

フィールド名 タイプ 説明 備考
returnCode Integer レスポンスコード値
returnMessage String レスポンスメッセージ
totalRows Integer レスポンス結果rowの数
cloudDBInstanceList[] String 作成されたcloud DB Instance情報

例示

リクエスト例示

curl 
-X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/createCloudDBInstance?dbKindCode=MYSQL&dataStorageTypeCode=SSD&isHa=true&hostIp=%25&cloudDBServerName=test&cloudDBServiceName=test&cloudDBUserName=test&cloudDBUserPassword=test123&cloudDBBasicName=test&cloudDBPort=3306&isBackup=true&backupFileRetentionPeriod=1&isAutomaticBackup=true&regionNo=9&zoneNo=90&responseFormatType=json" 
-H "accept: application/json" 
-H "Content-Type: application/x-www-form-urlencoded" 
-H "x-ncp-iam-access-key: Y0Z9EG0lKoeWAQCSHRtM" 
-H "x-ncp-apigw-timestamp: 1545634234391" 
-H "x-ncp-apigw-signature-v2: B7hM8hQ9DtitHxPFwimCG2Dir7MPLjRRVOkRRaxhYaE=" 

https://ncloud.apigw.ntruss.com/clouddb/v2/createCloudDBInstance?dbKindCode=MYSQL&dataStorageTypeCode=SSD&isHa=true&hostIp=%25&cloudDBServerName=test&cloudDBServiceName=test&cloudDBUserName=test&cloudDBUserPassword=test123&cloudDBBasicName=test&cloudDBPort=3306&isBackup=true&backupFileRetentionPeriod=1&isAutomaticBackup=true&regionNo=9&zoneNo=90&responseFormatType=json 

リクエストサンプル

  • MySQLサーバ作成
    • サーバスペック : default最小仕様 (2vCPU、4G mem)
    • データストレージ : SSD
    • 高可用性(HA) : true
    • DB名 : testdb
    • User名 : testuser
    • アクセスウェブサーバIP : 1.1.1.1
    • region : KR-1
{
  "dbKindCode": "MYSQL",            
  "dataStorageTypeCode": "SSD",
  "isHa": true,
  "hostIp": "1.1.1.1",
  "cloudDBServerName": "test",
  "cloudDBServiceName": "test",
  "cloudDBUserName": "testuser",
  "cloudDBUserPassword": "test123",
  "cloudDBBasicName": "testdb",
  "cloudDBPort": 3306,
  "isBackup": true,
  "backupFileRetentionPeriod": 1,
  "isAutomaticBackup": true,
  "regionNo": "1",
  "zoneNo": "2",
  "responseFormatType": "json"
}

レスポンス例示

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 
{
  "createCloudDBInstanceResponse": {
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "cloudDBInstanceList": [
      {
        "cloudDBInstanceNo": "881713",
        "cloudDBServiceName": "test",
        "dbKindCode": "MYSQL",
        "engineVersion": "MYSQL5.7.19",
        "cpuCount": 2,
        "dataStorageType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "licenseCode": "GPL",
        "cloudDBPort": 3306,
        "isHa": true,
        "cloudDBInstanceStatusName": "creating",
        "collation": "",
        "createDate": "2018-12-24T17:59:00+0900",
        "cloudDBImageProductCode": "SPSWMYSQLLINUX01",
        "cloudDBProductCode": "SPSVRDBAAS000001",
        "isCloudDBConfigNeedReboot": false,
        "isCloudDBNeedReboot": false,
        "cloudDBConfigList": [],
        "cloudDBConfigGroupList": [],
        "accessControlGroupList": [],
        "cloudDBServerInstanceList": [
          {
            "cloudDBServerInstanceNo": "",
            "cloudDBServerInstanceStatusName": "pending",
            "cloudDBServerName": "test-001",
            "cloudDBServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "privateDnsName": "",
            "publicDnsName": "",
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 0,
            "createDate": "2018-12-24T17:59:00+0900"
          },
          {
            "cloudDBServerName": "test-002",
            "cloudDBServerRole": {
              "code": "H",
              "codeName": "Hidden Master"
            }
          }
        ]
      }
    ]
  }
}

エラーコード

Cloud DB APIのリクエストが間違っているか、処理中にエラーが発生する場合、HTTPステータスコードで成功/失敗を返却し、JSONの形式で詳細メッセージを返却します。

エラーコードはCloud DB APIの「共通エラーコード」と「API Gatewayエラーコード」の二つです。

エラーコード レスポンスメッセージ 説明
200 Ok
500 Server Error