getCloudPostgresqlInstanceList
- Print
- PDF
getCloudPostgresqlInstanceList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Available in VPC
Views Cloud DB for PostgreSQL instance list.
Requests
Request Parameters
Parameter | Type | Requirement Status | Description | Restrictions |
---|---|---|---|---|
regionCode | String | N | Region code - regionCode can be obtained via the getRegionList action - default: Selects the first region of the getRegionList query results | - |
zoneCode | String | N | Zone code - zoneCode can be obtained via the getZoneList action | - |
vpcNo | String | N | VPC number - vpcNo can be obtained via the getCloudPostgresqlTargetVpcList action | - |
subnetNo | String | N | Subnet number - SubnetNo can be obtained via the getCloudPostgresqlTargetSubnetList action | - |
cloudPostgresqlServiceName | String | N | Cloud DB for PostgreSQL service name - Can be searched through filtering by Cloud DB for PostgreSQL service name - cloudPostgresqlServiceName can be obtained via the getCloudPostgresqlInstanceList action | - |
cloudPostgresqlInstanceNoList | List<String> | N | Cloud DB for PostgreSQL instance number list - Can be searched through filtering by Cloud DB for PostgreSQL instance number - cloudPostgresqlInstanceNoList can be obtained via the getCloudPostgresqlInstanceList action - ex) cloudPostgresqlInstanceNoList.1=1234&cloudPostgresqlInstanceNoList.2=2345 | - |
cloudPostgresqlServerName | String | N | Cloud DB for PostgreSQL server name - Can be searched through filtering by Cloud DB for PostgreSQL sever name - cloudPostgresqlServerName can be obtained via the getCloudPostgresqlInstanceList action | - |
cloudPostgresqlServerInstanceNoList | List<String> | N | Cloud DB for PostgreSQL server instance number list - Can be searched through filtering by Cloud DB for PostgreSQL server instance number - cloudPostgresqlServerInstanceNoList can be obtained via the getCloudPostgresqlInstanceList action - ex) cloudPostgresqlServerInstanceNoList.1=1234&cloudPostgresqlServerInstanceNoList.2=2345 | - |
pageNo | Integer | N | Page number of paged results - The results can be paged using pageNo and pageSize | - Min: 0 |
pageSize | Integer | N | Size of each page to be shown during paging - The results can be paged using pageNo and pageSize - Enter it every time you enter pageNo | - Min: 1 |
responseFormatType | String | N | Format type of the response result - options: xml | json - default: xml | - |
Responses
Response bodies
For response bodies, refer to CloudPostgresqlInstanceList.
Examples
Request Examples
The following is an example of a request body.
GET {API_URL}/getCloudPostgresqlInstanceList
?regionCode=KR
Response examples
The following are examples of responses.
If the response shows that format type (responseFormatType) is json
{
"getCloudPostgresqlInstanceListResponse": {
"requestId": "3c690190-a654-499e-8e00-7916d62ae416",
"returnCode": 0,
"returnMessage": "success",
"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,
"cloudPostgresqlServerInstanceList": [
{
"cloudPostgresqlServerInstanceNo": "****926",
"cloudPostgresqlServerName": "test-****-001-gcb",
"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": 4294967296
},
{
"cloudPostgresqlServerInstanceNo": "****932",
"cloudPostgresqlServerName": "test-****-002-gcc",
"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": 4294967296
}
]
}
]
}
}
If the response shows that format type (responseFormatType) is xml
<getCloudPostgresqlInstanceListResponse>
<requestId>3c690190-a654-499e-8e00-7916d62ae416</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<cloudPostgresqlInstanceList>
<cloudPostgresqlInstance>
<cloudPostgresqlInstanceNo>****925</cloudPostgresqlInstanceNo>
<cloudPostgresqlServiceName>test-****</cloudPostgresqlServiceName>
<cloudPostgresqlInstanceStatusName>running</cloudPostgresqlInstanceStatusName>
<cloudPostgresqlInstanceStatus>
<code>CREAT</code>
<codeName>CLOUD DATABASE(VPC) Created State</codeName>
</cloudPostgresqlInstanceStatus>
<cloudPostgresqlInstanceOperation>
<code>NULL</code>
<codeName>CLOUD DATABASE(VPC) Null OP</codeName>
</cloudPostgresqlInstanceOperation>
<isHa>true</isHa>
<isMultiZone>true</isMultiZone>
<cloudPostgresqlServerInstanceList>
<cloudPostgresqlServerInstance>
<cloudPostgresqlServerInstanceNo>****926</cloudPostgresqlServerInstanceNo>
<cloudPostgresqlServerName>test-****-001-gcb</cloudPostgresqlServerName>
<cloudPostgresqlServerRole>
<code>M</code>
<codeName>Primary</codeName>
</cloudPostgresqlServerRole>
<cloudPostgresqlServerInstanceStatusName>running</cloudPostgresqlServerInstanceStatusName>
<cloudPostgresqlServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudPostgresqlServerInstanceStatus>
<cloudPostgresqlServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
</cloudPostgresqlServerInstanceOperation>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****87</vpcNo>
<subnetNo>****49</subnetNo>
<dataStorageSize>10737418240</dataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>4294967296</memorySize>
</cloudPostgresqlServerInstance>
<cloudPostgresqlServerInstance>
<cloudPostgresqlServerInstanceNo>****932</cloudPostgresqlServerInstanceNo>
<cloudPostgresqlServerName>test-****-002-gcc</cloudPostgresqlServerName>
<cloudPostgresqlServerRole>
<code>H</code>
<codeName>Secondary</codeName>
</cloudPostgresqlServerRole>
<cloudPostgresqlServerInstanceStatusName>running</cloudPostgresqlServerInstanceStatusName>
<cloudPostgresqlServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudPostgresqlServerInstanceStatus>
<cloudPostgresqlServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
</cloudPostgresqlServerInstanceOperation>
<regionCode>KR</regionCode>
<zoneCode>KR-2</zoneCode>
<vpcNo>****87</vpcNo>
<subnetNo>****51</subnetNo>
<dataStorageSize>10737418240</dataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>4294967296</memorySize>
</cloudPostgresqlServerInstance>
</cloudPostgresqlServerInstanceList>
</cloudPostgresqlInstance>
</cloudPostgresqlInstanceList>
</getCloudPostgresqlInstanceListResponse>
Was this article helpful?