getCloudMssqlInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Get the list of Cloud DB for MSSQL instances.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET, POST	/getCloudMssqlInstanceList

Request headers

For headers common to all Cloud DB for MSSQL (VPC) APIs, see Cloud DB for MSSQL (VPC) headers.

Request parameter

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code of the Cloud DB for MSSQL instance to view Check through getRegionList First Region of the `getRegionList` query result (default)
`zoneCode`	String	Optional	Filter by zone code Check through getZoneList
`vpcNo`	String	Optional	Filter by VPC number Check through getCloudMssqlTargetVpcList
`subnetNo`	String	Optional	Filter by subnet number Check through getCloudMssqlTargetSubnetList
`cloudMssqlServiceName`	String	Optional	Filter by Cloud DB for MSSQL service name Check through getCloudMssqlInstanceList
`cloudMssqlInstanceNoList.N`	List<String>	Optional	Filter by Cloud DB for MSSQL instance number Check through getCloudMssqlInstanceList <E.g.> `cloudMssqlInstanceNoList.1=1234&cloudMssqlInstanceNoList.2=2345`
`cloudMssqlServerName`	String	Optional	Filter by Cloud DB for MSSQL server name Check through getCloudMssqlInstanceList
`cloudMssqlServerInstanceNoList.N`	List<String>	Optional	Filter by Cloud DB for MSSQL server instance number Check through getCloudMssqlInstanceList <E.g.> `cloudMssqlServerInstanceNoList.1=1234&cloudMssqlServerInstanceNoList.2=2345`
`pageNo`	Integer	Optional	Page numbers in paged results Page the result values using `pageNo` and `pageSize` 0 (minimum)
`pageSize`	Integer	Conditional	Number of results to display on a page Page the result values using `pageNo` and `pageSize` Required when entering `pageNo` 1 - 1000
`responseFormatType`	String	Optional	Format of the response result `xml` (default) \| `json`

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlInstanceList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=59***
&subnetNo=140***
&cloudMssqlServiceName=mssql004
&cloudMssqlServerName=m-2522****-002
&pageNo=0
&pageSize=1
&responseFormatType=json'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

See CloudMssqlInstanceList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

If responseFormetType=json

{
    "getCloudMssqlInstanceListResponse": {
        "totalRows": 1,
        "cloudMssqlInstanceList": [
            {
                "cloudMssqlInstanceNo": "2522****",
                "cloudMssqlServiceName": "mssql004",
                "cloudMssqlInstanceStatusName": "running",
                "cloudMssqlInstanceStatus": {
                    "code": "CREAT",
                    "codeName": "CLOUD DATABASE(VPC) Created State"
                },
                "cloudMssqlInstanceOperation": {
                    "code": "NULL",
                    "codeName": "CLOUD DATABASE(VPC) Null OP"
                },
                "cloudMssqlServerInstanceList": [
                    {
                        "cloudMssqlServerInstanceNo": "2528****",
                        "cloudMssqlServerName": "m-2522****-001",
                        "cloudMssqlServerInstanceStatusName": "running",
                        "cloudMssqlServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudMssqlServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                        },
                        "vpcNo": "59***",
                        "subnetNo": "140***",
                        "dataStorageSize": 107374182400,
                        "cpuCount": 2,
                        "memorySize": 4294967296
                    },
                    {
                        "cloudMssqlServerInstanceNo": "2528****",
                        "cloudMssqlServerName": "m-2522****-002",
                        "cloudMssqlServerInstanceStatusName": "running",
                        "cloudMssqlServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudMssqlServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                        },
                        "vpcNo": "59***",
                        "subnetNo": "140***",
                        "dataStorageSize": 107374182400,
                        "cpuCount": 2,
                        "memorySize": 4294967296
                    },
                    {
                        "cloudMssqlServerInstanceNo": "2529****",
                        "cloudMssqlServerName": "m-2522****-003",
                        "cloudMssqlServerInstanceStatusName": "running",
                        "cloudMssqlServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudMssqlServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                        },
                        "vpcNo": "59***",
                        "subnetNo": "140***",
                        "dataStorageSize": 107374182400,
                        "cpuCount": 2,
                        "memorySize": 4294967296
                    }
                ]
            }
        ],
        "requestId": "cf2c1ae7-****-****-****-bcea41e82443",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

If responseFormetType=xml (default)

<?xml version="1.0" encoding="UTF-8"?>
<getCloudMssqlInstanceListResponse>
    <requestId>cf2c1ae7-****-****-****-bcea41e82443</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlInstanceList>
        <cloudMssqlInstance>
            <cloudMssqlInstanceNo>2522****</cloudMssqlInstanceNo>
            <cloudMssqlServiceName>mssql004</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>2528****</cloudMssqlServerInstanceNo>
                    <cloudMssqlServerName>m-2522****-001</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>59***</vpcNo>
                    <subnetNo>140***</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                </cloudMssqlServerInstance>
                <cloudMssqlServerInstance>
                    <cloudMssqlServerInstanceNo>2528****</cloudMssqlServerInstanceNo>
                    <cloudMssqlServerName>m-2522****-002</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>59***</vpcNo>
                    <subnetNo>140***</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                </cloudMssqlServerInstance>
                <cloudMssqlServerInstance>
                    <cloudMssqlServerInstanceNo>2529****</cloudMssqlServerInstanceNo>
                    <cloudMssqlServerName>m-2522****-003</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>59***</vpcNo>
                    <subnetNo>140***</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                </cloudMssqlServerInstance>
            </cloudMssqlServerInstanceList>
        </cloudMssqlInstance>
    </cloudMssqlInstanceList>
</getCloudMssqlInstanceListResponse>

Was this article helpful?

What's Next

getCloudMssqlProductList

Table of contents

Request
Response