--- title: "getCloudMysqlInstanceList" slug: "database-vmysql-getcloudmysqlinstancelist" updated: 2026-09-17T09:57:47Z published: 2026-09-17T09:57:47Z 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 | ### リクエストヘッダ Cloud DB for MySQL (VPC) APIで共通して使用されるヘッダの詳細は、[Cloud DB for MySQL (VPC)のリクエストヘッダ](/docs/ja/database-vmysql#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエストクエリパラメータ リクエストクエリパラメータの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `regionCode` | String | Optional | リージョンコード - 照会対象の Cloud DB for MySQLインスタンスのリージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 - `getRegionList`照会結果の最初のリージョン(デフォルト) | | `zoneCode` | String | Optional | ゾーンコードでフィルタリング - [getZoneList](/docs/ja/compute-vserver-server-common-getzonelist)を参照 | | `vpcNo` | String | Optional | VPC番号でフィルタリング - [getCloudMysqlTargetVpcList](/docs/ja/database-vmysql-getcloudmysqltargetvpclist)を参照 | | `subnetNo` | String | Optional | Subnet番号でフィルタリング - [getCloudMysqlTargetSubnetList](/docs/ja/database-vmysql-getcloudmysqltargetsubnetlist)を参照 | | `cloudMysqlServiceName` | String | Optional | Cloud DB for MySQLサービス名でフィルタリング - [getCloudMysqlInstanceList](/docs/ja/database-vmysql-getcloudmysqlinstancelist)を参照 | | `cloudMysqlInstanceNoList.N` | List[String] | Optional | Cloud DB for MySQLインスタンス番号リスト - Cloud DB for MySQLインスタンス番号でフィルタリング - [getCloudMysqlInstanceList](/docs/ja/database-vmysql-getcloudmysqlinstancelist)を参照 - <例> ` cloudMysqlInstanceNoList.1=1234&cloudMysqlInstanceNoList.2=2345` | | `cloudMysqlServerName` | String | Optional | Cloud DB for MySQLサーバ名でフィルタリング - [getCloudMysqlInstanceList](/docs/ja/database-vmysql-getcloudmysqlinstancelist)を参照 | | `cloudMysqlServerInstanceNoList.N` | List[String] | Optional | Cloud DB for MySQLサーバインスタンス番号リスト - Cloud DB for MySQLサーバインスタンス番号でフィルタリング - [getCloudMysqlInstanceList](/docs/ja/database-vmysql-getcloudmysqlinstancelist)を参照 - <例> `cloudMysqlServerInstanceNoList.1=1234&cloudMysqlServerInstanceNoList.2=2345` | | `generationCode` | String | Optional | サーバの世代コードでフィルタリング - `G2` \| `G3` - [getCloudMysqlInstanceList](/docs/ja/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/ja/common-vapidatatype-cloudmysqlinstancelist)をご参照ください。 ### レスポンスステータスコード Cloud DB for MySQL (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、[Cloud DB for MySQL (VPC)のレスポンスステータスコード](/docs/ja/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 ```