createCloudDBInstance
    • PDF

    createCloudDBInstance

    • PDF

    記事の要約

    概要

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

    リクエスト

    リクエストヘッダ

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

    リクエストボディ

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

    フィールド名必須タイプ制約事項説明
    cloudDBImageProductCodeNoStringCloud DBイメージ商品コード
    getCloudDBImageProductList APIを通じて必要な入力値を照会できます。
    cloudDBProductCodeNoStringdefault : 最小仕様で選択Cloud DB商品スペックコード
    getCloudDBProductList APIを通じて必要な入力値を照会できます。
    dbKindCodeYesStringMYSQL | MSSQL | REDISDBタイプコード
    作成するCloud DBタイプの選択
    collationNoStringKorean_Wansung_CI_AS | SQL_Latin1_General_CP1_CI_AS文字セット
    文字照合、比較方法の選択
    dbKindCodeがMSSQLの場合に設定可能
    dataStorageTypeCodeNoStringHDD | SSD
    default: SSD
    データストレージタイプ
    isHaNobooleandefault : true高可用性(HA)区分
    高可用性を選択すると、2台のサーバーが作成され、自動フェイルバックをサポート。
    hostIpConditionalString接続したいクライアントIPの入力
    dbKindCodeがMYSQLの場合は必ず入力
    cloudDBServerNameConditionalStringMYSQL 最小文字数: 3、最大文字数: 25
    REDIS 最小文字数: 3、最大文字数: 15
    Cloud DBサーバ名
    Cloud DB サーバーの名前を入力
    重複を使用できず、サーバー名に 3 桁の数字が自動的に採番されて生成される
    dbKindCode が MSSQL の場合、入力不可
    cloudDBServiceNameYesStringMYSQL 最小文字数: 3、最大文字数: 30
    MSSQL、REDIS 最小文字数: 3、最大文字数: 15
    Cloud DBサービス名
    Cloud DBで使おうとするサービス名を入力します。
    cloudDBBasicNameConditionalString最小文字数: 1、最大文字数: 30Cloud DBのデフォルト名
    デフォルトで作成するDB名を入力
    dbKindCodeがMYSQLの場合は必ず入力
    cloudDBUserNameConditionalString英語、数字、「_」文字のみを許可、
    必ず英語で始める
    最小文字数: 4、最大文字数: 16
    アクセスユーザー名
    dbKindCodeがMYSQL、MSSQLの場合は必ず入力
    cloudDBUserPasswordConditionalString最小文字数: 8、最大文字数: 20アクセスパスワード
    dbKindCodeがMYSQL、MSSQLの場合は必ず入力
    cloudDBPortNointegerMYSQL default: 3306,
    MSSQL default: 1433,
    REDIS default: 6379
    デフォルト値 or 10000~20000
    Cloud DBポート
    アクセス用のTCPポート番号の入力
    cloudDBConfigGroupoNoNoStringdefault : 0 (mssql_2016_default)Config Group番号
    getCloudDBConfigGroupList APIを利用して照会可能であり
    dbKindCodeがMSSQLの場合に設定可能
    isBackupNobooldefault : trueバックアップ区分
    dbKindCodeがMYSQL、REDISの場合に設定可能
    高可用性(isHa)がtrueの場合はtrueに固定されています
    backupFileRetentionPeriodNointegerdefault : 1日 (1~30まで入力可能)バックアップファイル保管期間
    バックアップファイルを保管する期間を入力します。
    isAutomaticBackupNobooldefault : true自動バックアップ区分
    自動でバックアップ時間を設定するかを選択します。
    backupTimeConditionalStringHHMMフォーマット。 15分単位のみ入力可能バックアップ時間
    バックアップ開始時刻の入力
    isAutomaticBackupがfalseの場合は必ず入力
    regionNoNoStringリージョン番号
    getRegionList APIを通じて必要な入力値を照会できます。
    zoneNoYesStringZone番号
    getZoneList APIを通じて必要な入力値を照会できます。
    responseFormatTypeNoStringXML | JSON
    default: XML
    応答結果のフォーマットタイプ

    レスポンス

    フィールド名タイプ説明備考
    returnCodeIntegerレスポンスコード値
    returnMessageStringレスポンスメッセージ
    totalRowsIntegerレスポンス結果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エラーコード」の二つです。

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

    この記事は役に立ちましたか?

    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.