getCloudMssqlInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Views Cloud DB for MSSQL instance list.

Commands

The text of the command is as follows:

ncloud vmssql getCloudMssqlInstanceList [cloudMssqlInstanceNoList] [cloudMssqlServiceName] [cloudMssqlServerInstanceNoList] [cloudMssqlServerName] [regionCode] [zoneCode] [vpcNo] [subnetNo] [pageNo] [pageSize] [output]

Parameter

The following is a description on parameters.

Parameter	Type	Requirement status	Description	Restrictions
cloudMssqlInstanceNoList	List<String>	N	Cloud DB for MSSQL instance number list - Can be searched through filtering by Cloud DB for MSSQL instance number - cloudMssqlInstanceNoList can be obtained via the getCloudMssqlInstanceList action - ex) cloudMssqlInstanceNoList 1234 2345	-
cloudMssqlServiceName	String	N	Cloud DB for MSSQL service name - Can be searched through filtering by Cloud DB for MSSQL service name - cloudMssqlServiceName can be obtained via the getCloudMssqlInstanceList action	-
cloudMssqlServerInstanceNoList	List<String>	N	Cloud DB for MSSQL server instance number list - Can be searched through filtering by Cloud DB for MSSQL server instance number - cloudMssqlServerInstanceNoList can be obtained via the getCloudMssqlInstanceList action - ex) cloudMssqlServerInstanceNoList 1234 2345	-
cloudMssqlServerName	String	N	Cloud DB for MSSQL server name - Can be searched through filtering by Cloud DB for MSSQL server name - cloudMssqlServerName can be obtained via the getCloudMssqlInstanceList action	-
regionCode	String	N	Region code - regionCode can be obtained via the getRegionList action - Default: selects the first region of the getRegionList search results	-
zoneCode	String	N	Zone code - zoneCode can be obtained via the getZoneList action	-
vpcNo	String	N	VPC number - vpcNo can be obtained via the getCloudMssqlTargetVpcList action	-
subnetNo	String	N	Subnet number - SubnetNo can be obtained via the getCloudMssqlTargetSubnetList action	-
pageNo	Integer	N	Page number of paged results - The results can be paged using pageNo and pageSize	- Min: 0
pageSize	Integer	N	Size of each page to be shown during paging - The results can be paged using pageNo and pageSize - Must be entered when entering pageNo	- Min: 1
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)` - `FW (Failover waiting)`
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

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 getCloudMssqlInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ***83 --subnetNo **91 --cloudMssqlServiceName test-**** --cloudMssqlInstanceNoList ****890 --cloudMssqlServerName test--**** --cloudMssqlServerInstanceNoList ****891 --pageNo 0 --pageSize 10

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.

{
  "getCloudMssqlInstanceListResponse": {
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "*****90",
        "cloudMssqlServiceName": "******",
        "cloudMssqlInstanceStatusName": "running",
        "cloudMssqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "cloudMssqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerInstanceNo": "******91",
            "cloudMssqlServerName": "*******001",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "vpcNo": "*****",
            "subnetNo": "*****",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 8589934592
          },
          {
            "cloudMssqlServerInstanceNo": "********",
            "cloudMssqlServerName": "*********002",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "vpcNo": "*****",
            "subnetNo": "*****",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 8589934592
          }
        ]
      }
    ],
    "requestId": "*********************************",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

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

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

<getCloudMssqlInstanceListResponse>
    <requestId>*********************************</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlInstanceList>
      <cloudMssqlInstance>
        <cloudMssqlInstanceNo>*******</cloudMssqlInstanceNo>
        <cloudMssqlServiceName>*******</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>
        <cloudMssqlServerInstanceList>
          <cloudMssqlServerInstance>
            <cloudMssqlServerInstanceNo>*******</cloudMssqlServerInstanceNo>
            <cloudMssqlServerName>*******</cloudMssqlServerName>
            <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>
            <vpcNo>*****</vpcNo>
            <subnetNo>*****</subnetNo>
            <dataStorageSize>107374182400</dataStorageSize>
            <cpuCount>2</cpuCount>
            <memorySize>8589934592</memorySize>
          </cloudMssqlServerInstance>
          <cloudMssqlServerInstance>
            <cloudMssqlServerInstanceNo>********</cloudMssqlServerInstanceNo>
            <cloudMssqlServerName>********</cloudMssqlServerName>
            <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>
            <vpcNo>*****</vpcNo>
            <subnetNo>******</subnetNo>
            <dataStorageSize>107374182400</dataStorageSize>
            <cpuCount>2</cpuCount>
            <memorySize>8589934592</memorySize>
          </cloudMssqlServerInstance>
        </cloudMssqlServerInstanceList>
      </cloudMssqlInstance>
    </cloudMssqlInstanceList>
</getCloudMssqlInstanceListResponse>

Was this article helpful?

What's Next

getCloudMssqlProductList

Table of contents

Commands
Responses
Examples