getCloudMssqlInstanceList
- Print
- PDF
getCloudMssqlInstanceList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Available in VPC
Views Cloud DB for MSSQL instance list.
Requests
Request 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.1=1234&cloudMssqlInstanceNoList.2=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.1=1234&cloudMssqlServerInstanceNoList.2=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 query 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 |
responseFormatType | String | N | Format type of the response result - options: xml | json - default: xml | - |
Responses
Response bodies
For response bodies, refer to CloudMssqlInstanceList.
Examples
Request Examples
The following is an example of a request body.
GET {API_URL}/getCloudMssqlInstanceList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=***83
&subnetNo=**91
&cloudMssqlServiceName=test-****
&cloudMssqlInstanceNoList.1=****890
&cloudMssqlServerName=test--****
&cloudMssqlServerInstanceNoList.1=****891
&pageNo=0
&pageSize=10
Response examples
The following are examples of responses.
If the response shows that format type (responseFormatType) is json
{
"getCloudMssqlInstanceListResponse": {
"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
<getCloudMssqlInstanceListResponse>
<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/>
</getCloudMssqlInstanceListResponse>
Was this article helpful?