deleteCloudMssqlInstance

Prev Next

VPC環境で利用できます。

Cloud DB for MSSQLのインスタンスを削除します。

コマンド

コマンド構文は、次のとおりです。

ncloud vmssql deleteCloudMssqlInstance [regionCode] [cloudMssqlInstanceNo] [output]

パラメータ

パラメータについての説明は、次のとおりです。

パラメータ タイプ 要否 説明 制約事項
regionCode String N リージョンコード
- regionCodeは、getRegionListアクションを通じて取得
- default: getRegionList照会結果の最初のリージョンを選択
-
cloudMssqlInstanceNo String Y 削除する Cloud DB for MSSQLインスタンス番号
- Slaveサーバがある場合は削除不可
- cloudMssqlInstanceNoは、getCloudMssqlInstanceListアクションを通じて取得
-
output String N レスポンス結果のフォーマットタイプ
- options: xml | json
- default: json
-

レスポンス

レスポンスデータのタイプ

  • CloudMssqlInstanceListタイプ

    CloudMssqlInstanceList extends CommonResponse 説明
    private Integer totalRows; 照会されたリストの総数
    private List<CloudMssqlInstance> cloudMssqlInstanceList = new ArrayList<>(); Cloud DB for MSSQLインスタンスリスト
  • CloudMssqlInstanceタイプ

    CloudMssqlInstance 説明
    private String cloudMssqlInstanceNo; Cloud DB for MSSQLインスタンス番号
    private String cloudMssqlServiceName; Cloud DB for MSSQLサービス名
    private String cloudMssqlInstanceStatusName; Cloud DB for MSSQLインスタンスステータス名
    - creating
    - deleted
    - deleting
    - downgrading
    - pending
    - recovering
    - reinstalling
    - restarting
    - running
    - settingup
    - shuttingdown
    - stopped
    - upgrading
    private CommonCode cloudMssqlInstanceStatus; Cloud DB for MSSQLインスタンスステータスコード
    - INIT (initiate)
    - CREAT (created)
    - DEL (deleted)
    private CommonCode cloudMssqlInstanceOperation; Cloud DB for MSSQLインスタンス Operationコード
    - CREAT (create)
    - DEL (delete)
    - FO (failover)
    - NULL (no operation)
    - SETUP (setup)
    - UPGD (upgrade)
    - DWGD (downgrade)
    - BKP (backup)
    private String cloudMssqlImageProductCode; Cloud DB for MSSQLイメージ商品コード
    private Boolean isHa; 高可用性の有無
    private Boolean isMultiZone; マルチゾーンの有無
    private CommonCode license; Cloud DB for MSSQLライセンス
    private Integer cloudMssqlPort; Cloud DB for MSSQLポート
    private Integer backupFileRetentionPeriod; バックアップファイルの保存期間
    private String backupTime; バックアップ時間
    private String configGroupNo; Cloud DB for MSSQL Config Group番号
    private String configGroupName; Cloud DB for MSSQL Config Group名
    private String engineVersion; Cloud DB for MSSQLエンジンバージョン
    private Date createDate; 作成日
    private String dbCollation; Cloud DB for MSSQLキャラクターセット
    private List<CloudMssqlServerInstance> cloudMssqlServerInstanceList; Cloud DB for MSSQLサーバインスタンスリスト
    private AccessControlGroupNoList accessControlGroupNoList; ACG番号リスト
  • CloudMssqlServerInstanceタイプ

    CloudMssqlServerInstance 説明
    private String cloudMssqlServerInstanceNo; Cloud DB for MSSQLサーバインスタンス番号
    private String cloudMssqlServerName; Cloud DB for MSSQLサーバ名
    private CommonCode cloudMssqlServerRole; Cloud DB for MSSQLサーバーの役割
    private String cloudMssqlServerInstanceStatusName; Cloud DB for MSSQLサーバインスタンスステータス名
    - creating
    - deleted
    - deleting
    - downgrading
    - pending
    - recovering
    - reinstalling
    - restarting
    - running
    - settingup
    - shuttingdown
    - stopped
    - upgrading
    - downgrading
    private CommonCode cloudMssqlServerInstanceStatus; Cloud DB for MSSQLサーバインスタンスステータスコード
    - DEL (deleted)
    - PEND (pending)
    - RUN (running)
    - STOP (stopped)
    - FSTOP (failure stopped)
    private CommonCode cloudMssqlServerInstanceOperation; Cloud DB for MSSQLサーバインスタンス Operationコード
    - NOOP (no operation)
    - CREAT (create)
    - START (start)
    - RSTRT (restart)
    - SETUP (setup)
    - STOP (stop)
    - FO (failover)
    - DEL (delete)
    - UPGD (upgrade)
    - DWGD (downgrade)
    - RISTL (reinstall)
    private String regionCode; リージョンコード
    private String zoneCode; Zoneコード
    private String vpcNo; VPC番号
    private String subnetNo; Subnet番号
    private Long dataStorageSize; データストレージサイズ
    private Integer cpuCount; CPU数
    private Long memorySize; メモリサイズ
    private Boolean isPublicSubnet; Public Subnetの有無
    private String cloudMssqlProductCode; Cloud DB for MSSQL商品コード
    private String privateDomain; プライベートドメイン名
    private String publicDomain; グローバルドメイン名
    private Date createDate; 作成日
    private Date uptime; VM起動完了時間
    private CommonCode dataStorageType; データストレージタイプ
    private Long usedDataStorageSize; 使用中のデータストレージサイズ
  • AccessControlGroupNoListタイプ

    AccessControlGroupNoList 説明
    private List<String> accessControlGroupNoList = new ArrayList<>(); ACG番号リスト

呼び出しとレスポンス例を説明します。

呼び出し例

呼び出し例は、次のとおりです。

ncloud vmssql deleteCloudMssqlInstance --regionCode KR --cloudMssqlInstanceNo ****890

レスポンス例

レスポンス例は、次のとおりです。

レスポンス結果フォーマットタイプ(output)が jsonの場合

レスポンス結果フォーマットタイプ(output)が jsonの場合は、次のとおりです。

{
  "deleteCloudMssqlInstanceResponse": {
    "requestId": "858c2941-2402-4686-9f4d-36a7a906a39d",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "****890",
        "cloudMssqlServiceName": "test-****",
        "cloudMssqlInstanceStatusName": "deleted",
        "cloudMssqlInstanceStatus": {
          "code": "DEL",
          "codeName": "CLOUD DATABASE(VPC) Deleted State"
        },
        "cloudMssqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudMssqlImageProductCode": "SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100",
        "isHa": true,
        "isMultiZone": false,
        "license": {
          "code": "SPLA",
          "codeName": "Service Provider License Agreement"
        },
        "cloudMssqlPort": 1433,
        "backupFileRetentionPeriod": 3,
        "backupTime": "17:00",
        "configGroupNo": 0,
        "configGroupName": "test-****-config",
        "engineVersion": "MSSQL 15.0.2000.5 Standard Edition",
        "createDate": "2021-04-30T14:03:20+0900",
        "dbCollation": "Korean_Wansung_CI_AS",
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerInstanceNo": "****891",
            "cloudMssqlServerName": "m-****890-001",
            "cloudMssqlServerRole": {
              "code": "M",
              "codeName": "Principal"
            },
            "cloudMssqlServerInstanceStatusName": "deleted",
            "cloudMssqlServerInstanceStatus": {
              "code": "DEL",
              "codeName": "CLOUD DATABASE(VPC) Server Deleted State"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "****83",
            "subnetNo": "****91",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 8589934592,
            "isPublicSubnet": true,
            "cloudMssqlProductCode": "SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002",
            "privateDomain": "mssql-***.beta-vpc-cdb.ntruss.com",
            "createDate": "2021-04-30T14:03:20+0900",
            "uptime": "2021-04-30T14:14:39+0900",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "usedDataStorageSize": 1073741824
          },
          {
            "cloudMssqlServerInstanceNo": "****897",
            "cloudMssqlServerName": "m-****890-002",
            "cloudMssqlServerRole": {
              "code": "H",
              "codeName": "Mirror"
            },
            "cloudMssqlServerInstanceStatusName": "deleted",
            "cloudMssqlServerInstanceStatus": {
              "code": "DEL",
              "codeName": "CLOUD DATABASE(VPC) Server Deleted State"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "****83",
            "subnetNo": "****91",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 8589934592,
            "isPublicSubnet": true,
            "cloudMssqlProductCode": "SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002",
            "privateDomain": "mssql-***.beta-vpc-cdb.ntruss.com",
            "createDate": "2021-05-27T19:00:00+0900",
            "uptime": "2021-05-27T19:01:00+0900",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "usedDataStorageSize": 1073741824
          }
        ],
        "accessControlGroupNoList": [
          "****58"
        ]
      }
    ]
  }
}

レスポンス結果フォーマットタイプ(responseFormatType)が xmlの場合

レスポンス結果フォーマットタイプ(responseFormatType)が xmlの場合は、次のとおりです。

<deleteCloudMssqlInstanceResponse>
    <requestId>858c2941-2402-4686-9f4d-36a7a906a39d</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlInstanceList>
        <CloudMssqlInstance>
            <cloudMssqlInstanceNo>****890</cloudMssqlInstanceNo>
            <cloudMssqlServiceName>test-****</cloudMssqlServiceName>
            <cloudMssqlInstanceStatusName>deleted</cloudMssqlInstanceStatusName>
            <cloudMssqlInstanceStatus>
                <code>DEL</code>
                <codeName>CLOUD DATABASE(VPC) Deleted State</codeName>
            </cloudMssqlInstanceStatus>
            <cloudMssqlInstanceOperation>
                <code>NULL</code>
                <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
            </cloudMssqlInstanceOperation>
            <cloudMssqlImageProductCode>SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100</cloudMssqlImageProductCode>
            <isHa>true</isHa>
            <isMultiZone>false</isMultiZone>
            <license>
                <code>SPLA</code>
                <codeName>Service Provider License Agreement</codeName>
            </license>
            <cloudMssqlPort>1433</cloudMssqlPort>
            <backupFileRetentionPeriod>3</backupFileRetentionPeriod>
            <backupTime>17:00</backupTime>
            <configGroupNo>0</configGroupNo>
            <configGroupName>test-****-config</configGroupName>
            <engineVersion>MSSQL 15.0.2000.5 Standard Edition</engineVersion>
            <createDate>2021-04-30T14:03:20+0900</createDate>
            <dbCollation>Korean_Wansung_CI_AS</dbCollation>
            <cloudMssqlServerInstanceList>
                <cloudMssqlServerInstanceList>
                    <cloudMssqlServerInstanceNo>****891</cloudMssqlServerInstanceNo>
                    <cloudMssqlServerName>m-****890-001</cloudMssqlServerName>
                    <cloudMssqlServerRole>
                        <code>M</code>
                        <codeName>Principal</codeName>
                    </cloudMssqlServerRole>
                    <cloudMssqlServerInstanceStatusName>deleted</cloudMssqlServerInstanceStatusName>
                    <cloudMssqlServerInstanceStatus>
                        <code>DEL</code>
                        <codeName>CLOUD DATABASE(VPC) Server Deleted State</codeName>
                    </cloudMssqlServerInstanceStatus>
                    <cloudMssqlServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMssqlServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                    <isPublicSubnet>true</isPublicSubnet>
                    <cloudMssqlProductCode>SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002</cloudMssqlProductCode>
                    <privateDomain>mssql-***.beta-vpc-cdb.ntruss.com</privateDomain>
                    <createDate>2021-04-30T14:03:20+0900</createDate>
                    <uptime>2021-04-30T14:14:39+0900</uptime>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <usedDataStorageSize>1073741824</usedDataStorageSize>
                </cloudMssqlServerInstanceList>
                <cloudMssqlServerInstanceList>
                    <cloudMssqlServerInstanceNo>****897</cloudMssqlServerInstanceNo>
                    <cloudMssqlServerName>m-****890-002</cloudMssqlServerName>
                    <cloudMssqlServerRole>
                        <code>H</code>
                        <codeName>Mirror</codeName>
                    </cloudMssqlServerRole>
                    <cloudMssqlServerInstanceStatusName>deleted</cloudMssqlServerInstanceStatusName>
                    <cloudMssqlServerInstanceStatus>
                        <code>DEL</code>
                        <codeName>CLOUD DATABASE(VPC) Server Deleted State</codeName>
                    </cloudMssqlServerInstanceStatus>
                    <cloudMssqlServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMssqlServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                    <isPublicSubnet>true</isPublicSubnet>
                    <cloudMssqlProductCode>SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002</cloudMssqlProductCode>
                    <privateDomain>mssql-***.beta-vpc-cdb.ntruss.com</privateDomain>
                    <createDate>2021-05-27T19:00:00+0900</createDate>
                    <uptime>2021-05-27T19:01:00+0900</uptime>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <usedDataStorageSize>1073741824</usedDataStorageSize>
                </cloudMssqlServerInstanceList>
            </cloudMssqlServerInstanceList>
            <accessControlGroupNoList>
                <accessControlGroupNo>****58</accessControlGroupNo>
            </accessControlGroupNoList>
        </CloudMssqlInstance>
    </cloudMssqlInstanceList>
</deleteCloudMssqlInstanceResponse>