getCloudMssqlInstanceList

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

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

Cloud DB for MSSQL 인스턴스 목록을 조회합니다.

요청

요청 파라미터

파라미터	타입	필수 여부	설명	제약사항
cloudMssqlInstanceNoList	List<String>	N	Cloud DB for MSSQL 인스턴스 번호 목록 - Cloud DB for MSSQL 인스턴스 번호로 필터링하여 검색 가능 - cloudMssqlInstanceNoList는 getCloudMssqlInstanceList 액션을 통해서 획득 - ex) cloudMssqlInstanceNoList.1=1234&cloudMssqlInstanceNoList.2=2345	-
cloudMssqlServiceName	String	N	Cloud DB for MSSQL 서비스 이름 - Cloud DB for MSSQL 서비스 이름으로 필터링하여 검색 가능 - cloudMssqlServiceName은 getCloudMssqlInstanceList 액션을 통해서 획득	-
cloudMssqlServerInstanceNoList	List<String>	N	Cloud DB for MSSQL 서버 인스턴스 번호 목록 - Cloud DB for MSSQL 서버 인스턴스 번호로 필터링하여 검색 가능 - cloudMssqlServerInstanceNoList getCloudMssqlInstanceList 액션을 통해서 획득 - ex) cloudMssqlServerInstanceNoList.1=1234&cloudMssqlServerInstanceNoList.2=2345	-
cloudMssqlServerName	String	N	Cloud DB for MSSQL 서버 이름 - Cloud DB for MSSQL 서버 이름으로 필터링하여 검색 가능 - cloudMssqlServerName은 getCloudMssqlInstanceList 액션을 통해서 획득	-
regionCode	String	N	리전 코드 - regionCode는 getRegionList 액션을 통해서 획득 - default: getRegionList 조회 결과의 첫 번째 리전을 선택	-
zoneCode	String	N	Zone 코드 - zoneCode는 getZoneList 액션을 통해서 획득	-
vpcNo	String	N	VPC 번호 - vpcNo는 getCloudMssqlTargetVpcList 액션을 통해서 획득	-
subnetNo	String	N	Subnet 번호 - SubnetNo는 getCloudMssqlTargetSubnetList 액션을 통해서 획득	-
pageNo	Integer	N	페이징 된 결과의 페이지 번호 - 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능	- Min: 0
pageSize	Integer	N	페이징 시 보여줄 각 페이지 사이즈 - 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능 - pageNo 입력시 반드시 입력	- Min: 1
responseFormatType	String	N	응답 결과의 포맷 타입 - options: xml \| json - default: xml	-

응답

응답 바디

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

예시

요청 예시

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

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

응답 예시

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

응답 결과 포맷 타입(responseFormatType)이 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"
  }
}

응답 결과 포맷 타입(responseFormatType)이 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>

이 문서가 도움이 되었습니까?

What's Next

getCloudMssqlProductList

요청
응답
예시

태그

Cloud DB for MSSQL