--- title: "getCloudPostgresqlInstanceList" slug: "database-vpostgresql-getcloudpostgresqlinstancelist" tags: ["Cloud DB for PostgreSQL"] updated: 2026-09-17T09:57:51Z published: 2026-09-17T09:57:51Z canonical: "api.ncloud-docs.com/database-vpostgresql-getcloudpostgresqlinstancelist" --- > ## 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. # getCloudPostgresqlInstanceList VPC環境で利用できます。 Cloud DB for PostgreSQLインスタンスリストを照会します。 ## リクエスト リクエスト形式を説明します。リクエスト形式は次の通りです。 | メソッド | URI | | --- | --- | | GET \| POST | /vpostgresql/v2/getCloudPostgresqlInstanceList | 参考 ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。 ### リクエストヘッダ Cloud DB for PostgreSQL (VPC) APIで共通して使用されるヘッダの詳細は、[Cloud DB for PostgreSQL (VPC)のリクエストヘッダ](/docs/ja/database-vpostgresql#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエストクエリパラメータ リクエストクエリパラメータの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `regionCode` | String | Optional | リージョンコード - 照会対象の Cloud DB for PostgreSQLインスタンスのリージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を通じて確認 - `getRegionList`照会結果の最初のリージョン(デフォルト) | | `zoneCode` | String | Optional | ゾーンコードでフィルタリング - [getZoneList](/docs/ja/compute-vserver-server-common-getzonelist)を通じて確認 | | `vpcNo` | String | Optional | VPC番号でフィルタリング - [getCloudPostgresqlTargetVpcList](/docs/ja/database-vpostgresql-getcloudpostgresqltargetvpclist)を通じて確認 | | `subnetNo` | String | Optional | Subnet番号でフィルタリング - [getCloudPostgresqlTargetSubnetList](/docs/ja/database-vpostgresql-getcloudpostgresqltargetsubnetlist)を通じて確認 | | `cloudPostgresqlServiceName` | String | Optional | Cloud DB for PostgreSQLサービス名でフィルタリング - [getCloudPostgresqlInstanceList](/docs/ja/database-vpostgresql-getcloudpostgresqlinstancelist)を通じて確認 | | `cloudPostgresqlInstanceNoList.N` | List[String] | Optional | Cloud DB for PostgreSQLインスタンス番号リスト - Cloud DB for PostgreSQLインスタンス番号でフィルタリング - [getCloudPostgresqlInstanceList](/docs/ja/database-vpostgresql-getcloudpostgresqlinstancelist)を通じて確認 - <例> ` cloudPostgresqlInstanceNoList.1=1234&cloudPostgresqlInstanceNoList.2=2345` | | `cloudPostgresqlServerName` | String | Optional | Cloud DB for PostgreSQLサーバ名でフィルタリング - [getCloudPostgresqlInstanceList](/docs/ja/database-vpostgresql-getcloudpostgresqlinstancelist)を通じて確認 | | `cloudPostgresqlServerInstanceNoList.N` | List[String] | Optional | Cloud DB for PostgreSQLサーバインスタンス番号リスト - Cloud DB for PostgreSQLサーバインスタンス番号でフィルタリング - [getCloudPostgresqlInstanceList](/docs/ja/database-vpostgresql-getcloudpostgresqlinstancelist)を通じて確認 - <例> `cloudPostgresqlServerInstanceNoList.1=1234&cloudPostgresqlServerInstanceNoList.2=2345` | | `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/vpostgresql/v2/getCloudPostgresqlInstanceList ?regionCode=KR' \ --header 'x-ncp-apigw-timestamp: {Timestamp}' \ --header 'x-ncp-iam-access-key: {Access Key}' \ --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' ``` ## レスポンス レスポンス形式を説明します。 ### レスポンスボディ レスポンスボディの詳細は、[CloudPostgresqlInstanceList](/docs/ja/common-vapidatatype-cloudpostgresqlinstancelist)をご参照ください。 ### レスポンスステータスコード Cloud DB for PostgreSQL (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、[Cloud DB for PostgreSQL (VPC)のレスポンスステータスコード](/docs/ja/database-vpostgresql#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 ### レスポンス例 レスポンスのサンプルコードは次の通りです。 - `responseFormatType=json`の場合 ``` { "getCloudPostgresqlInstanceListResponse": { "totalRows": 1, "cloudPostgresqlInstanceList": [ { "cloudPostgresqlInstanceNo": "****925", "cloudPostgresqlServiceName": "test-****", "cloudPostgresqlInstanceStatusName": "running", "cloudPostgresqlInstanceStatus": { "code": "CREAT", "codeName": "CLOUD DATABASE(VPC) Created State" }, "cloudPostgresqlInstanceOperation": { "code": "NULL", "codeName": "CLOUD DATABASE(VPC) Null OP" }, "isHa": true, "isMultiZone": true, "cloudPostgresqlConfigList": [ "sample_config=sample_value" ], "cloudPostgresqlServerInstanceList": [ { "cloudPostgresqlServerInstanceNo": "****926", "cloudPostgresqlServerName": "test-****-001-523a", "cloudPostgresqlServerRole": { "code": "M", "codeName": "Primary" }, "cloudPostgresqlServerInstanceStatusName": "running", "cloudPostgresqlServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudPostgresqlServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "regionCode": "KR", "zoneCode": "KR-1", "vpcNo": "****87", "subnetNo": "****49", "dataStorageSize": 10737418240, "cpuCount": 2, "memorySize": 8589934592 }, { "cloudPostgresqlServerInstanceNo": "****932", "cloudPostgresqlServerName": "test-****-002-523b", "cloudPostgresqlServerRole": { "code": "H", "codeName": "Secondary" }, "cloudPostgresqlServerInstanceStatusName": "running", "cloudPostgresqlServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudPostgresqlServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "regionCode": "KR", "zoneCode": "KR-2", "vpcNo": "****87", "subnetNo": "****51", "dataStorageSize": 10737418240, "cpuCount": 2, "memorySize": 8589934592 } ] } ], "requestId": "5092443c-****-****-****-7e916678d405", "returnCode": "0", "returnMessage": "success" } } ``` - `responseFormatType=xml`(デフォルト)の場合 ``` 5092443c-****-****-****-7e916678d405 0 success 1 ****925 test-**** running CREAT CLOUD DATABASE(VPC) Created State NULL CLOUD DATABASE(VPC) Null OP true true sample_config=sample_value ****926 test-****-001-523a M Primary running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP KR KR-1 ****87 ****49 10737418240 2 8589934592 ****932 test-****-002-523b H Secondary running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP KR KR-2 ****87 ****51 10737418240 2 8589934592 ```