Cloud DB for MSSQL

Available in Classic

Get the list of Cloud DB for MSSQL server instances (VMs) in the Classic environment.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/api/{regionCode}-v1/classic/servers/mssql

Request headers

For information about the headers common to all Cloud Log Analytics APIs, see Cloud Log Analytics request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`regionCode`	String	Required	Region code `kr` \| `sgn` \| `jpn` \| `uswn` \| `den` `kr`: Korea Region `sgn`: Singapore Region `jpn`: Japan Region `uswn`: US West Region `den`: Germany Region

Request query parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`pageNo`	Integer	Optional	Page number 1-100 (default: 1)
`pageSize`	Integer	Optional	Number of items per page 20-100 (default: 20)

Request example

The request example is as follows:

curl --location --request GET 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/classic/servers/mssql' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`code`	Integer	-	Response status codes
`message`	String	-	Response status message
`result`	Object	-	Response result
`result.pageSize`	Integer	-	Number of items per page
`result.currentPage`	Integer	-	Current page number
`result.totalPage`	Integer	-	Total number of pages
`result.totalCount`	Integer	-	Total item count
`result.isPaged`	Boolean	-	Whether to page `true` \| `false` `true`: paged `false`: not paged
`result.dbServers`	Array	-	Server list Server information

Note

For more information about the fields related to server information (dbServers), see the Cloud DB for MSSQL API Guide and Cloud DB for MSSQL User Guide.

Response status codes

For information about the HTTP status codes common to all Cloud Log Analytics APIs, see Cloud Log Analytics response status codes.

Response example

The response example is as follows:

{
  "code": 0,
  "message": "The request has been successfully processed",
  "result": {
    "pageSize": 10,
    "currentPage": 1,
    "totalPage": 1,
    "totalCount": 2,
    "isPaged": true,
    "dbServers": [
      {
        "standbyMasterServerName": null,
        "dbServerName": "cla-test-001-1shh",
        "databaseProductCode": null,
        "db_svr_rank": 0,
        "cloudDbServiceName": "clatest",
        "dataStorageTypeCode": null,
        "dataStorageSize": 10,
        "dataStorageSizeStr": "10GB",
        "dbInstanceNo": 0,
        "memorySize": "8GB",
        "dbStatusName": null,
        "clusterStatusName": null,
        "serverInstanceNo": 0,
        "dbServerIpAddress": null,
        "cpuCount": 2,
        "roleCode": null,
        "dbServerRoleCode": null,
        "dbServerType": "[Standard] 2vCPU, 8GB Mem",
        "usedDataStorageSize": 0,
        "uuid": "*-***-****-***-****",
        "dbStatusNameValue": "creating",
        "dbStatusNameColor": "yellow",
        "dbServerRoleValue": "Master",
        "zoneNo": null,
        "zoneName": null
      },
      {
        "standbyMasterServerName": null,
        "dbServerName": "cla-test-002-1shi",
        "databaseProductCode": null,
        "db_svr_rank": 0,
        "cloudDbServiceName": "clatest",
        "dataStorageTypeCode": null,
        "dataStorageSize": 10,
        "dataStorageSizeStr": "10GB",
        "dbInstanceNo": 0,
        "memorySize": "8GB",
        "dbStatusName": null,
        "clusterStatusName": null,
        "serverInstanceNo": 0,
        "dbServerIpAddress": null,
        "cpuCount": 2,
        "roleCode": null,
        "dbServerRoleCode": null,
        "dbServerType": "[Standard] 2vCPU, 8GB Mem",
        "usedDataStorageSize": 0,
        "uuid": "*-***-****-***-****",
        "dbStatusNameValue": "creating",
        "dbStatusNameColor": "yellow",
        "dbServerRoleValue": "Standby Master",
        "zoneNo": null,
        "zoneName": null
      }
    ]
  }
}