getCloudMssqlInstanceDetail

VPC 환경에서 이용 가능합니다.

Cloud DB for MSSQL 인스턴스의 상세 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

요청 헤더

Cloud DB for MSSQL (VPC) API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud DB for MSSQL (VPC) 요청 헤더를 참조해 주십시오.

요청 파라미터

파라미터에 대한 설명은 다음과 같습니다.

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlInstanceDetail
?regionCode=KR
&cloudMssqlInstanceNo=2522****
&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}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 CloudMssqlInstanceList를 참조해 주십시오.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

• responseFormetType=json 일 때

  {
      "getCloudMssqlInstanceDetailResponse": {
          "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"
                  },
                  "cloudMssqlImageProductCode": "SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15043553.EE.B100",
                  "isHa": true,
                  "isMultiZone": false,
                  "license": {
                      "code": "SPLA",
                      "codeName": "Service Provider License Agreement"
                  },
                  "cloudMssqlPort": 1433,
                  "backupFileRetentionPeriod": 1,
                  "backupTime": "08:00",
                  "configGroupNo": "0",
                  "configGroupName": "mssql_2019_default",
                  "engineVersion": "MSSQL 15.0.4355.3 Enterprise Edition",
                  "createDate": "2024-07-01T14:29:18+0900",
                  "dbCollation": "Korean_Wansung_CI_AS",
                  "cloudMssqlServerInstanceList": [
                      {
                          "cloudMssqlServerInstanceNo": "2528****",
                          "cloudMssqlServerName": "m-2522****-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": "59***",
                          "subnetNo": "140***",
                          "dataStorageSize": 107374182400,
                          "cpuCount": 2,
                          "memorySize": 4294967296,
                          "isPublicSubnet": true,
                          "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002",
                          "privateDomain": "mssql-****.vpc-cdb.ntruss.com",
                          "createDate": "2024-07-01T14:29:18+0900",
                          "uptime": "2024-07-01T14:55:41+0900",
                          "dataStorageType": {
                              "code": "SSD",
                              "codeName": "SSD"
                          },
                          "usedDataStorageSize": 1073741824
                      },
                      {
                          "cloudMssqlServerInstanceNo": "2528****",
                          "cloudMssqlServerName": "m-2522****-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": "59***",
                          "subnetNo": "140***",
                          "dataStorageSize": 107374182400,
                          "cpuCount": 2,
                          "memorySize": 4294967296,
                          "isPublicSubnet": true,
                          "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002",
                          "privateDomain": "mssql-****.vpc-cdb.ntruss.com",
                          "createDate": "2024-07-01T14:29:18+0900",
                          "uptime": "2024-07-01T15:08:09+0900",
                          "dataStorageType": {
                              "code": "SSD",
                              "codeName": "SSD"
                          },
                          "usedDataStorageSize": 1073741824
                      },
                      {
                          "cloudMssqlServerInstanceNo": "2529****",
                          "cloudMssqlServerName": "m-2522****-003",
                          "cloudMssqlServerRole": {
                              "code": "S",
                              "codeName": "Slave"
                          },
                          "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": "59***",
                          "subnetNo": "140***",
                          "dataStorageSize": 107374182400,
                          "cpuCount": 2,
                          "memorySize": 4294967296,
                          "isPublicSubnet": true,
                          "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002",
                          "privateDomain": "mssql-****-r001.vpc-cdb.ntruss.com",
                          "createDate": "2024-07-01T15:48:28+0900",
                          "uptime": "2024-07-01T16:16:00+0900",
                          "dataStorageType": {
                              "code": "SSD",
                              "codeName": "SSD"
                          },
                          "usedDataStorageSize": 1073741824
                      }
                  ],
                  "accessControlGroupNoList": [
                      "186***"
                  ]
              }
          ],
          "requestId": "7bcf4935-****-****-****-00e1ece53ab0",
          "returnCode": "0",
          "returnMessage": "success"
      }
  }
  

• responseFormetType=xml (기본값) 일 때

  <?xml version="1.0" encoding="UTF-8"?>
  <getCloudMssqlInstanceDetailResponse>
      <requestId>7bcf4935-****-****-****-00e1ece53ab0</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>
              <cloudMssqlImageProductCode>SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15043553.EE.B100</cloudMssqlImageProductCode>
              <isHa>true</isHa>
              <isMultiZone>false</isMultiZone>
              <license>
                  <code>SPLA</code>
                  <codeName>Service Provider License Agreement</codeName>
              </license>
              <cloudMssqlPort>1433</cloudMssqlPort>
              <backupFileRetentionPeriod>1</backupFileRetentionPeriod>
              <backupTime>08:00</backupTime>
              <configGroupNo>0</configGroupNo>
              <configGroupName>mssql_2019_default</configGroupName>
              <engineVersion>MSSQL 15.0.4355.3 Enterprise Edition</engineVersion>
              <createDate>2024-07-01T14:29:18+0900</createDate>
              <dbCollation>Korean_Wansung_CI_AS</dbCollation>
              <cloudMssqlServerInstanceList>
                  <cloudMssqlServerInstance>
                      <cloudMssqlServerInstanceNo>2528****</cloudMssqlServerInstanceNo>
                      <cloudMssqlServerName>m-2522****-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>59***</vpcNo>
                      <subnetNo>140***</subnetNo>
                      <dataStorageSize>107374182400</dataStorageSize>
                      <cpuCount>2</cpuCount>
                      <memorySize>4294967296</memorySize>
                      <isPublicSubnet>true</isPublicSubnet>
                      <cloudMssqlProductCode>SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002</cloudMssqlProductCode>
                      <privateDomain>mssql-****.vpc-cdb.ntruss.com</privateDomain>
                      <createDate>2024-07-01T14:29:18+0900</createDate>
                      <uptime>2024-07-01T14:55:41+0900</uptime>
                      <dataStorageType>
                          <code>SSD</code>
                          <codeName>SSD</codeName>
                      </dataStorageType>
                      <usedDataStorageSize>1073741824</usedDataStorageSize>
                  </cloudMssqlServerInstance>
                  <cloudMssqlServerInstance>
                      <cloudMssqlServerInstanceNo>2528****</cloudMssqlServerInstanceNo>
                      <cloudMssqlServerName>m-2522****-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>59***</vpcNo>
                      <subnetNo>140***</subnetNo>
                      <dataStorageSize>107374182400</dataStorageSize>
                      <cpuCount>2</cpuCount>
                      <memorySize>4294967296</memorySize>
                      <isPublicSubnet>true</isPublicSubnet>
                      <cloudMssqlProductCode>SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002</cloudMssqlProductCode>
                      <privateDomain>mssql-****.vpc-cdb.ntruss.com</privateDomain>
                      <createDate>2024-07-01T14:29:18+0900</createDate>
                      <uptime>2024-07-01T15:08:09+0900</uptime>
                      <dataStorageType>
                          <code>SSD</code>
                          <codeName>SSD</codeName>
                      </dataStorageType>
                      <usedDataStorageSize>1073741824</usedDataStorageSize>
                  </cloudMssqlServerInstance>
                  <cloudMssqlServerInstance>
                      <cloudMssqlServerInstanceNo>2529****</cloudMssqlServerInstanceNo>
                      <cloudMssqlServerName>m-2522****-003</cloudMssqlServerName>
                      <cloudMssqlServerRole>
                          <code>S</code>
                          <codeName>Slave</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>59***</vpcNo>
                      <subnetNo>140***</subnetNo>
                      <dataStorageSize>107374182400</dataStorageSize>
                      <cpuCount>2</cpuCount>
                      <memorySize>4294967296</memorySize>
                      <isPublicSubnet>true</isPublicSubnet>
                      <cloudMssqlProductCode>SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002</cloudMssqlProductCode>
                      <privateDomain>mssql-****-r001.vpc-cdb.ntruss.com</privateDomain>
                      <createDate>2024-07-01T15:48:28+0900</createDate>
                      <uptime>2024-07-01T16:16:00+0900</uptime>
                      <dataStorageType>
                          <code>SSD</code>
                          <codeName>SSD</codeName>
                      </dataStorageType>
                      <usedDataStorageSize>1073741824</usedDataStorageSize>
                  </cloudMssqlServerInstance>
              </cloudMssqlServerInstanceList>
              <accessControlGroupNoList>
                  <accessControlGroupNo>186***</accessControlGroupNo>
              </accessControlGroupNoList>
          </cloudMssqlInstance>
      </cloudMssqlInstanceList>
  </getCloudMssqlInstanceDetailResponse>