deleteCloudDBServerInstance

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リクエスト時にフィールド名の大文字・小文字の区別が必要です

パラメータ名 要否 タイプ 制約事項 説明
cloudDBServerInstanceNo Y String CloudDBサーバインスタンス番号やマスターサーバインスタンス番号の入力時にはクラスタ全体が、その他サーバインスタンス番号の入力時には当該サーバのみが削除されます。
responseFormatType N String responseの結果 format設定
  • cloudDBServerInstanceNo

    • 削除する CloudDBのインスタンス番号です。この番号は MCコンソールでは知ることができず、getCloudDBInstanceList APIを実行して response結果から削除する CloudDBのサーバインスタンス番号を探す必要があります。
  • responseFormatType

    • API実行結果のレスポンスを受ける formatを決めます。 xmlと jsonのうち選択できます。

レスポンス

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

リクエスト例

curl -X POST "https://ncloud.apigw.ntruss.com/clouddb/v2/deleteCloudDBServerInstance"
-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: 1545985588464"
-H "x-ncp-apigw-signature-v2: 8AjXzJBJ/7AZ+u2Er007Pvq2cr6Md/ySH3YrDvd9dHY="
-d "cloudDBServerInstanceNo=882618&responseFormatType=json"

https://ncloud.apigw.ntruss.com/clouddb/v2/deleteCloudDBServerInstance

リクエストサンプル

  • MySQLサーバ削除
{
  "cloudDBServerInstanceNo": "882618",
  "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


{
  "deleteCloudDBServerInstanceResponse": {
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "cloudDBInstanceList": [
      {
        "cloudDBInstanceNo": "882617",
        "cloudDBServiceName": "test",
        "dbKindCode": "MYSQL",
        "engineVersion": "MYSQL5.7.19",
        "cpuCount": 2,
        "memorySize": 4294967296,
        "dataStorageType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "licenseCode": "GPL",
        "cloudDBPort": 3306,
        "isHa": true,
        "cloudDBInstanceStatusName": "deleting",
        "collation": "",
        "createDate": "2018-12-28T14:37:00+0900",
        "cloudDBImageProductCode": "SPSWMYSQLLINUX01",
        "cloudDBProductCode": "SPSVRDBAAS000001",
        "isCloudDBConfigNeedReboot": false,
        "isCloudDBNeedReboot": false,
        "zone": {
          "zoneNo": "2",
          "zoneName": "KR-1",
          "zoneCode": "KR-1",
          "zoneDescription": "가산 zone",
          "regionNo": "1"
        },
        "region": {
          "regionNo": "1",
          "regionCode": "KR",
          "regionName": "Korea"
        },
        "cloudDBConfigList": [],
        "cloudDBConfigGroupList": [],
        "accessControlGroupList": [
          {
            "accessControlGroupConfigurationNo": "23949",
            "accessControlGroupName": "cloud-db-ix15",
            "accessControlGroupDescription": "Group for cloud DB service 'test' (automatically created)",
            "isDefault": false,
            "createDate": "2018-12-28T14:37:29+0900"
          }
        ],
        "cloudDBServerInstanceList": [
          {
            "cloudDBServerInstanceNo": "882618",
            "cloudDBServerInstanceStatusName": "deleting",
            "cloudDBServerName": "test-001",
            "cloudDBServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "privateDnsName": "db-qttq.beta-cdb.ntruss.com",
            "publicDnsName": "",
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 0,
            "createDate": "2018-12-28T14:37:00+0900",
            "uptime": "2018-12-28T17:21:00+0900"
          },
          {
            "cloudDBServerName": "test-002",
            "cloudDBServerRole": {
              "code": "H",
              "codeName": "Hidden Master"
            }
          }
        ]
      }
    ]
  }
}

エラーコード

Cloud DB APIリクエストに誤りがあるか、処理中にエラーが発生した場合、HTTPステータスコードで成功/失敗を、JSON形式で詳細メッセージを返します

エラーコードには、Cloud DB APIの「共通エラーコード」と「API Gatewayエラーコード」の2種類があります

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