getCloudMssqlInstanceDetail

Prev Next

Available in VPC

Views Cloud DB for MSSQL instance details

Commands

The text of the command is as follows:

ncloud vmssql getCloudMssqlInstanceDetail [regionCode] [cloudMssqlInstanceNo] [output]

Parameter

The following is a description on parameters.

Parameter Type Requirement status Description Restrictions
regionCode String N Region code
- regionCode can be obtained via the getRegionList action
- Default: selects the first region of the getRegionList search results
-
cloudMssqlInstanceNo String Y Cloud DB for MSSQL instance number
- Enter Cloud DB for MSSQL instance number to be viewed for details
- cloudMssqlInstanceNo can be obtained via the getCloudMssqlInstanceList action
-
output String N Format type of the response result
- options: xml | json
- default: json
-

Responses

Response data type

  • CloudMssqlInstanceList type

    CloudMssqlInstanceList extends CommonResponse Description
    private Integer totalRows; Total number of items viewed
    private List<CloudMssqlInstance> cloudMssqlInstanceList = new ArrayList<>(); Cloud DB for MSSQL instance list
  • CloudMssqlInstance type

    CloudMssqlInstance Description
    private String cloudMssqlInstanceNo; Cloud DB for MSSQL instance number
    private String cloudMssqlServiceName; Cloud DB for MSSQL service name
    private String cloudMssqlInstanceStatusName; Cloud DB for MSSQL instance status name
    - creating
    - deleted
    - deleting
    - downgrading
    - pending
    - recovering
    - reinstalling
    - restarting
    - running
    - settingup
    - shuttingdown
    - stopped
    - upgrading
    private CommonCode cloudMssqlInstanceStatus; Cloud DB for MSSQL instance status code
    - INIT (initiate)
    - CREAT (created)
    - DEL (deleted)
    private CommonCode cloudMssqlInstanceOperation; Cloud DB for MSSQL instance operation code
    - CREAT (create)
    - DEL (delete)
    - FO (failover)
    - NULL (no operation)
    - SETUP (setup)
    - UPGD (upgrade)
    - DWGD (downgrade)
    - BKP (backup)
    private String cloudMssqlImageProductCode; Cloud DB for MSSQL image product code
    private Boolean isHa; High availability status
    private Boolean isMultiZone; Multi-zone (True/False)
    private CommonCode license; Cloud DB for MSSQL license
    private Integer cloudMssqlPort; Cloud DB for MSSQL port
    private Integer backupFileRetentionPeriod; Backup file storage period
    private String backupTime; Backup time
    private String configGroupNo; Cloud DB for MSSQL config group Number
    private String configGroupName; Cloud DB for MSSQL config group name
    private String engineVersion; Cloud DB for MSSQL engine version
    private Date createDate; Creation date
    private String dbCollation; Cloud DB for MSSQL character set
    private List<CloudMssqlServerInstance> cloudMssqlServerInstanceList; Cloud DB for MSSQL server instance list
    private AccessControlGroupNoList accessControlGroupNoList; List of ACG numbers
  • CloudMssqlServerInstance type

    CloudMssqlServerInstance Description
    private String cloudMssqlServerInstanceNo; Cloud DB for MSSQL server instance number
    private String cloudMssqlServerName; Cloud DB for MSSQL server name
    private CommonCode cloudMssqlServerRole; Cloud DB for MSSQL server role
    private String cloudMssqlServerInstanceStatusName; Cloud DB for MSSQL server instance status name
    - creating
    - deleted
    - deleting
    - downgrading
    - pending
    - recovering
    - reinstalling
    - restarting
    - running
    - settingup
    - shuttingdown
    - stopped
    - upgrading
    - downgrading
    private CommonCode cloudMssqlServerInstanceStatus; Cloud DB for MSSQL server instance status code
    - DEL (deleted)
    - PEND (pending)
    - RUN (running)
    - STOP (stopped)
    - FSTOP (failure stopped)
    private CommonCode cloudMssqlServerInstanceOperation; Cloud DB for MSSQL server instance operation code
    - 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; Region code
    private String zoneCode; Zone code
    private String vpcNo; VPC number
    private String subnetNo; Subnet number
    private Long dataStorageSize; Data storage size
    private Integer cpuCount; Number of CPUs
    private Long memorySize; Memory size
    private Boolean isPublicSubnet; Public Subnet status
    private String cloudMssqlProductCode; Cloud DB for MSSQL product code
    private String privateDomain; Name of private domain
    private String publicDomain; Name of public domain
    private Date createDate; Creation date
    private Date uptime; VM booting completion time
    private CommonCode dataStorageType; Data storage type
    private Long usedDataStorageSize; Size of data storage in use
  • AccessControlGroupNoList type

    AccessControlGroupNoList Description
    private List<String> accessControlGroupNoList = new ArrayList<>(); List of ACG numbers

Examples

Describes examples of recalls and responses.

Recall examples

The following are examples of recalls.

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

Response examples

The following are examples of responses.

If the response shows that format type (output) is json

The following is when the response shows that format type (output) is json.

{
  "getCloudMssqlInstanceDetailResponse": {
    "requestId": "c04bfdd1-e27e-4006-9bc3-bc37840ce1dd",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "****890",
        "cloudMssqlServiceName": "test-****",
        "cloudMssqlInstanceStatusName": "running",
        "cloudMssqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created 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": "GPL",
          "codeName": "General Public License"
        },
        "cloudMssqlPort": 1433,
        "backupFileRetentionPeriod": 10,
        "backupTime": "00:15",
        "configGroupNo": "**9",
        "configGroupName": "test-****-config",
        "engineVersion": "MSSQL 15.0.2000.5 Standard Edition",
        "createDate": "2021-04-12T19:30:38+0900",
        "cloudMssqlServerInstanceList": [
          {
           "cloudMssqlServerInstanceNo": "****891",
           "cloudMssqlServerName": "m-****890-001",
           "cloudMssqlServerRole": {
             "code": "M",
             "codeName": "Principal"
           },
           "cloudMssqlServerInstanceStatusName": "running",
           "cloudMssqlServerInstanceStatus": {
             "code": "RUN",
             "codeName": "CLOUD DATABASE(VPC) Server Running 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": "running",
           "cloudMssqlServerInstanceStatus": {
             "code": "RUN",
             "codeName": "CLOUD DATABASE(VPC) Server Running 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": []
  }
}

If the response shows that format type (responseFormatType) is xml

The following is when the response shows that format type (responseFormatType) is xml:

<getCloudMssqlInstanceDetailResponse>
    <requestId>c04bfdd1-e27e-4006-9bc3-bc37840ce1dd</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlInstanceList>
        <cloudMssqlInstance>
            <cloudMssqlInstanceNo>****890</cloudMssqlInstanceNo>
            <cloudMssqlServiceName>test-****</cloudMssqlServiceName>
            <cloudMssqlInstanceStatusName>running</cloudMssqlInstanceStatusName>
            <cloudMssqlInstanceStatus>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Created 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>GPL</code>
                <codeName>General Public License</codeName>
            </license>
            <cloudMssqlPort>1433</cloudMssqlPort>
            <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
            <backupTime>00:15</backupTime>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>test-****-config</configGroupName>
            <engineVersion>MSSQL 15.0.2000.5 Standard Edition</engineVersion>
            <createDate>2021-04-12T19:30:38+0900</createDate>
            <cloudMssqlServerInstanceList>
                <cloudMssqlServerInstanceList>
                    <cloudMssqlServerInstanceNo>****891</cloudMssqlServerInstanceNo>
                    <cloudMssqlServerName>m-****890-001</cloudMssqlServerName>
                    <cloudMssqlServerRole>
                        <code>M</code>
                        <codeName>Principal</codeName>
                    </cloudMssqlServerRole>
                    <cloudMssqlServerInstanceStatusName>running</cloudMssqlServerInstanceStatusName>
                    <cloudMssqlServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running 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>running</cloudMssqlServerInstanceStatusName>
                    <cloudMssqlServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running 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>
        </cloudMssqlInstance>
    </cloudMssqlInstanceList>
    <accessControlGroupNoList/>
</getCloudMssqlInstanceDetailResponse>