--- title: "getCloudMysqlInstanceList" slug: "database-vmysql-getcloudmysqlinstancelist" tags: ["Cloud DB for MySQL"] updated: 2026-09-17T09:16:20Z published: 2026-09-17T09:16:20Z canonical: "api.ncloud-docs.com/database-vmysql-getcloudmysqlinstancelist" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # getCloudMysqlInstanceList VPC 환경에서 이용 가능합니다. Cloud DB for MySQL 인스턴스 목록을 조회합니다. ## 요청 요청 형식을 설명합니다. 요청 형식은 다음과 같습니다. | 메서드 | URI | | --- | --- | | GET \| POST | /vmysql/v2/getCloudMysqlInstanceList | 참고 가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다. ### 요청 헤더 Cloud DB for MySQL (VPC) API에서 공통으로 사용하는 헤더에 대한 정보는 [Cloud DB for MySQL (VPC) 요청 헤더](/docs/database-vmysql#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오. ### 요청 쿼리 파라미터 요청 쿼리 파라미터에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `regionCode` | String | Optional | 리전 코드 - 조회할 Cloud DB for MySQL 인스턴스의 리전 코드 - [getRegionList](/docs/compute-vserver-server-common-getregionlist) 참조 - `getRegionList` 조회 결과의 첫 번째 리전(기본값) | | `zoneCode` | String | Optional | 존 코드로 필터링 - [getZoneList](/docs/compute-vserver-server-common-getzonelist) 참조 | | `vpcNo` | String | Optional | VPC 번호로 필터링 - [getCloudMysqlTargetVpcList](/docs/database-vmysql-getcloudmysqltargetvpclist) 참조 | | `subnetNo` | String | Optional | Subnet 번호로 필터링 - [getCloudMysqlTargetSubnetList](/docs/database-vmysql-getcloudmysqltargetsubnetlist) 참조 | | `cloudMysqlServiceName` | String | Optional | Cloud DB for MySQL 서비스 이름으로 필터링 - [getCloudMysqlInstanceList](/docs/database-vmysql-getcloudmysqlinstancelist) 참조 | | `cloudMysqlInstanceNoList.N` | List[String] | Optional | Cloud DB for MySQL 인스턴스 번호 목록 - Cloud DB for MySQL 인스턴스 번호로 필터링 - [getCloudMysqlInstanceList](/docs/database-vmysql-getcloudmysqlinstancelist) 참조 - <예시> ` cloudMysqlInstanceNoList.1=1234&cloudMysqlInstanceNoList.2=2345` | | `cloudMysqlServerName` | String | Optional | Cloud DB for MySQL 서버 이름으로 필터링 - [getCloudMysqlInstanceList](/docs/database-vmysql-getcloudmysqlinstancelist) 참조 | | `cloudMysqlServerInstanceNoList.N` | List[String] | Optional | Cloud DB for MySQL 서버 인스턴스 번호 목록 - Cloud DB for MySQL 서버 인스턴스 번호로 필터링 - [getCloudMysqlInstanceList](/docs/database-vmysql-getcloudmysqlinstancelist) 참조 - <예시> `cloudMysqlServerInstanceNoList.1=1234&cloudMysqlServerInstanceNoList.2=2345` | | `generationCode` | String | Optional | 서버 세대 코드로 필터링 - `G2` \| `G3` - [getCloudMysqlInstanceList](/docs/database-vmysql-getcloudmysqlinstancelist) 참조 | | `pageNo` | Integer | Optional | 페이징 처리된 결과의 페이지 번호 - `pageNo`, `pageSize`를 이용하여 페이징 처리 - 0 (최소) | | `pageSize` | Integer | Conditional | 한 페이지에 보여줄 결과 개수 - `pageNo`, `pageSize`를 이용하여 페이징 처리 - `pageNo` 입력 시 필수 입력 - 1 (최소) | | `responseFormatType` | String | Optional | 응답 결과의 형식 - `xml` (기본값) \| `json` | ### 요청 예시 요청 예시는 다음과 같습니다. ``` curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmysql/v2/getCloudMysqlInstanceList ?regionCode=KR &zoneCode=KR-1 &vpcNo=***83 &subnetNo=**91 &cloudMysqlServiceName=test-**** &cloudMysqlInstanceNoList.1=****890 &cloudMysqlServerName=test-**** &cloudMysqlServerInstanceNoList.1=****891 &generationCode=G2 &pageNo=0 &pageSize=10' \ --header 'x-ncp-apigw-timestamp: {Timestamp}' \ --header 'x-ncp-iam-access-key: {Access Key}' \ --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' ``` ## 응답 응답 형식을 설명합니다. ### 응답 바디 응답 바디는 [CloudMysqlInstanceList](/docs/common-vapidatatype-cloudmysqlinstancelist)를 참조해 주십시오. ### 응답 상태 코드 Cloud DB for MySQL (VPC) API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Cloud DB for MySQL (VPC) 응답 상태 코드](/docs/database-vmysql#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오. ### 응답 예시 응답 예시는 다음과 같습니다. - `responseFormatType=json` 일 때 ``` { "getCloudMysqlInstanceListResponse": { "totalRows": 1, "cloudMysqlInstanceList": [ { "cloudMysqlInstanceNo": "****890", "cloudMysqlServiceName": "test-****", "cloudMysqlInstanceStatusName": "running", "cloudMysqlInstanceStatus": { "code": "CREAT", "codeName": "CLOUD DATABASE(VPC) Created State" }, "cloudMysqlInstanceOperation": { "code": "NULL", "codeName": "CLOUD DATABASE(VPC) Null OP" }, "isHa": true, "isMultiZone": true, "generationCode": "G2", "cloudMysqlServerInstanceList": [ { "cloudMysqlServerInstanceNo": "****891", "cloudMysqlServerName": "test-****-001-e04", "cloudMysqlServerRole": { "code": "M", "codeName": "Master" }, "cloudMysqlServerInstanceStatusName": "running", "cloudMysqlServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMysqlServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "regionCode": "KR", "zoneCode": "KR-1", "vpcNo": "****83", "subnetNo": "****91", "privateIp": "***.***.***.***", "dataStorageSize": 10737418240, "cpuCount": 2, "memorySize": 8589934592 }, { "cloudMysqlServerInstanceNo": "****897", "cloudMysqlServerName": "test-****-002-e05", "cloudMysqlServerRole": { "code": "H", "codeName": "Standby Master" }, "cloudMysqlServerInstanceStatusName": "running", "cloudMysqlServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMysqlServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "regionCode": "KR", "zoneCode": "KR-2", "vpcNo": "****83", "subnetNo": "****91", "privateIp": "***.***.***.***", "dataStorageSize": 10737418240, "cpuCount": 2, "memorySize": 8589934592 } ] } ], "requestId": "8f728514-****-****-****-e56324aeb031", "returnCode": "0", "returnMessage": "success" } } ``` - `responseFormatType=xml` (기본값) 일 때 ``` 8f728514-****-****-****-e56324aeb031 0 success 1 ****890 test-**** running CREAT CLOUD DATABASE(VPC) Created State NULL CLOUD DATABASE(VPC) Null OP true true G2 ****891 test-****-001-e04 M Master running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP KR KR-1 ****83 ****91 ***.***.***.*** 10737418240 2 8589934592 ****897 test-****-002-4y1w H Standby Master running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP KR KR-2 ****83 ****93 ***.***.***.*** 10737418240 2 8589934592 ```